VideoLayout

Describes the layout information of a sub video stream in a 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;
};

Describes the position, size, and display state of a sub video stream in the composite canvas.

Properties

channelId
The channel name to which the sub video stream belongs.
uid
The user ID of the publisher of the sub video stream.
strUid
Reserved parameter.
x
The X coordinate (in pixels) of the sub video stream on the composite canvas, indicating the horizontal offset of the top-left corner of the video relative to the top-left corner of the canvas.
y
The Y coordinate (in pixels) of the sub video stream on the composite canvas, indicating the vertical offset of the top-left corner of the video relative to the top-left corner of the canvas.
width
The width (in pixels) of the sub video stream.
height
The height (in pixels) of the sub video stream.
videoState
The display state of the sub video stream on the composite canvas:
  • 0: Normal. The sub video stream is rendered on the canvas.
  • 1: Placeholder image. The sub video stream has no video frame and is shown as a placeholder image on the canvas.
  • 2: Black image. The sub video stream is replaced with a black image.