Table of Contents

The IDs of the iOS audio session categories, useful for defining app-level audio behaviours such as inter-app audio mixing policies and audio routing behaviours. These IDs are funtionally equivalent to the corresponding constants defined by the iOS audio session service backend (AVAudioSession). Refer to Xcode documentation for details on the audio session categories. The original prefix "AV" is replaced with "Ak" for the ID names.

Remarks:
An audio session category may demand a fixed value for a certain category options (AkAudioSessionCategoryOptions) depending on the underlying audio session services. Ensure that AkPlatformInitSettings.audioSession.eCategory and AkPlatformInitSettings.audioSession.eCategoryOptions be compatible with each other. If conflicts are detected between the user-specified audio sessoin category and category options, the sound engine will try to fix them during the initialization according to the underlying policies defined by the audio services. The policies are:
  • The audio session category AkAudioSessionCategory_AmbientSound forbid the use of the category options: AkAudioSessionCategoryOptionAllowBluetooth and AkAudioSessionCategoryOptionDefaultToSpeaker.
  • AkAudioSessionCategory_SoloAmbientSound forbid the use of the category options: AkAudioSessionCategoryOptionAllowBluetooth and AkAudioSessionCategoryOptionDefaultToSpeaker.
See also:
Enumerator:
AkAudioSessionCategoryAmbient 

Audio session category corresponding to the AVAudiosession's AVAudioSessionCategoryAmbient constant.

AkAudioSessionCategorySoloAmbient 

Audio session category corresponding to the AVAudiosession's AVAudioSessionCategorySoloAmbient constant.

AkAudioSessionCategoryPlayAndRecord 

Audio session category corresponding to the AVAudiosession's AVAudioSessionCategoryPlayAndRecord constant.

Definition at line 51 of file AkiOSSoundEngine.h.