Version
menu_open
Target Platform(s):
Wwise SDK 2024.1.0
Classes | Namespaces | Macros | Typedefs | Enumerations | Functions
AkiOSSoundEngine.h File Reference
#include <AK/SoundEngine/Common/AkTypes.h>
#include <AK/Tools/Common/AkPlatformFuncs.h>
#include <AudioToolbox/AudioToolbox.h>

Go to the source code of this file.

Classes

struct  AkAudioSessionProperties
 
struct  AkAudioCallbacks
 
struct  AkPlatformInitSettings
 

Namespaces

namespace  AK
 Definition of data structures for AkAudioObject.
 
 AK::SoundEngine
 
 AK::SoundEngine::iOS
 

Macros

#define AKMOTION_RESIDENT_MODE   (0x80000000)
 

Typedefs

typedef AKRESULT(* AK::SoundEngine::iOS::AudioInputCallbackFunc) (const AudioBufferList *io_Data, void *in_pCookie)
 
typedef void(* AK::SoundEngine::iOS::AudioInterruptionCallbackFunc) (bool in_bEnterInterruption, void *in_pCookie)
 

Enumerations

enum  AkAudioSessionCategory {
  AkAudioSessionCategoryAmbient, AkAudioSessionCategorySoloAmbient, AkAudioSessionCategoryPlayAndRecord, AkAudioSessionCategoryPlayback,
  AkAudioSessionCategory_Last
}
 
enum  AkAudioSessionCategoryOptions {
  AkAudioSessionCategoryOptionMixWithOthers = 1, AkAudioSessionCategoryOptionDuckOthers = 2, AkAudioSessionCategoryOptionAllowBluetooth = 4, AkAudioSessionCategoryOptionDefaultToSpeaker = 8,
  AkAudioSessionCategoryOptionAllowBluetoothA2DP = 0x20, AkAudioSessionCategoryOptions_Last
}
 
enum  AkAudioSessionMode {
  AkAudioSessionModeDefault = 0, AkAudioSessionModeVoiceChat, AkAudioSessionModeGameChat, AkAudioSessionModeVideoRecording,
  AkAudioSessionModeMeasurement, AkAudioSessionModeMoviePlayback, AkAudioSessionModeVideoChat, AkAudioSessionMode_Last
}
 
enum  AkAudioSessionRouteSharingPolicy { AkAudioSessionRouteSharingPolicyDefault = 0, AkAudioSessionRouteSharingPolicyLongFormAudio = 1, AkAudioSessionRouteSharingPolicyLongFormVideo = 3, AkAudioSessionRouteSharingPolicy_Last }
 The IDs of the iOS audio session route sharing policies, which determine which audio routes are permitted for the audio session controlled by Wwise. These policies only apply for the "Playback" audio session category. 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 route-sharing policies. The original prefix "AV" is replaced with "Ak" for the ID names. More...
 
enum  AkAudioSessionSetActiveOptions { AkAudioSessionSetActiveOptionNotifyOthersOnDeactivation = 1 }
 
enum  AkAudioSessionBehaviorOptions { AkAudioSessionBehaviorSuspendInBackground = 0x1 }
 Flags that can modify the default Sound Engine behavior related to the management of the audio session. These do not have equivalences in the official iOS SDK; they apply uniquely to Wwise's approach to interruption handling. More...
 
enum  AkAudioAPI {
  AkAudioAPI_AAudio = 1 << 0, AkAudioAPI_OpenSL_ES = 1 << 1, AkAudioAPI_Last, AkAudioAPI_Default = AkAudioAPI_AAudio | AkAudioAPI_OpenSL_ES,
  AkAudioAPI_AVAudioEngine = 1 << 0, AkAudioAPI_AudioUnit = 1 << 1, AkAudioAPI_Default = AkAudioAPI_AVAudioEngine | AkAudioAPI_AudioUnit, AkAudioAPI_AVAudioEngine = 1 << 0,
  AkAudioAPI_AudioUnit = 1 << 1, AkAudioAPI_Default = AkAudioAPI_AVAudioEngine | AkAudioAPI_AudioUnit, AkAPI_PulseAudio = 1 << 0, AkAPI_ALSA = 1 << 1,
  AkAPI_Default = AkAPI_PulseAudio | AkAPI_ALSA
}
 

Functions

AKSOUNDENGINE_API void AK::SoundEngine::iOS::ChangeAudioSessionProperties (const AkAudioSessionProperties &in_properties)
 
AKSOUNDENGINE_API AkDeviceID AK::SoundEngine::GetDeviceIDFromPlayerIndex (int playerIndex)
 

Detailed Description

Main Sound Engine interface, specific iOS.

Definition in file AkiOSSoundEngine.h.

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise