VideoLayout

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

@JsonSerializable(explicitToJson: true, includeIfNull: false)
class VideoLayout {
  const VideoLayout(
      {this.channelId,
      this.uid,
      this.strUid,
      this.x,
      this.y,
      this.width,
      this.height,
      this.videoState});
  @JsonKey(name: 'channelId')
  final String? channelId;
  @JsonKey(name: 'uid')
  final int? uid;
  @JsonKey(name: 'strUid')
  final String? strUid;
  @JsonKey(name: 'x')
  final int? x;
  @JsonKey(name: 'y')
  final int? y;
  @JsonKey(name: 'width')
  final int? width;
  @JsonKey(name: 'height')
  final int? height;
  @JsonKey(name: 'videoState')
  final int? videoState;
  factory VideoLayout.fromJson(Map<String, dynamic> json) =>
      _$VideoLayoutFromJson(json);
  Map<String, dynamic> toJson() => _$VideoLayoutToJson(this);
}

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.