VideoPublishOptions class
Options used when publishing video.
- Inheritance
-
- Object
- PublishOptions
- VideoPublishOptions
Constructors
-
VideoPublishOptions({String? name, String? stream, String videoCodec = defaultVideoCodec, VideoEncoding? videoEncoding, bool simulcast = true, List<
VideoParameters> videoSimulcastLayers = const [], BackupVideoCodec backupVideoCodec = defualtBackupVideoCodec, String? scalabilityMode}) -
const
Properties
- backupVideoCodec → BackupVideoCodec
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- name → String?
-
Name of the track.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scalabilityMode → String?
-
final
-
final
- simulcast → bool
-
Whether to enable simulcast or not.
https://blog.livekit.io/an-introduction-to-webrtc-simulcast-6c5f1f6402eb
Defaults to true.
final
- stream → String?
-
Set stream name for the track. Audio and video tracks with the same stream name
will be placed in the same
MediaStream
and offer better synchronization. By default, camera and microphone will be placed in a stream; as would screen_share and screen_share_audiofinalinherited - 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, String? videoCodec, BackupVideoCodec? backupVideoCodec, String? scalabilityMode, String? name, String? stream}) → 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
- defualtBackupVideoCodec → const BackupVideoCodec