VideoLayout

Layout information of a sub-video stream in a composite video.

export class VideoLayout {
  channelId?: string;
  uid?: number;
  strUid?: string;
  x?: number;
  y?: number;
  width?: number;
  height?: number;
  videoState?: number;
}

Properties

channelId
Channel name to which the sub-video stream belongs.
uid
User ID that publishes the sub-video stream.
strUid
Reserved parameter.
x
The x-coordinate (px) of the sub-video on the composite canvas. It represents the horizontal offset of the top-left corner of the sub-video relative to the top-left corner (origin) of the canvas.
y
The y-coordinate (px) of the sub-video on the composite canvas. It represents the vertical offset of the top-left corner of the sub-video relative to the top-left corner (origin) of the canvas.
width
Width of the sub-video stream (px).
height
Height of the sub-video stream (px).
videoState
State of the sub-video stream on the composite canvas.
  • 0: Normal. The video stream has been rendered on the canvas.
  • 1: Placeholder. The video stream has no video content and is displayed as a placeholder.
  • 2: Black image. The video stream is replaced by a black image.