Indication of whether the tile has active video stream. This value may be somewhat arbitrary in how it is calculated,
it is recommended to use the more specific values (e.g. paused
, boundVideoElement
, and boundVideoStream
) to
determine activity as appropriate for your application.
The attendee id associated with the VideoTile.
The user id associated with the VideoTile.
The HTMLVideoElement bound with the VideoTile.
The video stream bound with the VideoTile.
The device pixel ratio of the current display monitor.
The unique identifier published by server to associate with remote video source. It is defined in [[SignalingProtocol.proto]]. Developers should avoid using this field directly.
Indication of whether the tile has content-sharing video.
Indication of whether tile is associated with local video.
Indication of whether the tile associated with the local attendee has started to play.
The nameplate for the VideoTile. SDK users should use boundExternalUserId for user id instead of this field.
Indication of whether the tile has paused video stream.
Indication of whether the remote video is paused at publishing attendee. This field is not supported.
The unique identifier published by server to associate with bound video stream. It is defined in [[SignalingProtocol.proto]]. Developers should avoid using this field directly.
The unique identifier for the VideoTile managed by VideoTileController. Each attendee can have at most one tileId.
The CSS height in pixel of the HTMLVideoElement upon binding with the VideoTile.
The CSS width in pixel of the HTMLVideoElement upon binding with the VideoTile.
The physical height in pixel of the HTMLVideoElement upon binding with the VideoTile.
The physical width in pixel of the HTMLVideoElement upon binding with the VideoTile.
The intrinsic height of the video stream upon binding with the VideoTile Video stream intrinsic height could change and developers should use HTMLVideoElement listener for actual intrinsic height.
The intrinsic width of the video stream upon binding with the VideoTile. Video stream intrinsic width could change and developers should use HTMLVideoElement listener for actual intrinsic width.
Generated using TypeDoc
VideoTileState encapsulates the state of a VideoTile