Class TranscodingVideoStream

The video streams for local video mixing.

Hierarchy

  • TranscodingVideoStream

Constructors

Properties

alpha?: number

The transparency of the video for local video mixing. The value range is [0.0, 1.0]. 0.0 indicates that the video is completely transparent, and 1.0 indicates that it is opaque.

height?: number

The height (px) of the video for local video mixing on the canvas.

imageUrl?: string

The URL of the image. Use this parameter only when the source type is the image for local video mixing.

mediaPlayerId?: number

(Optional) Media player ID. Use the parameter only when you set sourceType to VideoSourceMediaPlayer.

mirror?: boolean

Whether to mirror the video for the local video mixing. true : Mirror the video for the local video mixing. false : (Default) Do not mirror the video for the local video mixing. This parameter only takes effect on video source types that are cameras.

remoteUserUid?: number

The user ID of the remote user. Use this parameter only when the source type is VideoSourceRemote for local video mixing.

sourceType?: VideoSourceType

The video source type for local video mixing. See VideoSourceType.

width?: number

The width (px) of the video for local video mixing on the canvas.

x?: number

The relative lateral displacement of the top left corner of the video for local video mixing to the origin (the top left corner of the canvas).

y?: number

The relative longitudinal displacement of the top left corner of the captured video to the origin (the top left corner of the canvas).

zOrder?: number

The number of the layer to which the video for the local video mixing belongs. The value range is [0, 100]. 0: (Default) The layer is at the bottom. 100: The layer is at the top.

Generated using TypeDoc