VideoSubscriptionOptions

Video subscription settings.

class VideoSubscriptionOptions {
  const VideoSubscriptionOptions({this.type, this.encodedFrameOnly});

  @JsonKey(name: 'type')
  final VideoStreamType? type;

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

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

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

Properties

type
Type of video stream to subscribe to. Default is videoStreamHigh, which subscribes to the high-quality video stream. See VideoStreamType for details.
encodedFrameOnly
Whether to subscribe only to encoded video streams:
  • true: Subscribe only to encoded video data (structured data). The SDK does not decode or render the video data.
  • false: (Default) Subscribe to both raw and encoded video data.