Version
menu_open
Wwise SDK 2024.1.0
AkiOSSoundEngine.h
Go to the documentation of this file.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Copyright (c) 2024 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 // AkiOSSoundEngine.h
28 
29 /// \file
30 /// Main Sound Engine interface, specific iOS.
31 
32 #ifndef _AK_IOS_SOUND_ENGINE_H_
33 #define _AK_IOS_SOUND_ENGINE_H_
34 
35 #include <AK/SoundEngine/Common/AkTypes.h>
36 #include <AK/Tools/Common/AkPlatformFuncs.h>
37 
38 #include <AudioToolbox/AudioToolbox.h>
39 
40 /// 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.
41 ///
42 /// \sa
43 /// - \ref AkPlatformInitSettings
44 /// - \ref AkAudioSessionCategoryOptions
45 /// - \ref AkAudioSessionProperties
46 enum AkAudioSessionCategory
47 {
48  AkAudioSessionCategoryAmbient, ///< Audio session category corresponding to the AVAudiosession's AVAudioSessionCategoryAmbient constant
49  AkAudioSessionCategorySoloAmbient, ///< Audio session category corresponding to the AVAudiosession's AVAudioSessionCategorySoloAmbient constant
50  AkAudioSessionCategoryPlayAndRecord, ///< Audio session category corresponding to the AVAudiosession's AVAudioSessionCategoryPlayAndRecord constant
51  AkAudioSessionCategoryPlayback, ///< Audio session category corresponding to the AVAudiosession's AVAudioSessionCategoryPlayback constant
52  AkAudioSessionCategory_Last, ///< End of enum, invalid value.
53 };
54 
55 /// The IDs of the iOS audio session category options, used for customizing the audio session category features. 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 category options. The original prefix "AV" is replaced with "Ak" for the ID names.
56 /// \remark These options only have an effect with specific audio session categories. See the documentation for each option to learn which category they affect.
57 ///
58 /// \sa
59 /// - \ref AkPlatformInitSettings
60 /// - \ref AkAudioSessionCategory
61 /// - \ref AkAudioSessionProperties
62 enum AkAudioSessionCategoryOptions
63 {
64  AkAudioSessionCategoryOptionMixWithOthers = 1, ///< Same as AVAudioSessionCategoryOptionMixWithOthers. Only affects PlayAndRecord and Playback categories.
65  AkAudioSessionCategoryOptionDuckOthers = 2, ///< Same as AVAudioSessionCategoryOptionDuckOthers. Implicitely sets the MixWithOthers option. Only affects PlayAndRecord and Playback categories.
66  AkAudioSessionCategoryOptionAllowBluetooth = 4, ///< Same as AVAudioSessionCategoryOptionAllowBluetooth. Only affects PlayAndRecord category.
67  AkAudioSessionCategoryOptionDefaultToSpeaker = 8, ///< Same as AVAudioSessionCategoryOptionDefaultToSpeaker. Only affects PlayAndRecord category.
68  AkAudioSessionCategoryOptionAllowBluetoothA2DP = 0x20, ///< Same as AVAudioSessionCategoryOptionAllowBluetoothA2DP. Only affects PlayAndRecord category.
69  AkAudioSessionCategoryOptions_Last, ///< End of enum, invalid value.
70 };
71 
72 /// The IDs of the iOS audio session modes, used for customizing the audio session for typical app types. 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 modes. The original prefix "AV" is replaced with "Ak" for the ID names.
73 ///
74 /// \sa
75 /// - \ref AkPlatformInitSettings
76 /// - \ref AkAudioSessionProperties
77 enum AkAudioSessionMode
78 {
79  AkAudioSessionModeDefault = 0, ///< Audio session mode corresponding to the AVAudiosession's AVAudioSessionModeDefault constant
80  AkAudioSessionModeVoiceChat, ///< Audio session mode corresponding to the AVAudiosession's AVAudioSessionModeVoiceChat constant
81  AkAudioSessionModeGameChat, ///< Audio session mode corresponding to the AVAudiosession's AVAudioSessionModeGameChat constant
82  AkAudioSessionModeVideoRecording, ///< Audio session mode corresponding to the AVAudiosession's AVAudioSessionModeVideoRecording constant
83  AkAudioSessionModeMeasurement, ///< Audio session mode corresponding to the AVAudiosession's AVAudioSessionModeMeasurement constant
84  AkAudioSessionModeMoviePlayback, ///< Audio session mode corresponding to the AVAudiosession's AVAudioSessionModeMoviePlayback constant
85  AkAudioSessionModeVideoChat, ///< Audio session mode corresponding to the AVAudiosession's AVAudioSessionModeMoviePlayback constant
86  AkAudioSessionMode_Last, ///< End of enum, invalid value.
87 };
88 
89 /// 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.
90 enum AkAudioSessionRouteSharingPolicy
91 {
92  AkAudioSessionRouteSharingPolicyDefault = 0, ///< Corresponds to AVAudioSessionRouteSharingPolicyDefault
93  AkAudioSessionRouteSharingPolicyLongFormAudio = 1, ///< Corresponds to AVAudioSessionRouteSharingPolicyLongFormAudio
94  AkAudioSessionRouteSharingPolicyLongFormVideo = 3, ///< Corresponds to AVAudioSessionRouteSharingPolicyLongFormVideo
95  AkAudioSessionRouteSharingPolicy_Last, ///< End of enum, invalid value.
96 };
97 
98 /// The behavior flags for when iOS audio session is activated. These IDs are functionally equivalent to the corresponding constants defined by the iOS audio session service backend (AVAudioSession). Refer to Xcode documentation for details on the audio session options. The original prefix "AV" is replaced with "Ak" for the ID names.
99 ///
100 /// \sa
101 /// - \ref AkPlatformInitSettings
102 /// - \ref AkAudioSessionProperties
103 enum AkAudioSessionSetActiveOptions
104 {
105  AkAudioSessionSetActiveOptionNotifyOthersOnDeactivation = 1 ///< Audio session activation option corresponding to the AVAudiosession's AVAudioSessionSetActiveOptionNotifyOthersOnDeactivation constant
106 };
107 
108 /// 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.
109 enum AkAudioSessionBehaviorOptions
110 {
111  AkAudioSessionBehaviorSuspendInBackground = 0x1 ///< By default, the Sound Engine continues to render audio in the background when using PlayAndRecord or Playback categories. Setting this flag causes the Sound Engine to suspend audio rendering when in the background, thus disabling background audio. Only affects Playback and PlayAndRecord audio session categories.
112 };
113 
114 /// The API structure used with AkPlatformInitSettings for specifying iOS audio session for the sound engine.
115 ///
116 /// \sa
117 /// - \ref AkPlatformInitSettings
118 /// - \ref AkAudioSessionCategory
119 /// - \ref AkAudioSessionCategoryOptions
120 /// - \ref AkAudioSessionMode
121 /// - \ref AkAudioSessionSetActiveOptions
122 /// - \ref AkAudioSessionRouteSharingPolicy
123 struct AkAudioSessionProperties
124 {
125  AkAudioSessionCategory eCategory; ///< \sa AkAudioSessionCategory
126  AkAudioSessionCategoryOptions eCategoryOptions; ///< \sa AkAudioSessionCategoryOptions
127  AkAudioSessionMode eMode; ///< \sa AkAudioSessionMode
128  AkAudioSessionRouteSharingPolicy eRouteSharingPolicy; ///< \sa AkAudioSessionRouteSharingPolicy
129  AkAudioSessionSetActiveOptions eSetActivateOptions; ///< \sa AkAudioSessionSetActiveOptions
130  AkAudioSessionBehaviorOptions eAudioSessionBehavior; ///< Flags to change the default Sound Engine behavior related to the management of the iOS Audio Session with regards to application lifecycle events. \sa AkAudioSessionBehaviorFlags
131 };
132 
133 ///< API used for audio output
134 ///< Use with AkPlatformInitSettings to select the API used for audio output. The selected API may be ignored if the device does not support it.
135 ///< Use AkAPI_Default, it will select the more appropriate API depending on the device's capabilities. Other values should be used for testing purposes.
136 ///< \sa AK::SoundEngine::Init
137 typedef enum AkAudioAPIiOS
138 {
139  AkAudioAPI_AVAudioEngine = 1 << 0, ///< Use AVFoundation framework (modern, has more capabilities, not available for iOS/tvOS 12 or below)
140  AkAudioAPI_AudioUnit = 1 << 1, ///< Use AudioUnit framework (basic functionality, compatible with all iOS devices)
141  AkAudioAPI_Default = AkAudioAPI_AVAudioEngine | AkAudioAPI_AudioUnit, ///< Default value, will select the more appropriate API (AVAudioEngine for compatible devices, AudioUnit for others)
142 } AkAudioAPI;
143 
144 /// Add this to the idDevice value in AkOutputSettings to start the Motion plug-in in "resident mode".
145 /// "Resident mode" will keep the Motion device active, even during periods of silence.
146 /// This will eliminate a delay when processing some effects, but will increase the power consumption of the device.
147 ///< \sa AK::SoundEngine::AddOutput
148 #define AKMOTION_RESIDENT_MODE (0x80000000)
149 
150 namespace AK
151 {
152  namespace SoundEngine
153  {
154  namespace iOS
155  {
156  /// iOS-only callback function prototype used for audio input source plugin. Implement this function to transfer the
157  /// input sample data to the sound engine and perform brief custom processing. The input data sample rate must be the same as the app's AVAudioSession.
158  /// \remark See the remarks of \ref AkGlobalCallbackFunc.
159  ///
160  /// \sa
161  /// - \ref AkPlatformInitSettings
162  typedef AKRESULT ( * AudioInputCallbackFunc )(
163  const AudioBufferList* io_Data, ///< An exposed CoreAudio structure that holds the input audio samples generated from
164  ///< audio input hardware. The buffer is pre-allocated by the sound engine and the buffer
165  ///< size can be obtained from the structure. Refer to the microphone demo of the IntegrationDemo for an example of usage.
166  void* in_pCookie ///< User-provided data, e.g., a user structure.
167  );
168 
169  /// iOS-only callback function prototype used for handling audio session interruptions.
170  /// Implementing this is optional, but useful for application-specific responses to interruptions. For example, an application can enable or disable certain UI elements when an interruption begins and ends.
171  /// \remark
172  /// - There is no need to call AK::SoundEngine::Suspend() and AK::SoundEngine::WakeupFromSuspend() in this callback. The sound engine call them internally depending on the interruption status.
173  /// - When in_bEnterInterruption is true, this callback is called \a before the sound engine calls AK::SoundEngine::Suspend(), where the user can take actions to prepare for the suspend, e.g., posting global pause events or switching to a special user interface.
174  /// - When in_bEnterInterruption is false, this callback is called \a before the sound engine calls AK::SoundEngine::WakeFromSuspend(). In this callback, the user can restore suspended resources, e.g., post global resume events or switch back to the default user interface.
175  /// - To receive a callback \a after the Sound Engine has woken up from suspend after an interruption, use AK::SoundEngine::RegisterGlobalCallback with the AkGlobalCallbackLocation_WakeupFromSuspend location instead.
176  ///
177  /// \sa
178  /// - \ref AkGlobalCallbackFunc
179  /// - \ref AkPlatformInitSettings
180  /// - \ref AK::SoundEngine::Suspend
181  /// - \ref AK::SoundEngine::WakeupFromSuspend
182  /// - \ref AK::SoundEngine::RegisterGlobalCallback
183  typedef void ( * AudioInterruptionCallbackFunc )(
184  bool in_bEnterInterruption, ///< Indicating whether or not an interruption is about to start (e.g., an incoming
185  ///< call is received) or end (e.g., the incoming call is dismissed).
186 
187  void* in_pCookie ///< User-provided data, e.g., a user structure.
188  );
189 
190  /// Change the category and options of the app's AVAudioSession without restarting the entire Sound Engine.
191  /// \remark
192  /// As per Apple recommendations, the AVAudioSession will be deactivated and then reactivated. Therefore,
193  /// the primary output device must be reinitialized, which causes all audio to stop for a short period of time.
194  /// For a seamless transition, call this API during moments of complete silence in your game.
195  ///
196  /// \sa
197  /// - \ref AkAudioSessionProperties
198  AK_EXTERNAPIFUNC( void, ChangeAudioSessionProperties )(
199  const AkAudioSessionProperties &in_properties ///< New properties to apply to the app's AVAudioSession shared instance.
200  );
201  }
202 
203  /// Get the motion device ID corresponding to a GCController player index. This device ID can be used to add/remove motion output for that gamepad.
204  /// The player index is 0-based, and corresponds to a value of type GCControllerPlayerIndex in the Core.Haptics framework.
205  /// \note The ID returned is unique to Wwise and does not correspond to any sensible value outside of Wwise.
206  /// \return Unique device ID
207  AK_EXTERNAPIFUNC(AkDeviceID, GetDeviceIDFromPlayerIndex) (int playerIndex);
208  }
209 }
210 
211 /// The API structure used for specifying all iOS-specific callback functions and user data from the app side.
212 ///
213 /// \sa
214 /// - \ref AkPlatformInitSettings
215 struct AkAudioCallbacks
216 {
217  AK::SoundEngine::iOS::AudioInputCallbackFunc inputCallback; ///< Application-defined audio input callback function
218  void* inputCallbackCookie; ///< Application-defined user data for the audio input callback function
219  AK::SoundEngine::iOS::AudioInterruptionCallbackFunc interruptionCallback; ///< Application-defined audio interruption callback function
220  void* interruptionCallbackCookie; ///< Application-defined user data for the audio interruption callback function
221 };
222 
223 /// Platform specific initialization settings
224 /// \sa AK::SoundEngine::Init
225 /// \sa AK::SoundEngine::GetDefaultPlatformInitSettings
226 /// - \ref AK::SoundEngine::iOS::AkAudioSessionCategory
227 struct AkPlatformInitSettings
228 {
229  // Threading model.
230  AkThreadProperties threadLEngine; ///< Lower engine threading properties
231  AkThreadProperties threadOutputMgr; ///< Ouput thread threading properties
232  AkThreadProperties threadBankManager; ///< Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL)
233  AkThreadProperties threadMonitor; ///< Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL). This parameter is not used in Release build.
234 
235  AkUInt32 uSampleRate; ///< Sampling Rate. Default 48000 Hz
236  // Voices.
237  AkUInt16 uNumRefillsInVoice; ///< Number of refill buffers in voice buffer. 2 == double-buffered, defaults to 4
238  AkAudioSessionProperties audioSession; ///< iOS audio session properties
239  AkAudioCallbacks audioCallbacks; ///< iOS audio callbacks
240 
241  AkAudioAPI eAudioAPI; ///< Main audio API to use. Leave to AkAPI_Default for the default sink (default value).
242  ///< \ref AkAudioAPI
243 
244  AkUInt32 uNumSpatialAudioPointSources; ///< Number of Apple Spatial Audio point sources to allocate for 3D audio use (each point source is a system audio object). Default: 128
245 
246  bool bVerboseSystemOutput; ///< Print additional debugging information specific to iOS to the system output log.
247 };
248 
249 
250 #endif //_AK_IOS_SOUND_ENGINE_H_
AkAudioAPI
AkAudioAPI
Definition: AkiOSSoundEngine.h:138
AkUInt16
uint16_t AkUInt16
Unsigned 16-bit integer.
Definition: AkNumeralTypes.h:37
AK
Definition of data structures for AkAudioObject.
Definition: AkWwiseSDKVersion.cs:31
AkAudioSessionCategoryOptionMixWithOthers
@ AkAudioSessionCategoryOptionMixWithOthers
Same as AVAudioSessionCategoryOptionMixWithOthers. Only affects PlayAndRecord and Playback categories...
Definition: AkiOSSoundEngine.h:64
AkAudioSessionRouteSharingPolicyLongFormAudio
@ AkAudioSessionRouteSharingPolicyLongFormAudio
Corresponds to AVAudioSessionRouteSharingPolicyLongFormAudio.
Definition: AkiOSSoundEngine.h:93
AkAudioSessionRouteSharingPolicy_Last
@ AkAudioSessionRouteSharingPolicy_Last
End of enum, invalid value.
Definition: AkiOSSoundEngine.h:95
AkPlatformInitSettings::audioSession
AkAudioSessionProperties audioSession
iOS audio session properties
Definition: AkiOSSoundEngine.h:238
AkAudioSessionMode_Last
@ AkAudioSessionMode_Last
End of enum, invalid value.
Definition: AkiOSSoundEngine.h:86
AkAudioSessionCategoryPlayback
@ AkAudioSessionCategoryPlayback
Audio session category corresponding to the AVAudiosession's AVAudioSessionCategoryPlayback constant.
Definition: AkiOSSoundEngine.h:51
AkAudioSessionProperties::eCategoryOptions
AkAudioSessionCategoryOptions eCategoryOptions
Definition: AkiOSSoundEngine.h:126
AkAudioSessionCategory
AkAudioSessionCategory
Definition: AkiOSSoundEngine.h:47
AkAudioSessionMode
AkAudioSessionMode
Definition: AkiOSSoundEngine.h:78
AK::SoundEngine::iOS::ChangeAudioSessionProperties
AKSOUNDENGINE_API void ChangeAudioSessionProperties(const AkAudioSessionProperties &in_properties)
AkAudioCallbacks::inputCallback
AK::SoundEngine::iOS::AudioInputCallbackFunc inputCallback
Application-defined audio input callback function.
Definition: AkiOSSoundEngine.h:217
AK_EXTERNAPIFUNC
#define AK_EXTERNAPIFUNC(_type, _name)
Definition: AkSoundEngineExport.h:81
AkAudioSessionCategoryOptionAllowBluetooth
@ AkAudioSessionCategoryOptionAllowBluetooth
Same as AVAudioSessionCategoryOptionAllowBluetooth. Only affects PlayAndRecord category.
Definition: AkiOSSoundEngine.h:66
AKRESULT
AKRESULT
Standard function call result.
Definition: AkTypes.h:134
AkAudioSessionProperties::eCategory
AkAudioSessionCategory eCategory
Definition: AkiOSSoundEngine.h:125
AkDeviceID
AkUInt32 AkDeviceID
I/O device ID.
Definition: AkTypes.h:78
AK::SoundEngine::iOS::AudioInputCallbackFunc
AKRESULT(* AudioInputCallbackFunc)(const AudioBufferList *io_Data, void *in_pCookie)
Definition: AkiOSSoundEngine.h:162
AkAudioSessionRouteSharingPolicyLongFormVideo
@ AkAudioSessionRouteSharingPolicyLongFormVideo
Corresponds to AVAudioSessionRouteSharingPolicyLongFormVideo.
Definition: AkiOSSoundEngine.h:94
AkAudioCallbacks::interruptionCallback
AK::SoundEngine::iOS::AudioInterruptionCallbackFunc interruptionCallback
Application-defined audio interruption callback function.
Definition: AkiOSSoundEngine.h:219
AkAudioCallbacks::inputCallbackCookie
void * inputCallbackCookie
Application-defined user data for the audio input callback function.
Definition: AkiOSSoundEngine.h:218
AkAudioSessionModeMeasurement
@ AkAudioSessionModeMeasurement
Audio session mode corresponding to the AVAudiosession's AVAudioSessionModeMeasurement constant.
Definition: AkiOSSoundEngine.h:83
AkAudioSessionBehaviorOptions
AkAudioSessionBehaviorOptions
Flags that can modify the default Sound Engine behavior related to the management of the audio sessio...
Definition: AkiOSSoundEngine.h:110
AkPlatformInitSettings::threadMonitor
AkThreadProperties threadMonitor
Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL)....
Definition: AkAndroidSoundEngine.h:61
AkAudioSessionProperties::eRouteSharingPolicy
AkAudioSessionRouteSharingPolicy eRouteSharingPolicy
Definition: AkiOSSoundEngine.h:128
AkPlatformInitSettings::threadLEngine
AkThreadProperties threadLEngine
Lower engine threading properties.
Definition: AkAndroidSoundEngine.h:58
AkAudioSessionModeDefault
@ AkAudioSessionModeDefault
Audio session mode corresponding to the AVAudiosession's AVAudioSessionModeDefault constant.
Definition: AkiOSSoundEngine.h:79
AkAudioAPI_Default
@ AkAudioAPI_Default
Default value, will select the more appropriate API (AVAudioEngine for compatible devices,...
Definition: AkiOSSoundEngine.h:141
AkPlatformInitSettings::uNumRefillsInVoice
AkUInt16 uNumRefillsInVoice
Number of refill buffers in voice buffer. Defaults to 4.
Definition: AkAndroidSoundEngine.h:67
AkAudioSessionRouteSharingPolicyDefault
@ AkAudioSessionRouteSharingPolicyDefault
Corresponds to AVAudioSessionRouteSharingPolicyDefault.
Definition: AkiOSSoundEngine.h:92
AkAudioSessionRouteSharingPolicy
AkAudioSessionRouteSharingPolicy
The IDs of the iOS audio session route sharing policies, which determine which audio routes are permi...
Definition: AkiOSSoundEngine.h:91
AkAudioSessionCategorySoloAmbient
@ AkAudioSessionCategorySoloAmbient
Audio session category corresponding to the AVAudiosession's AVAudioSessionCategorySoloAmbient consta...
Definition: AkiOSSoundEngine.h:49
AkAudioSessionCategory_Last
@ AkAudioSessionCategory_Last
End of enum, invalid value.
Definition: AkiOSSoundEngine.h:52
AK::SoundEngine::iOS::AudioInterruptionCallbackFunc
void(* AudioInterruptionCallbackFunc)(bool in_bEnterInterruption, void *in_pCookie)
Definition: AkiOSSoundEngine.h:183
AkAudioSessionModeVideoChat
@ AkAudioSessionModeVideoChat
Audio session mode corresponding to the AVAudiosession's AVAudioSessionModeMoviePlayback constant.
Definition: AkiOSSoundEngine.h:85
AkAudioSessionCategoryOptions_Last
@ AkAudioSessionCategoryOptions_Last
End of enum, invalid value.
Definition: AkiOSSoundEngine.h:69
AkAudioSessionCategoryAmbient
@ AkAudioSessionCategoryAmbient
Audio session category corresponding to the AVAudiosession's AVAudioSessionCategoryAmbient constant.
Definition: AkiOSSoundEngine.h:48
AkPlatformInitSettings::uNumSpatialAudioPointSources
AkUInt32 uNumSpatialAudioPointSources
Number of Apple Spatial Audio point sources to allocate for 3D audio use (each point source is a syst...
Definition: AkiOSSoundEngine.h:244
AkAudioSessionProperties::eAudioSessionBehavior
AkAudioSessionBehaviorOptions eAudioSessionBehavior
Flags to change the default Sound Engine behavior related to the management of the iOS Audio Session ...
Definition: AkiOSSoundEngine.h:130
AkPlatformInitSettings::threadOutputMgr
AkThreadProperties threadOutputMgr
Ouput thread threading properties.
Definition: AkAndroidSoundEngine.h:59
AkAudioSessionSetActiveOptionNotifyOthersOnDeactivation
@ AkAudioSessionSetActiveOptionNotifyOthersOnDeactivation
Audio session activation option corresponding to the AVAudiosession's AVAudioSessionSetActiveOptionNo...
Definition: AkiOSSoundEngine.h:105
AkPlatformInitSettings::bVerboseSystemOutput
bool bVerboseSystemOutput
Print additional debugging information specific to Emscripten to the browser's console output log.
Definition: AkEmscriptenSoundEngine.h:56
AkAudioSessionCategoryPlayAndRecord
@ AkAudioSessionCategoryPlayAndRecord
Audio session category corresponding to the AVAudiosession's AVAudioSessionCategoryPlayAndRecord cons...
Definition: AkiOSSoundEngine.h:50
AkAudioSessionCategoryOptionDefaultToSpeaker
@ AkAudioSessionCategoryOptionDefaultToSpeaker
Same as AVAudioSessionCategoryOptionDefaultToSpeaker. Only affects PlayAndRecord category.
Definition: AkiOSSoundEngine.h:67
AkAudioSessionProperties::eMode
AkAudioSessionMode eMode
Definition: AkiOSSoundEngine.h:127
AkAudioAPI_AudioUnit
@ AkAudioAPI_AudioUnit
Use AudioUnit framework (basic functionality, compatible with all iOS devices)
Definition: AkiOSSoundEngine.h:140
AkAudioSessionModeVoiceChat
@ AkAudioSessionModeVoiceChat
Audio session mode corresponding to the AVAudiosession's AVAudioSessionModeVoiceChat constant.
Definition: AkiOSSoundEngine.h:80
AkAudioSessionBehaviorSuspendInBackground
@ AkAudioSessionBehaviorSuspendInBackground
By default, the Sound Engine continues to render audio in the background when using PlayAndRecord or ...
Definition: AkiOSSoundEngine.h:111
AkAudioSessionCategoryOptions
AkAudioSessionCategoryOptions
Definition: AkiOSSoundEngine.h:63
AkAudioSessionModeGameChat
@ AkAudioSessionModeGameChat
Audio session mode corresponding to the AVAudiosession's AVAudioSessionModeGameChat constant.
Definition: AkiOSSoundEngine.h:81
AkAudioSessionCategoryOptionAllowBluetoothA2DP
@ AkAudioSessionCategoryOptionAllowBluetoothA2DP
Same as AVAudioSessionCategoryOptionAllowBluetoothA2DP. Only affects PlayAndRecord category.
Definition: AkiOSSoundEngine.h:68
AkAudioSessionSetActiveOptions
AkAudioSessionSetActiveOptions
Definition: AkiOSSoundEngine.h:104
AkAudioCallbacks::interruptionCallbackCookie
void * interruptionCallbackCookie
Application-defined user data for the audio interruption callback function.
Definition: AkiOSSoundEngine.h:220
AkAudioAPI_AVAudioEngine
@ AkAudioAPI_AVAudioEngine
Use AVFoundation framework (modern, has more capabilities, not available for iOS/tvOS 12 or below)
Definition: AkiOSSoundEngine.h:139
AkUInt32
uint32_t AkUInt32
Unsigned 32-bit integer.
Definition: AkNumeralTypes.h:38
AkAudioSessionModeVideoRecording
@ AkAudioSessionModeVideoRecording
Audio session mode corresponding to the AVAudiosession's AVAudioSessionModeVideoRecording constant.
Definition: AkiOSSoundEngine.h:82
AkAudioSessionProperties::eSetActivateOptions
AkAudioSessionSetActiveOptions eSetActivateOptions
Definition: AkiOSSoundEngine.h:129
AkPlatformInitSettings::audioCallbacks
AkAudioCallbacks audioCallbacks
iOS audio callbacks
Definition: AkiOSSoundEngine.h:239
AkPlatformInitSettings::uSampleRate
AkUInt32 uSampleRate
Sampling Rate. Set to 0 to get the native sample rate. Default value is 0.
Definition: AkAndroidSoundEngine.h:66
AK::SoundEngine::GetDeviceIDFromPlayerIndex
AKSOUNDENGINE_API AkDeviceID GetDeviceIDFromPlayerIndex(int playerIndex)
AkAudioSessionCategoryOptionDuckOthers
@ AkAudioSessionCategoryOptionDuckOthers
Same as AVAudioSessionCategoryOptionDuckOthers. Implicitely sets the MixWithOthers option....
Definition: AkiOSSoundEngine.h:65
PlatformID::iOS
AK_ID_DECLARE BasePlatformID iOS
Definition: PlatformID.h:110
AkPlatformInitSettings::threadBankManager
AkThreadProperties threadBankManager
Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL)
Definition: AkAndroidSoundEngine.h:60
AkAudioSessionModeMoviePlayback
@ AkAudioSessionModeMoviePlayback
Audio session mode corresponding to the AVAudiosession's AVAudioSessionModeMoviePlayback constant.
Definition: AkiOSSoundEngine.h:84

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