TranscodingVideoStream

Used to set the video stream for local composite layout.

struct TranscodingVideoStream {
  VIDEO_SOURCE_TYPE sourceType;
  uid_t remoteUserUid;
  const char* imageUrl;
  int mediaPlayerId;
  int x;
  int y;
  int width;
  int height;
  int zOrder;
  double alpha;
  bool mirror;
};

Properties

sourceType
Video source type. See VIDEO_SOURCE_TYPE.
remoteUserUid
Remote user ID.
Note: Used only when the video source type is VIDEO_SOURCE_REMOTE.
imageUrl
File path of the local image. For example: Windows: C:\Users\{username}\Pictures\image.png.
Note: Used only when the video source type is image.
mediaPlayerId
Media player ID.
Note: Used only when the video source type is VIDEO_SOURCE_MEDIA_PLAYER.
x
Horizontal offset of the top-left corner of the video relative to the canvas origin (top-left corner of the canvas).
y
Vertical offset of the top-left corner of the video relative to the canvas origin (top-left corner of the canvas).
width
Width of the video on the canvas (in pixels).
height
Height of the video on the canvas (in pixels).
zOrder
Layer index of the video. Range is [0, 100].
  • 0: (Default) Bottom layer.
  • 100: Top layer.
alpha
Transparency of the video. Range is [0.0, 1.0].
  • 0.0: Completely transparent.
  • 1.0: Fully opaque.
mirror
Note: This parameter only takes effect for camera-type video sources.
Whether to mirror the video.
  • true: Mirror the video.
  • false: (Default) Do not mirror the video.