Returns a new tile. The tile id is assigned automatically.
Binds the video element to the tile if it exists for the provided tileId. This should also be called any time the layout of the video element changes, for example, when changing its dimensions.
This can be used to capture the image data for a given tile.
Returns the remote video tile
Get all video tiles.
Returns the current local video tile if it exists
Looks up a video tile from its tile id
Gets a video tile area in physical pixels
Returns the video tile associated with the given attendeeId
The attendeeId to retrieve the video tile
Returns whether the local video tile has been started.
Returns whether an attendeeId is associated with a video tile
Returns whether at least one video tile has a bound media stream.
Pauses the video tile if it exists and sends the updated video tile state to the meeting session's AudioVideoObserver’s videoTileDidUpdate callback. This API is intended to be called on the remote videos. If called on a local video tile, then the tile will no longer be updated, but the local video source will continue to be sent into the meeting.
Removes all the tiles.
Stops and removes a local video tile, if it exists. This calls removeVideoTile internally with the current local tileId.
Disconnects the video source from the video element bounded with the video tile, removes the tile by the tileId and the AudioVideoObserver’s videoTileWasRemoved callback is called with the removed tile id.
Removes any tiles that have the given attendee id and returns the tile ids of the tiles removed
Broadcasts a tile state update to the session observers.
Starts sharing the local video tile by creating a new video tile if one does not already exist. Binds the created local video tile to the local video stream and then returns its tile id.
Stops a local video tile, if it exists. The bounded video stream associated with the local video tile is released and set to null.
Unbinds the video element from the tile if it exists for the provided tileId.
The video tile's bounded video element and that element's width and height are set to null.
By default, the bounded video element's srcObject is also set to null.
Pass false for cleanUpVideoElement, if you do not intend to set the bounded video element's srcObject to null.
This does not remove the provided tileId mapping from the tile map in the DefaultVideoTileController.
To remove the mapping and destroy the tile for this tileId, you can use removeVideoTile.
Unpauses the video tile if it exists and sends the updated video tile state to the meeting session's AudioVideoObserver’s videoTileDidUpdate callback. This API is intended to be called on the remote videos and has no effect on the local video. When called on a remote video tileId, the remote video source will start getting the updates if paused earlier.
Generated using TypeDoc
VideoTileController allows one to manipulate how the underlying media streams are assigned to video elements. The caller is responsible for laying out video elements as desired and binding tile ids received from the observer in the [[videoTileUpdated]] callbacks.