AudioPublishOptions class

Options used when publishing audio.

Inheritance

Constructors

AudioPublishOptions({String? name, String? stream, AudioEncoding? encoding, bool dtx = true, bool? red = true, bool preConnect = false})
const

Properties

dtx → bool
Whether to enable DTX (Discontinuous Transmission) or not. https://en.wikipedia.org/wiki/Discontinuous_transmission Defaults to true.
final
encoding → AudioEncoding?
Preferred encoding parameters. Defaults to AudioEncoding.presetMusic when not set.
final
hashCode → int
The hash code for this object.
no setterinherited
name → String?
Name of the track.
finalinherited
preConnect → bool
Mark this audio as originating from a pre-connect buffer. Used to populate protobuf audioFeatures (TF_PRECONNECT_BUFFER).
final
red → bool?
red (Redundant Audio Data)
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
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_audio
finalinherited

Methods

copyWith({AudioEncoding? encoding, bool? dtx, String? name, String? stream, bool? red, bool? preConnect}) → AudioPublishOptions
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

defaultMicrophoneName → const String