VideoLayout

Layout information of a specific sub-video stream within the mixed stream.

struct VideoLayout
{
  const char* channelId;
  rtc::uid_t uid;
  user_id_t strUid;
  uint32_t x;
  uint32_t y;
  uint32_t width;
  uint32_t height;
  uint32_t videoState;
  VideoLayout() : channelId(OPTIONAL_NULLPTR), uid(0), strUid(OPTIONAL_NULLPTR), x(0), y(0), width(0), height(0), videoState(0) {}
};

Since: v4.3.0

Attributes

channelId

The channel name to which the sub-video stream belongs.

uid

User ID who published this sub-video stream.

strUid

Reserved for future use.

x

X-coordinate (px) of the sub-video stream on the mixing canvas. The relative lateral displacement of the top left corner of the video for video mixing to the origin (the top left corner of the canvas).

y

Y-coordinate (px) of the sub-video stream on the mixing canvas. The relative longitudinal displacement of the top left corner of the captured video to the origin (the top left corner of the canvas).

width

Width (px) of the sub-video stream.

height

Heitht (px) of the sub-video stream.

videoState

Status of the sub-video stream on the video mixing canvas.

0: Normal. The sub-video stream has been rendered onto the mixing canvas.
1: Placeholder image. The sub-video stream has no video frames and is displayed as a placeholder on the mixing canvas.
2: Black image. The sub-video stream is replaced by a black image.