Digital Samba Embedded
  • Introduction
  • SDK
    • DigitalSambaEmbedded class
    • Methods
      • addCustomTile()
      • removeCustomTile()
      • addFrameEventListener()
      • addImageToWhiteboard()
      • addTileAction()
      • addUICallback()
      • allowBroadcast()
      • allowScreenshare()
      • changeBrandingOptions()
      • changeLayoutMode()
      • changeRole()
      • changeToolbarPosition()
      • closeLibraryFile()
      • closeWhiteboard()
      • createWhiteboard()
      • configureCaptions()
      • configureVirtualBackground()
      • disableAudio()
      • disableVideo()
      • disableVirtualBackground()
      • disallowBroadcast()
      • disallowScreenshare()
      • enableAudio()
      • enableVideo()
      • enableVirtualBackground()
      • endSession()
      • featureEnabled()
      • hideCaptions()
      • hideToolbar()
      • leaveSession()
      • listUsers()
      • load()
      • lowerHand()
      • muteFrame()
      • maximizeLocalTile()
      • maximizeUser()
      • minimizeLocalTile()
      • minimizeContent()
      • minimizeUser()
      • off()
      • on()
      • once()
      • openLibraryFile()
      • openWhiteboard()
      • pinUser()
      • raiseHand()
      • removeFrameEventListener()
      • removeTileAction()
      • removeUICallback()
      • removeUser()
      • requestMute()
      • requestToggleAudio()
      • requestUnmute()
      • showCaptions()
      • showToolbar()
      • startRecording()
      • startScreenshare()
      • stopRecording()
      • stopScreenshare()
      • toggleAudio()
      • toggleCaptions()
      • toggleMuteFrame()
      • toggleToolbar()
      • toggleVideo()
      • toggleWhiteboard()
      • toggleLibraryFile()
      • unmuteFrame()
      • unpinUser()
    • Events
      • activeSpeakerChanged
      • appError
      • appLanguageChanged
      • audioDisabled
      • audioEnabled
      • captionsDisabled
      • captionsEnabled
      • captionsFontSizeChanged
      • captionsSpokenLanguageChanged
      • chatMessageReceived
      • featureSetUpdated
      • frameLoaded
      • handRaised
      • handLowered
      • layoutModeChanged
      • mediaDeviceChanged
      • permissionsChanged
      • recordingFailed
      • recordingStarted
      • recordingStopped
      • roleChanged
      • roomStateUpdated
      • screenshareStarted
      • screenshareStopped
      • sessionEnded
      • speakerStoppedTalking
      • userJoined
      • userLeft
      • usersUpdated
      • videoDisabled
      • videoEnabled
      • virtualBackgroundChanged
      • virtualBackgroundDisabled
    • Properties
      • features
      • localUser
      • permissionManager
      • roomState
  • REST API
    • Rate limiting
    • Pagination
    • Default room settings
      • List
      • Edit
    • Rooms
      • Create
      • Edit
      • List
      • Delete
        • All resources
        • Concrete resource
      • Files
      • Chat
        • List
        • Export
      • Questions & Answers
        • List
        • Export
      • Transcription
        • List
        • Export
        • Start
        • Stop
    • Sessions
      • List
      • End
      • Delete resources
        • All resources
        • Concrete resource
      • Transcripts
      • Summary (AI)
    • Participants
      • List
    • Roles and permissions
      • Permissions
      • Create
      • Edit
      • List
      • Delete
    • Live usage
      • Rooms
      • Participants
    • Statistics
      • Current period
      • Team
      • Room
    • Tokens
      • Properties
      • Create
    • Recordings
      • List
      • Download
      • Start
      • Stop
      • Delete
      • Archive
      • Unarchive
    • Polls
      • Create
      • Edit
      • List
      • Delete
      • Export
      • Results
    • Content Library
      • Create
      • Edit
      • List
      • Delete
      • Folders
        • Create
        • Edit
        • List
        • Delete
      • Files
        • Upload
        • Webapps
        • Whiteboards
        • Edit
        • List
        • Delete
    • Telephony
      • Participant Join
      • Participant Leave
    • Webhooks
      • Payload structure
      • Create
      • Edit
      • List
      • Delete
    • Scribe / Postman docs
  • Dashboard docs
  • LTI docs
Powered by GitBook
On this page
  1. REST API
  2. Rooms

Files

PreviousConcrete resourceNextChat

Last updated 1 year ago

To link files to a room you can use the "files" property when or a room.

A file can be a single image or a collection (array) of images if it is a presentation.

Users with present_files permission can later open these files inside the room from the Files panel and displayed them to all other users. Navigation between presentation's slides is available and arrows can also be used to go to next or previous slide.

Request (when POST to /api/v1/rooms or PATCH to /api/v1/rooms:id)

{
 ...Other room props here...
 
 "files": [
    {
        "name": "starship.png",
        "url": "https://cdn.britannica.com/51/238251-050-EF7A9C22/SpaceX-Starship-Super-Heavy-Rocket-Boca-Chica-Texas-February-2022.jpg",
        "thumbnail_url": "https://cdn.rebrickable.com/media/thumbs/mocs/moc-66505.jpg/1000x800.jpg"
    },
    {
        "name": "Plan for 2024.ppt",
        "pages": [
            {
               "url": "https://www.lifewire.com/thmb/sXrReuuQUimBg2RQSU7f2bNBXIU=/1500x0/filters:no_upscale():max_bytes(150000):strip_icc()/create-pictures-from-powerpoint-slides-R1-5c260a9c46e0fb0001fe92b4.jpg",
               "thumbnail_url": "https://www.lifewire.com/thmb/sXrReuuQUimBg2RQSU7f2bNBXIU=/1500x0/filters:no_upscale():max_bytes(150000):strip_icc()/create-pictures-from-powerpoint-slides-R1-5c260a9c46e0fb0001fe92b4.jpg"
            },
            {
               "url": "https://www.aiseesoft.com/images/how-to/save-powerpoint-slides-as-jpeg/save-powerpoint-slides-as-jpeg.jpg",
               "thumbnail_url": "https://www.aiseesoft.com/images/how-to/save-powerpoint-slides-as-jpeg/save-powerpoint-slides-as-jpeg.jpg"
            }
        ]
    }
  ]
  
}

Response (200 OK)

{
  ...Other room props here...
  
 "files": [
    {
        "id": "25e6b948-cc6a-47cb-85c4-52fc4549b09f",
        "name": "Plan for 2024.ppt",
        "pages": [
            {
                "url": "https://www.lifewire.com/thmb/sXrReuuQUimBg2RQSU7f2bNBXIU=/1500x0/filters:no_upscale():max_bytes(150000):strip_icc()/create-pictures-from-powerpoint-slides-R1-5c260a9c46e0fb0001fe92b4.jpg",
                "thumbnail_url": "https://www.lifewire.com/thmb/sXrReuuQUimBg2RQSU7f2bNBXIU=/1500x0/filters:no_upscale():max_bytes(150000):strip_icc()/create-pictures-from-powerpoint-slides-R1-5c260a9c46e0fb0001fe92b4.jpg"
            },
            {
                "url": "https://www.aiseesoft.com/images/how-to/save-powerpoint-slides-as-jpeg/save-powerpoint-slides-as-jpeg.jpg",
                "thumbnail_url": "https://www.aiseesoft.com/images/how-to/save-powerpoint-slides-as-jpeg/save-powerpoint-slides-as-jpeg.jpg"
            }
        ]
    },
    {
        "id": "b52a8218-1cd9-4ade-9d42-e4472af241d6",
        "name": "starship.png",
        "url": "https://cdn.britannica.com/51/238251-050-EF7A9C22/SpaceX-Starship-Super-Heavy-Rocket-Boca-Chica-Texas-February-2022.jpg",
        "thumbnail_url": "https://cdn.rebrickable.com/media/thumbs/mocs/moc-66505.jpg/1000x800.jpg"
    }
  ]
}
creating
editing