IosAudioCategoryOption

Audio behaviors.

Each option is valid only for specific audio session categories.

Inherits: enum.Enum

Properties

• ALLOW_AIRPLAY - Stream audio from this session to AirPlay devices.
• ALLOW_BLUETOOTH - Bluetooth hands-free devices appear as available input routes.
• ALLOW_BLUETOOTH_A2DP - Stream audio from this session to Bluetooth devices that support the Advanced Audio Distribution Profile (A2DP).
• DEFAULT_TO_SPEAKER - Audio from the session defaults to the built-in speaker instead of the receiver.
• DUCK_OTHERS - Reduces the volume of other audio sessions while audio from this session plays.
• INTERRUPT_SPOKEN_AUDIO_AND_MIX_WITH_OTHERS - Pause spoken audio content from other sessions when your app plays its audio.
• MIX_WITH_OTHERS - Whether audio from this session mixes with audio from active sessions in other audio apps.
• OVERRIDE_MUTED_MICROPHONE_INTERRUPTION - System interrupts the audio session when it mutes the built-in microphone.

Properties

buildALLOW_AIRPLAYclass-attributeinstance-attribute

Stream audio from this session to AirPlay devices.

Note

Available from iOS 10.0.

buildALLOW_BLUETOOTHclass-attributeinstance-attribute

Bluetooth hands-free devices appear as available input routes.

buildALLOW_BLUETOOTH_A2DPclass-attributeinstance-attribute

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

Note

Available from iOS 10.0.

buildDEFAULT_TO_SPEAKERclass-attributeinstance-attribute

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

buildDUCK_OTHERSclass-attributeinstance-attribute

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

buildINTERRUPT_SPOKEN_AUDIO_AND_MIX_WITH_OTHERSclass-attributeinstance-attribute

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

Available from iOS 9.0.

buildMIX_WITH_OTHERSclass-attributeinstance-attribute

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

buildOVERRIDE_MUTED_MICROPHONE_INTERRUPTIONclass-attributeinstance-attribute

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

Note

Available from iOS 14.5.