Version
menu_open
link
Target Platform(s):
Wwise SDK 2023.1.4
AkLinuxSoundEngine.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 // AkLinuxSoundEngine.h
28 
29 /// \file
30 /// Main Sound Engine interface, specific to Linux.
31 
32 #pragma once
33 
36 
37 ///< API used for audio output
38 ///< Use with AkPlatformInitSettings to select the API used for audio output.
39 ///< Use AkAPI_Default, it will select the more appropriate API depending on the computer's capabilities. Other values should be used for testing purposes.
40 ///< \sa AK::SoundEngine::Init
41 typedef enum AkAudioAPILinux
42 {
43  AkAPI_PulseAudio = 1 << 0, ///< Use PulseAudio (this is the preferred API on Linux)
44  AkAPI_ALSA = 1 << 1, ///< Use ALSA
45  AkAPI_Default = AkAPI_PulseAudio | AkAPI_ALSA, ///< Default value, will select the more appropriate API
46 } AkAudioAPI;
47 
48 /// Platform specific initialization settings
49 /// \sa AK::SoundEngine::Init
50 /// \sa AK::SoundEngine::GetDefaultPlatformInitSettings
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  //Voices.
60  AkUInt32 uSampleRate; ///< Sampling Rate. Default 48000 Hz
61  AkUInt16 uNumRefillsInVoice; ///< Number of refill buffers in voice buffer. 2 == double-buffered, defaults to 4.
62  AkAudioAPI eAudioAPI; ///< Main audio API to use. Leave to AkAPI_Default for the default sink (default value).
63  ///< If a valid audioDeviceShareset plug-in is provided, the AkAudioAPI will be Ignored.
64  ///< \ref AkAudioAPI
65  AkDataTypeID sampleType; ///< Sample type. AK_FLOAT for 32 bit float, AK_INT for 16 bit signed integer, defaults to AK_FLOAT.
66  ///< Supported by AkAPI_PulseAudio only.
67 };
uint16_t AkUInt16
Unsigned 16-bit integer.
@ AkAPI_ALSA
Use ALSA.
AkThreadProperties threadMonitor
Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL)....
AkThreadProperties threadLEngine
Lower engine threading properties.
AkUInt16 uNumRefillsInVoice
Number of refill buffers in voice buffer. Defaults to 4.
@ AkAPI_Default
Default value, will select the more appropriate API.
@ AkAPI_PulseAudio
Use PulseAudio (this is the preferred API on Linux)
AkUInt16 AkDataTypeID
Data sample type ID.
Definition: AkTypes.h:69
AkThreadProperties threadOutputMgr
Ouput thread threading properties.
AkAudioAPI
uint32_t AkUInt32
Unsigned 32-bit integer.
AkUInt32 uSampleRate
Sampling Rate. Set to 0 to get the native sample rate. Default value is 0.
AkThreadProperties threadBankManager
Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL)

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