Developer Documentation

Add Media To Room

Add Media To Room

Adds a previously generated media object to the room. Once this is done, the users microphone input will be sent to other users so they can hear the audio.

Important

The user must have joined the room before adding media. Use the Join Room node to join the room. Also, you cannot use the same media stream for multiple rooms at once, but you have to create a new one for each room.

Inputs

NameTypeDescription
Execexec
RoomRoomThe room to which the media will be added.
MediaMediaThe media which should be added. Construct Local Media can be used to create a media object.
On ErrordelegateDelegate to handle errors while adding a media to a room.
On SuccessdelegateCalled when the media has been successfully added to the room. See On Media Added Success event for details.

Outputs

NameTypeDescription
Execexec
On ResponseexecCalled when the gateway has returned its response. Use the success output to understand if anything went fine.
Successbooleantrue if the media has been successfully joined.