TranscodingVideoStream
The video streams for local video mixing.
export class TranscodingVideoStream {
sourceType?: VideoSourceType;
remoteUserUid?: number;
imageUrl?: string;
mediaPlayerId?: number;
x?: number;
y?: number;
width?: number;
height?: number;
zOrder?: number;
alpha?: number;
mirror?: boolean;
}
Attributes
- sourceType
- The video source type for local video mixing. See VideoSourceType.
- remoteUserUid
-
The user ID of the remote user.
Attention: Use this parameter only when the source type is VideoSourceRemote for local video mixing. - imageUrl
-
The file path of local images.
Attention: Use this parameter only when the source type is the image for local video mixing.Examples:- macOS:
~/Pictures/image.png - Windows:
C:\\Users\\{username}\\Pictures\\image.png
- macOS:
- mediaPlayerId
- (Optional) Media player ID. Use the parameter only when you set sourceType to VideoSourceMediaPlayer.
- x
- 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
- The relative longitudinal displacement of the top left corner of the captured video to the origin (the top left corner of the canvas).
- width
- The width (px) of the video for local video mixing on the canvas.
- height
- The height (px) of the video for local video mixing on the canvas.
- zOrder
- 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.
- alpha
- 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.
- mirror
- 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.
Attention: This parameter only takes effect on video source types that are cameras.