VideoPublishOptions class

Options used when publishing video.

Constructors

VideoPublishOptions({String videoCodec = 'H264', VideoEncoding? videoEncoding, bool simulcast = true, List<VideoParameters> videoSimulcastLayers = const [], List<VideoParameters> screenShareSimulcastLayers = const [], String? name, BackupVideoCodec? backupCodec, String? scalabilityMode})
const

Properties

backupCodec BackupVideoCodec?
final
hashCode int
The hash code for this object.
read-onlyinherited
name String?
Name of the video track.
final
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
scalabilityMode String?
final
screenShareSimulcastLayers List<VideoParameters>
final
simulcast bool
Whether to enable simulcast or not. https://blog.livekit.io/an-introduction-to-webrtc-simulcast-6c5f1f6402eb Defaults to true.
final
videoCodec String
The video codec to use.
final
videoEncoding VideoEncoding?
If provided, this will be used instead of the SDK's suggested encodings. Usually you don't need to provide this. Defaults to null.
final
videoSimulcastLayers List<VideoParameters>
final

Methods

copyWith({VideoEncoding? videoEncoding, bool? simulcast, List<VideoParameters>? videoSimulcastLayers, List<VideoParameters>? screenShareSimulcastLayers, String? videoCodec, BackupVideoCodec? backupCodec, String? scalabilityMode}) VideoPublishOptions
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

defaultCameraName → const String
'camera'
defaultScreenShareName → const String
'screenshare'