Class VideoCanvas

Attributes of the video canvas object.

Hierarchy

  • VideoCanvas

Constructors

Properties

backgroundColor?: number

The background color of the video canvas in RGBA format. The default value is 0x00000000, which represents completely transparent black.

cropArea?: Rectangle

(Optional) Display area of the video frame, see Rectangle. width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed.

mediaPlayerId?: number

The ID of the media player. You can get the Device ID by calling getMediaPlayerId.

mirrorMode?: VideoMirrorModeType

The mirror mode of the view. See VideoMirrorModeType. For the mirror mode of the local video view: If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default. For the remote user: The mirror mode is disabled by default.

The observation position of the video frame in the video link. See VideoModulePosition.

renderMode?: RenderModeType

The rendering mode of the video. See RenderModeType.

setupMode?: VideoViewSetupMode

Setting mode of the view. See VideoViewSetupMode.

sourceType?: VideoSourceType

The type of the video source. See VideoSourceType.

subviewUid?: number

The ID of the user who publishes a specific sub-video stream within the mixed video stream.

uid?: number

User ID that publishes the video source.

view?: any

The video display window. In one VideoCanvas, you can only choose to set either view or surfaceTexture. If both are set, only the settings in view take effect.

Generated using TypeDoc