TranscodingVideoStream

Video streams participating in local composition.

public class TranscodingVideoStream
    {
        public VIDEO_SOURCE_TYPE sourceType;
        public uint remoteUserUid;
        public string imageUrl;
        public int mediaPlayerId;
        public int x;
        public int y;
        public int width;
        public int height;
        public int zOrder;
        public double alpha;
        public bool mirror;
    };

Properties

sourceType
The video source type participating in local composition. See VIDEO_SOURCE_TYPE.
remoteUserUid
Remote user ID.
Note: Use this parameter only when the video source type for local composition is VIDEO_SOURCE_REMOTE.
imageUrl
Note: Use this parameter only when the video source type for local composition 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
  • macOS: ~/Pictures/image.png
  • Windows: C:\\Users\\{username}\\Pictures\\image.png
mediaPlayerId
(Optional) Media player ID. You need to set this parameter when sourceType is VIDEO_SOURCE_MEDIA_PLAYER.
x
Horizontal offset of the top-left corner of the video participating in local composition relative to the top-left corner (origin) of the composition canvas.
y
Vertical offset of the top-left corner of the video participating in local composition relative to the top-left corner (origin) of the composition canvas.
width
Width (px) of the video participating in local composition.
height
Height (px) of the video participating in local composition.
zOrder
Layer number of the video participating in local composition. Value range: [0,100].
  • 0: (Default) Layer is at the bottom.
  • 100: Layer is at the top.
alpha
Transparency of the video participating in local 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 participating in local composition:
  • true: Mirror the video.
  • false: (Default) Do not mirror the video.