AVAudioSessionOptions enum

This is a Dart representation of the equivalent enum on Swift.

Constants that specify optional audio behaviors. Each option is valid only for specific audio session categories.

Inheritance
Available extensions

Values

mixWithOthers → const AVAudioSessionOptions

An option that indicates whether audio from this session mixes with audio from active sessions in other audio apps. You can set this option explicitly only if the audio session category is playAndRecord, playback, or multiRoute. If you set the audio session category to ambient, the session automatically sets this option. Likewise, setting the duckOthers or interruptSpokenAudioAndMixWithOthers options also enables this option. See: https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616611-mixwithothers

duckOthers → const AVAudioSessionOptions

An option that reduces the volume of other audio sessions while audio from this session plays. You can set this option only if the audio session category is playAndRecord, playback, or multiRoute. Setting it implicitly sets the mixWithOthers option. https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616618-duckothers

interruptSpokenAudioAndMixWithOthers → const AVAudioSessionOptions

An option that determines whether to pause spoken audio content from other sessions when your app plays its audio. You can set this option only if the audio session category is playAndRecord, playback, or multiRoute. Setting this option also sets mixWithOthers. See: https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616534-interruptspokenaudioandmixwithot

allowBluetooth → const AVAudioSessionOptions

An option that determines whether Bluetooth hands-free devices appear as available input routes. You can set this option only if the audio session category is playAndRecord or record. See: https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616518-allowbluetooth

allowBluetoothA2DP → const AVAudioSessionOptions

An option that determines whether you can stream audio from this session to Bluetooth devices that support the Advanced Audio Distribution Profile (A2DP). The system automatically routes to A2DP ports if you configure an app’s audio session to use the ambient, soloAmbient, or playback categories. See: https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1771735-allowbluetootha2dp

allowAirPlay → const AVAudioSessionOptions

An option that determines whether you can stream audio from this session to AirPlay devices. You can only explicitly set this option if the audio session’s category is set to playAndRecord. See: https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1771736-allowairplay

defaultToSpeaker → const AVAudioSessionOptions

An option that determines whether audio from the session defaults to the built-in speaker instead of the receiver. You can set this option only when using the playAndRecord category. See: https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616462-defaulttospeaker

overrideMutedMicrophoneInterruption → const AVAudioSessionOptions

An option that indicates whether the system interrupts the audio session when it mutes the built-in microphone. If your app uses an audio session category that supports input and output, such as playAndRecord, you can set this option to disable the default behavior and continue using the session. See: https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/3727255-overridemutedmicrophoneinterrupt

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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

Constants

values → const List<AVAudioSessionOptions>
A constant List of the values in this enum, in order of their declaration.