TranscodingVideoStream

Video stream participating in local compositing.

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;
}

Properties

sourceType

Type of video source participating in local compositing. See VideoSourceType.

remoteUserUid

Remote user ID.

Note: Use this parameter only when the video source type for local compositing is VideoSourceRemote.

imageUrl

Note: Use this parameter only when the video source type for local compositing is an image.

Path to the local image.Example paths:

macOS: ~/Pictures/image.png
Windows: C:\\Users\\{username}\\Pictures\\image.png

mediaPlayerId

(Optional) Media player ID. Required when sourceType is set to VideoSourceMediaPlayer.

x

Horizontal offset of the top-left corner of the video relative to the top-left corner (origin) of the composite canvas.

y

Vertical offset of the top-left corner of the video relative to the top-left corner (origin) of the composite canvas.

width

Width (px) of the video in the local composite.

height

Height (px) of the video in the local composite.

zOrder

Layer index of the video in the local composite. Value range: [0,100].

0: (Default) Bottom layer.
100: Top layer.

alpha

Transparency of the video in the local composite. Value range: [0.0,1.0]. 0.0 means fully transparent, 1.0 means fully opaque.

mirror

Note: This parameter only takes effect for camera video sources.

Whether to mirror the video in the local composite:

true: Mirror the video.
false: (Default) Do not mirror the video.