TranscodingVideoStream

Video streams involved in local compositing.

@JsonSerializable(explicitToJson: true, includeIfNull: false)
class TranscodingVideoStream {
  const TranscodingVideoStream(
      {this.sourceType,
      this.remoteUserUid,
      this.imageUrl,
      this.mediaPlayerId,
      this.x,
      this.y,
      this.width,
      this.height,
      this.zOrder,
      this.alpha,
      this.mirror});

  @JsonKey(name: 'sourceType')
  final VideoSourceType? sourceType;

  @JsonKey(name: 'remoteUserUid')
  final int? remoteUserUid;

  @JsonKey(name: 'imageUrl')
  final String? imageUrl;

  @JsonKey(name: 'mediaPlayerId')
  final int? mediaPlayerId;

  @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: 'zOrder')
  final int? zOrder;

  @JsonKey(name: 'alpha')
  final double? alpha;

  @JsonKey(name: 'mirror')
  final bool? mirror;

  factory TranscodingVideoStream.fromJson(Map<String, dynamic> json) =>
      _$TranscodingVideoStreamFromJson(json);

  Map<String, dynamic> toJson() => _$TranscodingVideoStreamToJson(this);
}

Properties

sourceType
Type of video source involved in local compositing. See VideoSourceType.
remoteUserUid
Remote user ID.
Note: Use this parameter only when the video source type for local compositing is videoSourceRemote.
imageUrl
Note: Use this parameter only when the video source type for local compositing 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. Set this parameter when sourceType is set to videoSourceMediaPlayer.
x
Horizontal offset of the top-left corner of the video relative to the top-left corner (origin) of the canvas.
y
Vertical offset of the top-left corner of the video relative to the top-left corner (origin) of the canvas.
width
Width of the video involved in local compositing (px).
height
Height of the video involved in local compositing (px).
zOrder
Layer number of the video involved in local compositing. Value range: [0,100].
  • 0: (Default) Bottom layer.
  • 100: Top layer.
alpha
Transparency of the video involved in local compositing. Value range: [0.0,1.0]. 0.0 means fully transparent, 1.0 means fully opaque.
mirror
Note: This parameter takes effect only for video sources from the camera.
Whether to mirror the video involved in local compositing:
  • true: Mirror the video.
  • false: (Default) Do not mirror the video.