Skip to content

Ios audio category option

IosAudioCategoryOption #

Bases: Enum

Audio behaviors.

Each option is valid only for specific audio session categories.

ALLOW_AIRPLAY #

ALLOW_AIRPLAY = 'allowAirPlay'

Stream audio from this session to AirPlay devices.

Note

Available from iOS 10.0.

ALLOW_BLUETOOTH #

ALLOW_BLUETOOTH = 'allowBluetooth'

Bluetooth hands-free devices appear as available input routes.

ALLOW_BLUETOOTH_A2DP #

ALLOW_BLUETOOTH_A2DP = 'allowBluetoothA2DP'

Stream audio from this session to Bluetooth devices that support the Advanced Audio Distribution Profile (A2DP).

Note

Available from iOS 10.0.

DEFAULT_TO_SPEAKER #

DEFAULT_TO_SPEAKER = 'defaultToSpeaker'

Audio from the session defaults to the built-in speaker instead of the receiver.

DUCK_OTHERS #

DUCK_OTHERS = 'duckOthers'

Reduces the volume of other audio sessions while audio from this session plays.

INTERRUPT_SPOKEN_AUDIO_AND_MIX_WITH_OTHERS #

INTERRUPT_SPOKEN_AUDIO_AND_MIX_WITH_OTHERS = (
    "interruptSpokenAudioAndMixWithOthers"
)

Pause spoken audio content from other sessions when your app plays its audio.

Available from iOS 9.0.

MIX_WITH_OTHERS #

MIX_WITH_OTHERS = 'mixWithOthers'

Whether audio from this session mixes with audio from active sessions in other audio apps.

OVERRIDE_MUTED_MICROPHONE_INTERRUPTION #

OVERRIDE_MUTED_MICROPHONE_INTERRUPTION = (
    "overrideMutedMicrophoneInterruption"
)

System interrupts the audio session when it mutes the built-in microphone.

Note

Available from iOS 14.5.