Version
menu_open
Target Platform(s):
Wwise SDK 2023.1.4
AkAndroidSoundEngine.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 // AkAndroidSoundEngine.h
28 
29 /// \file
30 /// Main Sound Engine interface, specific Android.
31 
32 #pragma once
33 
36 #include <SLES/OpenSLES.h>
37 #include "SLES/OpenSLES_Android.h"
38 #include <jni.h>
39 
40 ///< API used for audio output
41 ///< Use with AkPlatformInitSettings to select the API used for audio output.
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.
43 ///< \sa AK::SoundEngine::Init
44 typedef enum AkAudioAPIAndroid
45 {
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)
49 } AkAudioAPI;
50 
51 /// Platform specific initialization settings
52 /// \sa AK::SoundEngine::Init
53 /// \sa AK::SoundEngine::GetDefaultPlatformInitSettings
55 {
56  // Threading model.
57  AkThreadProperties threadLEngine; ///< Lower engine threading properties
58  AkThreadProperties threadOutputMgr; ///< Ouput thread threading properties
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.
61 
62  AkAudioAPI eAudioAPI; ///< Main audio API to use. Leave to AkAPI_Default for the default sink (default value).
63  ///< \ref AkAudioAPI
64 
65  AkUInt32 uSampleRate; ///< Sampling Rate. Set to 0 to get the native sample rate. Default value is 0.
66  AkUInt16 uNumRefillsInVoice; ///< Number of refill buffers in voice buffer. Defaults to 4.
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).
70 
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.
74 
75  bool bVerboseSink; ///< Enable this to inspect sink behavior. Useful for debugging non-standard Android devices.
76  bool bEnableLowLatency; ///< Used the lowest output latency possible for the current hardware.
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.
78  /// If false, the output audio device will be initialized without low-latency operation.
79 };
80 
81 struct AkInitSettings;
82 
83 namespace AK
84 {
85  namespace SoundEngine
86  {
87  /// Get instance of OpenSL created by the sound engine at initialization.
88  /// \return NULL if sound engine is not initialized
90 
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.
93  /// The fast path constraints are:
94  /// -The sample rate must match the hardware native sample rate
95  /// -The number of samples per frame must be a multiple of the hardware buffer size.
96  /// Not fulfilling these constraints makes the audio hardware less efficient.
97  /// In general, using the fast path means a higher CPU usage. Complex audio designs may not be feasible while using the fast path.
99  };
100 };
uint16_t AkUInt16
Unsigned 16-bit integer.
Audiokinetic namespace.
@ AkAudioAPI_AAudio
Use AAudio (lower latency, available only for Android 8.1 or above)
#define AK_EXTERNAPIFUNC(_type, _name)
AKSOUNDENGINE_API SLObjectItf GetWwiseOpenSLInterface()
AKRESULT
Standard function call result.
Definition: AkTypes.h:131
AkThreadProperties threadMonitor
Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL)....
AkThreadProperties threadLEngine
Lower engine threading properties.
@ AkAudioAPI_Default
Default value, will select the more appropriate API (AAudio for compatible devices,...
bool bVerboseSink
Enable this to inspect sink behavior. Useful for debugging non-standard Android devices.
AkUInt16 uNumRefillsInVoice
Number of refill buffers in voice buffer. Defaults to 4.
AkThreadProperties threadOutputMgr
Ouput thread threading properties.
jobject jActivity
android.app.Activity instance for this application. Usually provided through the android_app structur...
SLObjectItf pSLEngine
OpenSL engine reference for sharing between various audio components.
uint32_t AkUInt32
Unsigned 32-bit integer.
AkUInt32 uSampleRate
Sampling Rate. Set to 0 to get the native sample rate. Default value is 0.
AKRESULT GetFastPathSettings(AkInitSettings &in_settings, AkPlatformInitSettings &in_pfSettings)
AkThreadProperties threadBankManager
Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL)
JavaVM * pJavaVM
Active JavaVM for the app, used for internal system calls. Usually provided through the android_app s...
@ AkAudioAPI_OpenSL_ES
Use OpenSL ES (older API, compatible with all Android devices)

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