Table of Contents

Wwise SDK 2019.1.5
AkGGPSoundEngine.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  Version: <VERSION> Build: <BUILDNUMBER>
25  Copyright (c) <COPYRIGHTYEAR> Audiokinetic Inc.
26 *******************************************************************************/
27 
28 /// \file
29 /// Main Sound Engine interface, specific to Linux.
30 
31 #pragma once
32 
35 
36 ///< API used for audio output
37 ///< Use with AkPlatformInitSettings to select the API used for audio output.
38 ///< Use AkAPI_Default, it will select the more appropriate API depending on the computer's capabilities. Other values should be used for testing purposes.
39 ///< \sa AK::SoundEngine::Init
41 {
42  AkAPI_PulseAudio = 1 << 0, ///< Use PulseAudio (this is the preferred API on Linux)
43  AkAPI_ALSA = 1 << 1, ///< Use ALSA
44  AkAPI_Default = AkAPI_PulseAudio | AkAPI_ALSA, ///< Default value, will select the more appropriate API
45 };
46 
47 /// Platform specific initialization settings
48 /// \sa AK::SoundEngine::Init
49 /// \sa AK::SoundEngine::GetDefaultPlatformInitSettings
50 /// - \ref soundengine_initialization_advanced_soundengine_using_memory_threshold
52 {
53  // Threading model.
54  AkThreadProperties threadLEngine; ///< Lower engine threading properties
55  AkThreadProperties threadOutputMgr; ///< Ouput thread threading properties
56  AkThreadProperties threadBankManager; ///< Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL)
57  AkThreadProperties threadMonitor; ///< Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL). This parameter is not used in Release build.
58 
59  // Memory.
60  AkReal32 fLEngineDefaultPoolRatioThreshold; ///< 0.0f to 1.0f value: The percentage of occupied memory where the sound engine should enter in Low memory mode. \ref soundengine_initialization_advanced_soundengine_using_memory_threshold
61  AkUInt32 uLEngineDefaultPoolSize;///< Lower Engine default memory pool size
62 
63  //Voices.
64  AkUInt32 uSampleRate; ///< Sampling Rate. Default 48000 Hz
65  AkUInt16 uNumRefillsInVoice; ///< Number of refill buffers in voice buffer. 2 == double-buffered, defaults to 4.
66  AkAudioAPI eAudioAPI; ///< Main audio API to use. Leave to AkAPI_Default for the default sink (default value).
67  ///< If a valid audioDeviceShareset plug-in is provided, the AkAudioAPI will be Ignored.
68  ///< \ref AkAudioAPI
69 };
70 
71 #include <ggp/ggp.h>
72 
73 namespace AK
74 {
75  namespace SoundEngine
76  {
77  /// Finds the device ID for a particular ggp keyboard struct.
78  /// \return The device ID.
79  AK_EXTERNAPIFUNC( AkUInt32, GetDeviceID ) (const ggp::Keyboard& in_keyboard);
80 
81  /// Finds the device ID for a particular ggp gamepad struct.
82  /// \return The device ID.
83  AK_EXTERNAPIFUNC( AkUInt32, GetDeviceID ) (const ggp::Gamepad& in_gamepad);
84  }
85 }
AkThreadProperties threadBankManager
Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL)
AkUInt32 uSampleRate
Sampling Rate. Set to 0 to get the native sample rate. Default value is 0.
uint16_t AkUInt16
Unsigned 16-bit integer.
Definition: AkTypes.h:77
Use PulseAudio (this is the preferred API on Linux)
Definition: AkGGPSoundEngine.h:42
AkThreadProperties threadLEngine
Lower engine threading properties.
Use ALSA.
Definition: AkGGPSoundEngine.h:43
Audiokinetic namespace.
#define AK_EXTERNAPIFUNC(__TYPE__, __NAME__)
AkUInt32 uLEngineDefaultPoolSize
Lower Engine default memory pool size.
AkAudioAPI
Definition: AkWinSoundEngine.h:43
Default value, will select the more appropriate API.
Definition: AkGGPSoundEngine.h:44
AkReal32 fLEngineDefaultPoolRatioThreshold
0.0f to 1.0f value: The percentage of occupied memory where the sound engine should enter in Low memo...
AkUInt32 __cdecl GetDeviceID(const ggp::Keyboard &in_keyboard)
AkAudioAPI eAudioAPI
Definition: AkWinSoundEngine.h:94
AkUInt16 uNumRefillsInVoice
Number of refill buffers in voice buffer. Defaults to 4.
AkThreadProperties threadOutputMgr
Ouput thread threading properties.
AkThreadProperties threadMonitor
Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL)....
uint32_t AkUInt32
Unsigned 32-bit integer.
Definition: AkTypes.h:78
float AkReal32
32-bit floating point
Definition: AkTypes.h:96