AudioCaptureOptions class
Options used when creating a LocalAudioTrack.
- Inheritance
-
- Object
- LocalTrackOptions
- AudioCaptureOptions
- Implemented types
Constructors
-
AudioCaptureOptions({String? deviceId, bool noiseSuppression = true, bool echoCancellation = true, bool autoGainControl = true, bool highPassFilter = false, AudioProcessingMode echoCancellationMode = AudioProcessingMode.automatic, AudioProcessingMode noiseSuppressionMode = AudioProcessingMode.automatic, AudioProcessingMode autoGainControlMode = AudioProcessingMode.automatic, AudioProcessingMode highPassFilterMode = AudioProcessingMode.automatic, bool voiceIsolation = true, bool typingNoiseDetection = true, bool stopAudioCaptureOnMute = true, TrackProcessor<
AudioProcessorOptions> ? processor}) -
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
- autoGainControlMode → AudioProcessingMode
-
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
- echoCancellationMode → AudioProcessingMode
-
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
- highPassFilterMode → AudioProcessingMode
-
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
- noiseSuppressionMode → AudioProcessingMode
-
final
- processing → AudioProcessingOptions
-
no setter
-
processor
→ TrackProcessor<
AudioProcessorOptions> ? -
A processor to apply to the audio track.
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
- voiceIsolation → bool
-
Attempt to use voiceIsolation option (if supported by the platform)
Defaults to true.
final
Methods
-
copyWith(
{String? deviceId, bool? noiseSuppression, bool? echoCancellation, bool? autoGainControl, bool? highPassFilter, AudioProcessingMode? echoCancellationMode, AudioProcessingMode? noiseSuppressionMode, AudioProcessingMode? autoGainControlMode, AudioProcessingMode? highPassFilterMode, AudioProcessingOptions? processing, bool? voiceIsolation, bool? typingNoiseDetection, bool? stopAudioCaptureOnMute, TrackProcessor< AudioProcessorOptions> ? processor}) → AudioCaptureOptions -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
override
-
toMediaConstraintsMap(
) → Map< String, dynamic> -
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited