[[VideoTileState]] encapsulates the state of a [[VideoTile]]

Constructors

Properties

active: boolean = false

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.

boundAttendeeId: string = null

The attendee id associated with the [[VideoTile]].

boundExternalUserId: string = null

The user id associated with the [[VideoTile]].

boundVideoElement: HTMLVideoElement = null

The HTMLVideoElement bound with the [[VideoTile]].

boundVideoStream: MediaStream = null

The video stream bound with the [[VideoTile]].

devicePixelRatio: number = 0

The device pixel ratio of the current display monitor.

groupId: number = null

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.

isContent: boolean = false

Indication of whether the tile has content-sharing video.

localTile: boolean = false

Indication of whether tile is associated with local video.

localTileStarted: boolean = false

Indication of whether the tile associated with the local attendee has started to play.

nameplate: string = null

The nameplate for the [[VideoTile]]. SDK users should use boundExternalUserId for user id instead of this field.

paused: boolean = false

Indication of whether the tile has paused video stream.

poorConnection: boolean = false

Indication of whether the remote video is paused at publishing attendee. This field is not supported.

streamId: number = null

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.

tileId: number = null

The unique identifier for the [[VideoTile]] managed by [[VideoTileController]]. Each attendee can have at most one tileId.

videoElementCSSHeightPixels: number = null

The CSS height in pixel of the HTMLVideoElement upon binding with the [[VideoTile]].

videoElementCSSWidthPixels: number = null

The CSS width in pixel of the HTMLVideoElement upon binding with the [[VideoTile]].

videoElementPhysicalHeightPixels: number = null

The physical height in pixel of the HTMLVideoElement upon binding with the [[VideoTile]].

videoElementPhysicalWidthPixels: number = null

The physical width in pixel of the HTMLVideoElement upon binding with the [[VideoTile]].

videoStreamContentHeight: number = null

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.

videoStreamContentWidth: number = null

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.

Methods