AudioCaptureOptions class

Options used when creating a LocalAudioTrack.

Inheritance

Constructors

AudioCaptureOptions({String? deviceId, bool noiseSuppression = true, bool echoCancellation = true, bool autoGainControl = true, bool highPassFilter = false, bool typingNoiseDetection = true, bool stopAudioCaptureOnMute = true})
const

Properties

autoGainControl → bool
Attempt to use autoGainControl option (if supported by the platform) See https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/autoGainControl Defaults to true.
final
deviceId → String?
The deviceId of the capture device to use. Available deviceIds can be obtained through flutter_webrtc:
final
echoCancellation → bool
Attempt to use echoCancellation option (if supported by the platform) See https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackSettings/echoCancellation Defaults to true.
final
hashCode → int
The hash code for this object.
no setterinherited
highPassFilter → bool
Attempt to use highPassFilter options (if supported by the platform) Defaults to false.
final
noiseSuppression → bool
Attempt to use noiseSuppression option (if supported by the platform) See https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackSettings/noiseSuppression Defaults to true.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stopAudioCaptureOnMute → bool
set to false to only toggle enabled instead of stop/replaceTrack for muting
final
typingNoiseDetection → bool
Attempt to use typingNoiseDetection option (if supported by the platform) Defaults to true.
final

Methods

copyWith({String? deviceId, bool? noiseSuppression, bool? echoCancellation, bool? autoGainControl, bool? highPassFilter, bool? typingNoiseDetection}) → AudioCaptureOptions
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMediaConstraintsMap() → Map<String, dynamic>
override
toString() → String
A string representation of this object.
inherited

Operators

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