_ak_android_sound_engine_8h

Warning: you were redirected to the latest documentation corresponding to your major release ( 2024.1.1.8691 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.

Target Platform(s):

Wwise SDK 2024.1.1

Go to the documentation of this file.

 /*******************************************************************************
 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
 released in source code form as part of the SDK installer package.
  
 Commercial License Usage
  
 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
 may use this file in accordance with the end user license agreement provided 
 with the software or, alternatively, in accordance with the terms contained in a
 written agreement between you and Audiokinetic Inc.
  
 Apache License Usage
  
 Alternatively, this file may be used under the Apache License, Version 2.0 (the 
 "Apache License"); you may not use this file except in compliance with the 
 Apache License. You may obtain a copy of the Apache License at 
 http://www.apache.org/licenses/LICENSE-2.0.
  
 Unless required by applicable law or agreed to in writing, software distributed
 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
 the specific language governing permissions and limitations under the License.
  
   Copyright (c) 2024 Audiokinetic Inc.
 *******************************************************************************/
  
 // AkAndroidSoundEngine.h
  
 /// \file 
 /// Main Sound Engine interface, specific Android.
  
 #pragma once
  
 #include <AK/SoundEngine/Common/AkTypes.h>
 #include <AK/Tools/Common/AkPlatformFuncs.h>
 #include <SLES/OpenSLES.h>
 #include "SLES/OpenSLES_Android.h"
 #include <jni.h>
  
 ///< API used for audio output
 ///< Use with AkPlatformInitSettings to select the API used for audio output.  
 ///< Use AkAPI_Default, it will select the more appropriate API depending on the computer's capabilities.  Other values should be used for testing purposes.
 ///< \sa AK::SoundEngine::Init
 typedef enum AkAudioAPIAndroid
 {
     AkAudioAPI_AAudio    = 1 << 0,                                 ///< Use AAudio (lower latency, available only for Android 8.1 or above) 
     AkAudioAPI_OpenSL_ES = 1 << 1,                                 ///< Use OpenSL ES (older API, compatible with all Android devices)
     AkAudioAPI_Last,                                               ///< End of enum, invalid value.
     AkAudioAPI_Default = AkAudioAPI_AAudio | AkAudioAPI_OpenSL_ES, ///< Default value, will select the more appropriate API (AAudio for compatible devices, OpenSL for others)  
 } AkAudioAPI;
  
 /// Platform specific initialization settings
 /// \sa AK::SoundEngine::Init
 /// \sa AK::SoundEngine::GetDefaultPlatformInitSettings
 struct AkPlatformInitSettings
 {
     // Threading model.
     AkThreadProperties  threadLEngine;          ///< Lower engine threading properties
     AkThreadProperties  threadOutputMgr;        ///< Ouput thread threading properties
     AkThreadProperties  threadBankManager;      ///< Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL)
     AkThreadProperties  threadMonitor;          ///< Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL). This parameter is not used in Release build.    
  
     AkAudioAPI          eAudioAPI;  ///< Main audio API to use. Leave to AkAPI_Default for the default sink (default value).
                                     ///< \ref AkAudioAPI
  
     AkUInt32            uSampleRate;            ///< Sampling Rate.  Set to 0 to get the native sample rate.  Default value is 0.
     AkUInt16            uNumRefillsInVoice;     ///< Number of refill buffers in voice buffer.  Defaults to 4.  
     bool                bRoundFrameSizeToHWSize;///< (deprecated) Rounds the pipeline buffer size to a multiple of the hardware-preferred frame size.
                                                 /// This setting is deprecated. This has no impact on performance and should be left to false (the default).
                                                 /// The fast audio path can still be selected when this is false.
  
     SLObjectItf         pSLEngine;              ///< OpenSL engine reference for sharing between various audio components.
     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.
     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.
  
     bool                bVerboseSink;           ///< Enable this to inspect sink behavior. Useful for debugging non-standard Android devices.
     bool                bEnableLowLatency;      ///< Used the lowest output latency possible for the current hardware.
                                                 /// 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.
                                                 /// If false, the output audio device will be initialized without low-latency operation.
 };
  
 struct AkInitSettings;
  
 namespace AK
 {
     namespace SoundEngine
     {
         /// Get instance of OpenSL created by the sound engine at initialization.
         /// \return NULL if sound engine is not initialized
         AK_EXTERNAPIFUNC( SLObjectItf, GetWwiseOpenSLInterface )();
  
         /// 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.
         /// in_pfSettings.pJavaVM and in_pfSettings.jNativeActivity must be filled properly prior to calling GetFastPathSettings.
         /// The fast path constraints are:
         /// -The sample rate must match the hardware native sample rate 
         /// -The number of samples per frame must be a multiple of the hardware buffer size.
         /// Not fulfilling these constraints makes the audio hardware less efficient.
         /// In general, using the fast path means a higher CPU usage.  Complex audio designs may not be feasible while using the fast path.
         AKRESULT GetFastPathSettings(AkInitSettings &in_settings, AkPlatformInitSettings &in_pfSettings);
     };
 };