TranscodingVideoStream

Video stream participating in local composition.

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 composition. See VideoSourceType.
remoteUserUid
Remote user ID.
Note: Use this parameter only when the video source type is VideoSourceRemote.
imageUrl
Note: Use this parameter only when the video source type is an image.
Path to the local image.Example paths:
  • Android: /storage/emulated/0/Pictures/image.png
  • iOS: /var/mobile/Containers/Data/Application/<APP-UUID>/Documents/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 composition canvas.
y
Vertical offset of the top-left corner of the video relative to the top-left corner (origin) of the composition canvas.
width
Width (px) of the video in the composition.
height
Height (px) of the video in the composition.
zOrder
Layer index of the video in the composition. Value range: [0,100].
  • 0: (Default) Bottom layer.
  • 100: Top layer.
alpha
Transparency of the video in the composition. 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 composition:
  • true: Mirror the video.
  • false: (Default) Do not mirror the video.