Wwise SDK
_ak_android_sound_engine_8h_source
Version
menu_open
link
Target Platform(s):
Wwise SDK 2023.1.3
|
AkAndroidSoundEngine.h
Go to the documentation of this file.
42 ///< Use AkAPI_Default, it will select the more appropriate API depending on the computer's capabilities. Other values should be used for testing purposes.
46 AkAudioAPI_AAudio = 1 << 0, ///< Use AAudio (lower latency, available only for Android 8.1 or above)
47 AkAudioAPI_OpenSL_ES = 1 << 1, ///< Use OpenSL ES (older API, compatible with all Android devices)
48 AkAudioAPI_Default = AkAudioAPI_AAudio | AkAudioAPI_OpenSL_ES, ///< Default value, will select the more appropriate API (AAudio for compatible devices, OpenSL for others)
59 AkThreadProperties threadBankManager; ///< Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL)
60 AkThreadProperties threadMonitor; ///< Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL). This parameter is not used in Release build.
62 AkAudioAPI eAudioAPI; ///< Main audio API to use. Leave to AkAPI_Default for the default sink (default value).
65 AkUInt32 uSampleRate; ///< Sampling Rate. Set to 0 to get the native sample rate. Default value is 0.
67 bool bRoundFrameSizeToHWSize;///< Used when hardware-preferred frame size and user-preferred frame size (AkInitSettings.uNumSamplesPerFrame) are not compatible.
68 /// If true (default) the sound engine will initialize to a multiple of the HW setting, close to the user setting.
69 /// If false, the user setting is used as is, regardless of the HW preference (might incur a performance hit).
71 SLObjectItf pSLEngine; ///< OpenSL engine reference for sharing between various audio components.
72 JavaVM* pJavaVM; ///< Active JavaVM for the app, used for internal system calls. Usually provided through the android_app structure given at startup or the NativeActivity. This parameter needs to be set to allow the sound engine initialization.
73 jobject jActivity; ///< android.app.Activity instance for this application. Usually provided through the android_app structure, or through other means if your application has an overridden activity.
75 bool bVerboseSink; ///< Enable this to inspect sink behavior. Useful for debugging non-standard Android devices.
77 /// If true (default), the output audio device will be initialized in low-latency operation, allowing for more responsive audio playback on most devices. However, when operating in low-latency mode, some devices may have differences in audio reproduction.
91 /// Gets specific settings for the fast audio path on Android. Call this function after AK::SoundEngine::GetDefaultSettings and AK::SoundEngine::GetPlatformDefaultSettings to modify settings for the fast path.
92 /// in_pfSettings.pJavaVM and in_pfSettings.jNativeActivity must be filled properly prior to calling GetFastPathSettings.
97 /// In general, using the fast path means a higher CPU usage. Complex audio designs may not be feasible while using the fast path.
98 AKRESULT GetFastPathSettings(AkInitSettings &in_settings, AkPlatformInitSettings &in_pfSettings);
Definition: AkPlatformFuncs.h:47
@ AkAudioAPI_AAudio
Use AAudio (lower latency, available only for Android 8.1 or above)
Definition: AkAndroidSoundEngine.h:46
bool bEnableLowLatency
Definition: AkAndroidSoundEngine.h:76
Definition: AkAndroidSoundEngine.h:55
AKSOUNDENGINE_API SLObjectItf GetWwiseOpenSLInterface()
AkThreadProperties threadMonitor
Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL)....
Definition: AkAndroidSoundEngine.h:60
AkThreadProperties threadLEngine
Lower engine threading properties.
Definition: AkAndroidSoundEngine.h:57
bool bRoundFrameSizeToHWSize
Definition: AkAndroidSoundEngine.h:67
@ AkAudioAPI_Default
Default value, will select the more appropriate API (AAudio for compatible devices,...
Definition: AkAndroidSoundEngine.h:48
bool bVerboseSink
Enable this to inspect sink behavior. Useful for debugging non-standard Android devices.
Definition: AkAndroidSoundEngine.h:75
AkUInt16 uNumRefillsInVoice
Number of refill buffers in voice buffer. Defaults to 4.
Definition: AkAndroidSoundEngine.h:66
AkThreadProperties threadOutputMgr
Ouput thread threading properties.
Definition: AkAndroidSoundEngine.h:58
jobject jActivity
android.app.Activity instance for this application. Usually provided through the android_app structur...
Definition: AkAndroidSoundEngine.h:73
SLObjectItf pSLEngine
OpenSL engine reference for sharing between various audio components.
Definition: AkAndroidSoundEngine.h:71
Definition: AkSoundEngine.h:215
AkUInt32 uSampleRate
Sampling Rate. Set to 0 to get the native sample rate. Default value is 0.
Definition: AkAndroidSoundEngine.h:65
AKRESULT GetFastPathSettings(AkInitSettings &in_settings, AkPlatformInitSettings &in_pfSettings)
AkThreadProperties threadBankManager
Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL)
Definition: AkAndroidSoundEngine.h:59
JavaVM * pJavaVM
Active JavaVM for the app, used for internal system calls. Usually provided through the android_app s...
Definition: AkAndroidSoundEngine.h:72
@ AkAudioAPI_OpenSL_ES
Use OpenSL ES (older API, compatible with all Android devices)
Definition: AkAndroidSoundEngine.h:47
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell 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