Class DefaultVideoTileController

[[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.

Implements

Constructors

Properties

keepLastFrameWhenPaused: boolean = false

Methods

  • 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.

    Parameters

    • tileId: number

    Returns void

  • 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.

    Parameters

    • tileId: number
    • cleanUpVideoElement: boolean = true

      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]].

    Returns void

  • 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.

    Parameters

    • tileId: number

    Returns void