Version
menu_open
link
Wwise SDK 2022.1.8
AkTypes.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) 2023 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 // AkTypes.h
28 
29 /// \file
30 /// Data type definitions.
31 
32 #ifndef _AK_DATA_TYPES_H_
33 #define _AK_DATA_TYPES_H_
34 
35 // Platform-specific section.
36 //----------------------------------------------------------------------------------------------------
37 #include <AK/AkPlatforms.h>
38 
39 
40 //----------------------------------------------------------------------------------------------------
41 
42 #include <AK/SoundEngine/Common/AkSoundEngineExport.h>
43 
44 #ifndef NULL
45  #ifdef __cplusplus
46  #define NULL 0
47  #else
48  #define NULL ((void *)0)
49  #endif
50 #endif
51 
52 
53 #ifndef AK_ALIGN
54 #if defined(SWIG)
55 #define AK_ALIGN( _declaration_, _alignment_ ) _declaration_
56 #else
57 #if defined(_MSC_VER)
58 #define AK_ALIGN( _declaration_, _alignment_ ) __declspec( align( _alignment_ ) ) _declaration_
59 #else
60 #define AK_ALIGN( _declaration_, _alignment_ ) _declaration_ __attribute__( ( aligned( _alignment_ ) ) )
61 #endif // _MSC_VER
62 #endif // SWIG
63 #endif // AK_ALIGN
64 
65 #if !defined(AK_ENDIANNESS_LITTLE) && !defined(AK_ENDIANNESS_BIG)
66 #define AK_ENDIANNESS_LITTLE
67 #endif
68 
69 ///< AK_UNALIGNED refers to the __unaligned compilation flag available on some platforms. Note that so far, on the tested platform this should always be placed before the pointer symbol *.
70 #ifndef AK_UNALIGNED
71 #if defined(__GNUC__)
72 #define AK_UNALIGNED __attribute__((aligned(1)))
73 #elif defined(_MSC_VER) && !defined(AK_CPU_X86) // __unaligned not supported on 32-bit x86
74 #define AK_UNALIGNED __unaligned
75 #else
76 #define AK_UNALIGNED
77 #endif
78 #endif // AK_UNALIGNED
79 
80 #if (defined(__cplusplus) && __cplusplus >= 201103L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 201103L)
81 #define AK_CPP11
82 #endif
83 
84 #if (defined(__cplusplus) && __cplusplus >= 201402L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 201402L)
85 #define AK_CPP14
86 #endif
87 
88 #if (defined(__cplusplus) && __cplusplus >= 201703L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 201703L)
89 #define AK_CPP17
90 #endif
91 
92 #if defined(AK_CPP11)
93 #define AK_FINAL final ///< Refers to the C++11 final keyword
94 #else
95 #define AK_FINAL
96 #endif
97 
98 #if defined(AK_CPP17)
99 #define AK_NODISCARD [[nodiscard]] ///< Refers to the C++17 [[nodiscard]] keyword
100 #else
101 #define AK_NODISCARD
102 #endif
103 
104 
105 #if defined(AK_CPU_X86_64) || defined(AK_CPU_ARM_64)
106 #define AK_POINTER_64
107 #endif // #if defined(AK_CPU_X86_64) || defined(AK_CPU_ARM_64)
108 
109 #if !defined(AK_UNUSEDVAR)
110 // use to mark variables as unused to avoid warnings
111 #define AK_UNUSEDVAR(x) ((void)(x))
112 #endif
113 
114 #if defined(AK_SUPPORT_THREADS)
115 #define AK_THREAD_LOCAL thread_local
116 #else
117 #define AK_THREAD_LOCAL
118 #endif
119 
120 typedef AkUInt32 AkUniqueID; ///< Unique 32-bit ID
121 typedef AkUInt32 AkStateID; ///< State ID
122 typedef AkUInt32 AkStateGroupID; ///< State group ID
123 typedef AkUInt32 AkPlayingID; ///< Playing ID
124 typedef AkInt32 AkTimeMs; ///< Time in ms
125 typedef AkUInt16 AkPortNumber; ///< Port number
126 typedef AkReal32 AkPitchValue; ///< Pitch value
127 typedef AkReal32 AkVolumeValue; ///< Volume value( also apply to LFE )
128 typedef AkUInt64 AkGameObjectID; ///< Game object ID
129 typedef AkReal32 AkLPFType; ///< Low-pass filter type
130 typedef AkInt32 AkMemPoolId; ///< Memory pool ID
131 typedef AkUInt32 AkPluginID; ///< Source or effect plug-in ID
132 typedef AkUInt32 AkCodecID; ///< Codec plug-in ID
133 typedef AkUInt32 AkAuxBusID; ///< Auxilliary bus ID
134 typedef AkInt16 AkPluginParamID; ///< Source or effect plug-in parameter ID
135 typedef AkInt8 AkPriority; ///< Priority
136 typedef AkUInt16 AkDataCompID; ///< Data compression format ID
137 typedef AkUInt16 AkDataTypeID; ///< Data sample type ID
138 typedef AkUInt8 AkDataInterleaveID; ///< Data interleaved state ID
139 typedef AkUInt32 AkSwitchGroupID; ///< Switch group ID
140 typedef AkUInt32 AkSwitchStateID; ///< Switch ID
141 typedef AkUInt32 AkRtpcID; ///< Real time parameter control ID
142 typedef AkReal32 AkRtpcValue; ///< Real time parameter control value
143 typedef AkUInt32 AkBankID; ///< Run time bank ID
144 typedef AkUInt32 AkBankType; ///< Run time bank type
145 typedef AkUInt32 AkFileID; ///< Integer-type file identifier
146 typedef AkUInt32 AkDeviceID; ///< I/O device ID
147 typedef AkUInt32 AkTriggerID; ///< Trigger ID
148 typedef AkUInt32 AkArgumentValueID; ///< Argument value ID
149 typedef AkUInt32 AkChannelMask; ///< Channel mask (similar to WAVE_FORMAT_EXTENSIBLE). Bit values are defined in AkSpeakerConfig.h.
150 typedef AkUInt32 AkModulatorID; ///< Modulator ID
151 typedef AkUInt32 AkAcousticTextureID; ///< Acoustic Texture ID
152 typedef AkUInt32 AkImageSourceID; ///< Image Source ID
153 typedef AkUInt64 AkOutputDeviceID; ///< Audio Output device ID
154 typedef AkUInt32 AkPipelineID; ///< Unique node (bus, voice) identifier for profiling.
155 typedef AkUInt32 AkRayID; ///< Unique (per emitter) identifier for an emitter-listener ray.
156 typedef AkUInt64 AkAudioObjectID; ///< Audio Object ID
157 typedef AkUInt32 AkJobType; ///< Job type identifier
158 
159 // Constants.
160 static const AkPluginID AK_INVALID_PLUGINID = (AkPluginID)-1; ///< Invalid FX ID
161 static const AkPluginID AK_INVALID_SHARE_SET_ID = (AkPluginID)-1; ///< Invalid Share Set ID
162 static const AkGameObjectID AK_INVALID_GAME_OBJECT = (AkGameObjectID)-1; ///< Invalid game object (may also mean all game objects)
163 static const AkUniqueID AK_INVALID_UNIQUE_ID = 0; ///< Invalid unique 32-bit ID
164 static const AkRtpcID AK_INVALID_RTPC_ID = AK_INVALID_UNIQUE_ID;///< Invalid RTPC ID
165 static const AkPlayingID AK_INVALID_PLAYING_ID = AK_INVALID_UNIQUE_ID;///< Invalid playing ID
166 static const AkUInt32 AK_DEFAULT_SWITCH_STATE = 0; ///< Switch selected if no switch has been set yet
167 static const AkMemPoolId AK_INVALID_POOL_ID = -1; ///< Invalid pool ID
168 static const AkMemPoolId AK_DEFAULT_POOL_ID = -1; ///< Default pool ID, same as AK_INVALID_POOL_ID
169 static const AkAuxBusID AK_INVALID_AUX_ID = AK_INVALID_UNIQUE_ID;///< Invalid auxiliary bus ID (or no Aux bus ID)
170 static const AkFileID AK_INVALID_FILE_ID = (AkFileID)-1; ///< Invalid file ID
171 static const AkDeviceID AK_INVALID_DEVICE_ID = (AkDeviceID)-1; ///< Invalid streaming device ID
172 static const AkBankID AK_INVALID_BANK_ID = AK_INVALID_UNIQUE_ID;///< Invalid bank ID
173 static const AkArgumentValueID AK_FALLBACK_ARGUMENTVALUE_ID = 0; ///< Fallback argument value ID
174 static const AkChannelMask AK_INVALID_CHANNELMASK = 0; ///< Invalid channel mask
175 static const AkUInt32 AK_INVALID_OUTPUT_DEVICE_ID = AK_INVALID_UNIQUE_ID;///< Invalid Device ID
176 static const AkPipelineID AK_INVALID_PIPELINE_ID = AK_INVALID_UNIQUE_ID;///< Invalid pipeline ID (for profiling)
177 static const AkAudioObjectID AK_INVALID_AUDIO_OBJECT_ID = (AkAudioObjectID)-1; ///< Invalid audio object ID
178 
179 // Priority.
180 static const AkPriority AK_DEFAULT_PRIORITY = 50; ///< Default sound / I/O priority
181 static const AkPriority AK_MIN_PRIORITY = 0; ///< Minimal priority value [0,100]
182 static const AkPriority AK_MAX_PRIORITY = 100; ///< Maximal priority value [0,100]
183 
184 // Default bank I/O settings.
185 static const AkPriority AK_DEFAULT_BANK_IO_PRIORITY = AK_DEFAULT_PRIORITY; ///< Default bank load I/O priority
186 static const AkReal32 AK_DEFAULT_BANK_THROUGHPUT = 1*1024*1024/1000.f; ///< Default bank load throughput (1 Mb/ms)
187 
188 // Bank version
189 static const AkUInt32 AK_SOUNDBANK_VERSION = 145; ///< Version of the soundbank reader
190 
191 // Job types
192 static const AkJobType AkJobType_Generic = 0; ///< Job type for general-purpose work
193 static const AkJobType AkJobType_AudioProcessing = 1; ///< Job type for DSP work
194 static const AkJobType AkJobType_SpatialAudio = 2; ///< Job type for Spatial Audio computations
195 static const AkUInt32 AK_NUM_JOB_TYPES = 3; ///< Number of possible job types recognized by the Sound Engine
196 
197 /// Standard function call result.
198 enum AKRESULT
199 {
200  AK_NotImplemented = 0, ///< This feature is not implemented.
201  AK_Success = 1, ///< The operation was successful.
202  AK_Fail = 2, ///< The operation failed.
203  AK_PartialSuccess = 3, ///< The operation succeeded partially.
204  AK_NotCompatible = 4, ///< Incompatible formats
205  AK_AlreadyConnected = 5, ///< The stream is already connected to another node.
206  AK_InvalidFile = 7, ///< The provided file is the wrong format or unexpected values causes the file to be invalid.
207  AK_AudioFileHeaderTooLarge = 8, ///< The file header is too large.
208  AK_MaxReached = 9, ///< The maximum was reached.
209  AK_InvalidID = 14, ///< The ID is invalid.
210  AK_IDNotFound = 15, ///< The ID was not found.
211  AK_InvalidInstanceID = 16, ///< The InstanceID is invalid.
212  AK_NoMoreData = 17, ///< No more data is available from the source.
213  AK_InvalidStateGroup = 20, ///< The StateGroup is not a valid channel.
214  AK_ChildAlreadyHasAParent = 21, ///< The child already has a parent.
215  AK_InvalidLanguage = 22, ///< The language is invalid (applies to the Low-Level I/O).
216  AK_CannotAddItseflAsAChild = 23, ///< It is not possible to add itself as its own child.
217  AK_InvalidParameter = 31, ///< Something is not within bounds, check the documentation of the function returning this code.
218  AK_ElementAlreadyInList = 35, ///< The item could not be added because it was already in the list.
219  AK_PathNotFound = 36, ///< This path is not known.
220  AK_PathNoVertices = 37, ///< Stuff in vertices before trying to start it
221  AK_PathNotRunning = 38, ///< Only a running path can be paused.
222  AK_PathNotPaused = 39, ///< Only a paused path can be resumed.
223  AK_PathNodeAlreadyInList = 40, ///< This path is already there.
224  AK_PathNodeNotInList = 41, ///< This path is not there.
225  AK_DataNeeded = 43, ///< The consumer needs more.
226  AK_NoDataNeeded = 44, ///< The consumer does not need more.
227  AK_DataReady = 45, ///< The provider has available data.
228  AK_NoDataReady = 46, ///< The provider does not have available data.
229  AK_InsufficientMemory = 52, ///< Memory error.
230  AK_Cancelled = 53, ///< The requested action was cancelled (not an error).
231  AK_UnknownBankID = 54, ///< Trying to load a bank using an ID which is not defined.
232  AK_BankReadError = 56, ///< Error while reading a bank.
233  AK_InvalidSwitchType = 57, ///< Invalid switch type (used with the switch container)
234  AK_FormatNotReady = 63, ///< Source format not known yet.
235  AK_WrongBankVersion = 64, ///< The bank version is not compatible with the current bank reader.
236  AK_FileNotFound = 66, ///< File not found.
237  AK_DeviceNotReady = 67, ///< Specified ID doesn't match a valid hardware device: either the device doesn't exist or is disabled.
238  AK_BankAlreadyLoaded = 69, ///< The bank load failed because the bank is already loaded.
239  AK_RenderedFX = 71, ///< The effect on the node is rendered.
240  AK_ProcessNeeded = 72, ///< A routine needs to be executed on some CPU.
241  AK_ProcessDone = 73, ///< The executed routine has finished its execution.
242  AK_MemManagerNotInitialized = 74, ///< The memory manager should have been initialized at this point.
243  AK_StreamMgrNotInitialized = 75, ///< The stream manager should have been initialized at this point.
244  AK_SSEInstructionsNotSupported = 76,///< The machine does not support SSE instructions (required on PC).
245  AK_Busy = 77, ///< The system is busy and could not process the request.
246  AK_UnsupportedChannelConfig = 78, ///< Channel configuration is not supported in the current execution context.
247  AK_PluginMediaNotAvailable = 79, ///< Plugin media is not available for effect.
248  AK_MustBeVirtualized = 80, ///< Sound was Not Allowed to play.
249  AK_CommandTooLarge = 81, ///< SDK command is too large to fit in the command queue.
250  AK_RejectedByFilter = 82, ///< A play request was rejected due to the MIDI filter parameters.
251  AK_InvalidCustomPlatformName= 83, ///< Detecting incompatibility between Custom platform of banks and custom platform of connected application
252  AK_DLLCannotLoad = 84, ///< Plugin DLL could not be loaded, either because it is not found or one dependency is missing.
253  AK_DLLPathNotFound = 85, ///< Plugin DLL search path could not be found.
254  AK_NoJavaVM = 86, ///< No Java VM provided in AkInitSettings.
255  AK_OpenSLError = 87, ///< OpenSL returned an error. Check error log for more details.
256  AK_PluginNotRegistered = 88, ///< Plugin is not registered. Make sure to implement a AK::PluginRegistration class for it and use AK_STATIC_LINK_PLUGIN in the game binary.
257  AK_DataAlignmentError = 89, ///< A pointer to audio data was not aligned to the platform's required alignment (check AkTypes.h in the platform-specific folder)
258  AK_DeviceNotCompatible = 90, ///< Incompatible Audio device.
259  AK_DuplicateUniqueID = 91, ///< Two Wwise objects share the same ID.
260  AK_InitBankNotLoaded = 92, ///< The Init bank was not loaded yet, the sound engine isn't completely ready yet.
261  AK_DeviceNotFound = 93, ///< The specified device ID does not match with any of the output devices that the sound engine is currently using.
262  AK_PlayingIDNotFound = 94, ///< Calling a function with a playing ID that is not known.
263  AK_InvalidFloatValue = 95, ///< One parameter has a invalid float value such as NaN, INF or FLT_MAX.
264  AK_FileFormatMismatch = 96, ///< Media file format unexpected
265  AK_NoDistinctListener = 97, ///< No distinct listener provided for AddOutput
266  AK_ACP_Error = 98, ///< Generic XMA decoder error.
267  AK_ResourceInUse = 99, ///< Resource is in use and cannot be released.
268  AK_InvalidBankType = 100, ///< Invalid bank type. The bank type was either supplied through a function call (e.g. LoadBank) or obtained from a bank loaded from memory.
269  AK_AlreadyInitialized = 101, ///< Init() was called but that element was already initialized.
270  AK_NotInitialized = 102, ///< The component being used is not initialized. Most likely AK::SoundEngine::Init() was not called yet, or AK::SoundEngine::Term was called too early.
271  AK_FilePermissionError = 103, ///< The file access permissions prevent opening a file.
272  AK_UnknownFileError = 104, ///< Rare file error occured, as opposed to AK_FileNotFound or AK_FilePermissionError. This lumps all unrecognized OS file system errors.
273 };
274 
275 /// Game sync group type
276 enum AkGroupType
277 {
278  // should stay set as Switch = 0 and State = 1
279  AkGroupType_Switch = 0, ///< Type switch
280  AkGroupType_State = 1 ///< Type state
281 };
282 
283 /// Configured audio settings
284 struct AkAudioSettings
285 {
286  AkUInt32 uNumSamplesPerFrame; ///< Number of samples per audio frame (256, 512, 1024 or 2048).
287  AkUInt32 uNumSamplesPerSecond; ///< Number of samples per second.
288 };
289 
290 enum AkAudioDeviceState
291 {
292  AkDeviceState_Unknown = 0, ///< The audio device state is unknown or invalid.
293  AkDeviceState_Active = 1 << 0, ///< The audio device is active That is, the audio adapter that connects to the endpoint device is present and enabled.
294  AkDeviceState_Disabled = 1 << 1, ///< The audio device is disabled.
295  AkDeviceState_NotPresent = 1 << 2, ///< The audio device is not present because the audio adapter that connects to the endpoint device has been removed from the system.
296  AkDeviceState_Unplugged = 1 << 3, ///< The audio device is unplugged.
297  AkDeviceState_All = AkDeviceState_Active | AkDeviceState_Disabled | AkDeviceState_NotPresent | AkDeviceState_Unplugged, ///< Includes audio devices in all states.
298 };
299 
300 struct AkDeviceDescription
301 {
302  AkUInt32 idDevice; ///< Device ID for Wwise. This is the same as what is returned from AK::GetDeviceID and AK::GetDeviceIDFromName. Use it to specify the main device in AkPlatformInitSettings.idAudioDevice or in AK::SoundEngine::AddSecondaryOutput.
303  AkOSChar deviceName[AK_MAX_PATH]; ///< The user-friendly name for the device.
304  AkAudioDeviceState deviceStateMask = AkDeviceState_Unknown; ///< Bitmask used to filter the device based on their state.
305  bool isDefaultDevice = false; ///< Identify default device. Always false when not supported.
306 };
307 
308 /// This structure allows the game to provide audio files to fill the external sources. See \ref AK::SoundEngine::PostEvent
309 /// You can specify a streaming file or a file in-memory, regardless of the "Stream" option in the Wwise project.
310 /// The only file format accepted is a fully formed WEM file, as converted by Wwise.
311 /// \akwarning
312 /// Make sure that only one of szFile, pInMemory or idFile is non-null. if both idFile and szFile are set, idFile is passed to low-level IO and szFile is used as stream name (for profiling purposes).
313 /// \endakwarning
314 /// \akwarning
315 /// When using the in-memory file (pInMemory & uiMemorySize), it is the responsibility of the game to ensure the memory stays valid for the entire duration of the playback.
316 /// You can achieve this by using the AK_EndOfEvent callback to track when the Event ends.
317 /// \endakwarning
318 /// \sa
319 /// - AK::SoundEngine::PostEvent
320 struct AkExternalSourceInfo
321 {
322  AkUInt32 iExternalSrcCookie; ///< Cookie identifying the source, given by hashing the name of the source given in the project. See \ref AK::SoundEngine::GetIDFromString. \aknote If an event triggers the playback of more than one external source, they must be named uniquely in the project therefore have a unique cookie) in order to tell them apart when filling the AkExternalSourceInfo structures. \endaknote
323  AkCodecID idCodec; ///< Codec ID for the file. One of the audio formats defined in AkTypes.h (AKCODECID_XXX)
324  AkOSChar * szFile; ///< File path for the source. If not NULL, the source will be streaming from disk. Set pInMemory to NULL. If idFile is set, this field is used as stream name (for profiling purposes). /// The only file format accepted is a fully formed WEM file, as converted by Wwise.
325  void* pInMemory; ///< Pointer to the in-memory file. If not NULL, the source will be read from memory. Set szFile and idFile to NULL. The only file format accepted is a fully formed WEM file, as converted by Wwise.
326  AkUInt32 uiMemorySize; ///< Size of the data pointed by pInMemory
327  AkFileID idFile; ///< File ID. If not zero, the source will be streaming from disk. This ID can be anything. Note that you must override the low-level IO to resolve this ID to a real file. See \ref streamingmanager_lowlevel for more information on overriding the Low Level IO.
328 
329  /// Default constructor.
330  AkExternalSourceInfo()
331  : iExternalSrcCookie( 0 )
332  , idCodec( 0 )
333  , szFile( 0 )
334  , pInMemory( 0 )
335  , uiMemorySize( 0 )
336  , idFile( 0 ) {}
337 
338  /// Constructor: specify source by memory.
339  AkExternalSourceInfo(
340  void* in_pInMemory, ///< Pointer to the in-memory file.
341  AkUInt32 in_uiMemorySize, ///< Size of data.
342  AkUInt32 in_iExternalSrcCookie, ///< Cookie.
343  AkCodecID in_idCodec ///< Codec ID.
344  )
345  : iExternalSrcCookie( in_iExternalSrcCookie )
346  , idCodec( in_idCodec )
347  , szFile( 0 )
348  , pInMemory( in_pInMemory )
349  , uiMemorySize( in_uiMemorySize )
350  , idFile( 0 ) {}
351 
352  /// Constructor: specify source by streaming file name.
353  AkExternalSourceInfo(
354  AkOSChar * in_pszFileName, ///< File name.
355  AkUInt32 in_iExternalSrcCookie, ///< Cookie.
356  AkCodecID in_idCodec ///< Codec ID.
357  )
358  : iExternalSrcCookie( in_iExternalSrcCookie )
359  , idCodec( in_idCodec )
360  , szFile( in_pszFileName )
361  , pInMemory( 0 )
362  , uiMemorySize( 0 )
363  , idFile( 0 ) {}
364 
365  /// Constructor: specify source by streaming file ID.
366  AkExternalSourceInfo(
367  AkFileID in_idFile, ///< File ID.
368  AkUInt32 in_iExternalSrcCookie, ///< Cookie.
369  AkCodecID in_idCodec ///< Codec ID.
370  )
371  : iExternalSrcCookie( in_iExternalSrcCookie )
372  , idCodec( in_idCodec )
373  , szFile( 0 )
374  , pInMemory( 0 )
375  , uiMemorySize( 0 )
376  , idFile( in_idFile ) {}
377 };
378 
379 /// Nature of the connection binding an input to a bus.
380 enum AkConnectionType
381 {
382  ConnectionType_Direct = 0x0, ///< Direct (main, dry) connection.
383  ConnectionType_GameDefSend = 0x1, ///< Connection by a game-defined send.
384  ConnectionType_UserDefSend = 0x2, ///< Connection by a user-defined send.
385  ConnectionType_ReflectionsSend = 0x3, ///< Connection by a early reflections send.
386 };
387 
388 /// 3D 64-bit vector. Intended as storage for world positions of sounds and objects, benefiting from 64-bit precision range
389 struct AkVector64
390 {
391  inline AkVector64 operator+(const AkVector64& b) const
392  {
393  AkVector64 v;
394 
395  v.X = X + b.X;
396  v.Y = Y + b.Y;
397  v.Z = Z + b.Z;
398 
399  return v;
400  }
401 
402  inline AkVector64 operator-(const AkVector64& b) const
403  {
404  AkVector64 v;
405 
406  v.X = X - b.X;
407  v.Y = Y - b.Y;
408  v.Z = Z - b.Z;
409 
410  return v;
411  }
412 
413  inline void Zero()
414  {
415  X = 0; Y = 0; Z = 0;
416  }
417 
418  AkReal64 X; ///< X Position
419  AkReal64 Y; ///< Y Position
420  AkReal64 Z; ///< Z Position
421 };
422 
423 /// 3D vector for some operations in 3D space. Typically intended only for localized calculations due to 32-bit precision
424 struct AkVector
425 {
426  inline AkVector operator+(const AkVector& b) const
427  {
428  AkVector v;
429 
430  v.X = X + b.X;
431  v.Y = Y + b.Y;
432  v.Z = Z + b.Z;
433 
434  return v;
435  }
436 
437  inline AkVector operator-(const AkVector& b) const
438  {
439  AkVector v;
440 
441  v.X = X - b.X;
442  v.Y = Y - b.Y;
443  v.Z = Z - b.Z;
444 
445  return v;
446  }
447 
448  inline AkVector operator*(const AkReal32 f) const
449  {
450  AkVector v;
451 
452  v.X = X * f;
453  v.Y = Y * f;
454  v.Z = Z * f;
455 
456  return v;
457  }
458 
459  inline void Zero()
460  {
461  X = 0; Y = 0; Z = 0;
462  }
463 
464  // Helper for implicit conversion to AkVector64. ConvertAkVectorToAkVector64 is still preferable to make it more obvious where upconversion occurs.
465  inline operator</span> AkVector64() const { return AkVector64{ X, Y, Z }; }
466 
467  AkReal32 X; ///< X Position
468  AkReal32 Y; ///< Y Position
469  AkReal32 Z; ///< Z Position
470 };
471 
472 /// Position and orientation of game objects in the world (i.e. supports 64-bit-precision position)
473 class AkWorldTransform
474 {
475 public:
476  //
477  // Getters.
478  //
479 
480  /// Get position vector.
481  inline const AkVector64 & Position() const
482  {
483  return position;
484  }
485 
486  /// Get orientation front vector.
487  inline const AkVector & OrientationFront() const
488  {
489  return orientationFront;
490  }
491 
492  /// Get orientation top vector.
493  inline const AkVector & OrientationTop() const
494  {
495  return orientationTop;
496  }
497 
498  //
499  // Setters.
500  //
501 
502  /// Set position and orientation. Orientation front and top should be orthogonal and normalized.
503  inline void Set(
504  const AkVector64 & in_position, ///< Position vector.
505  const AkVector & in_orientationFront, ///< Orientation front
506  const AkVector & in_orientationTop ///< Orientation top
507  )
508  {
509  position = in_position;
510  orientationFront = in_orientationFront;
511  orientationTop = in_orientationTop;
512  }
513 
514  /// Set position and orientation. Orientation front and top should be orthogonal and normalized.
515  inline void Set(
516  AkReal64 in_positionX, ///< Position x
517  AkReal64 in_positionY, ///< Position y
518  AkReal64 in_positionZ, ///< Position z
519  AkReal32 in_orientFrontX, ///< Orientation front x
520  AkReal32 in_orientFrontY, ///< Orientation front y
521  AkReal32 in_orientFrontZ, ///< Orientation front z
522  AkReal32 in_orientTopX, ///< Orientation top x
523  AkReal32 in_orientTopY, ///< Orientation top y
524  AkReal32 in_orientTopZ ///< Orientation top z
525  )
526  {
527  position.X = in_positionX;
528  position.Y = in_positionY;
529  position.Z = in_positionZ;
530  orientationFront.X = in_orientFrontX;
531  orientationFront.Y = in_orientFrontY;
532  orientationFront.Z = in_orientFrontZ;
533  orientationTop.X = in_orientTopX;
534  orientationTop.Y = in_orientTopY;
535  orientationTop.Z = in_orientTopZ;
536  }
537 
538  /// Set position.
539  inline void SetPosition(
540  const AkVector64 & in_position ///< Position vector.
541  )
542  {
543  position = in_position;
544  }
545 
546  /// Set position.
547  inline void SetPosition(
548  AkReal64 in_x, ///< x
549  AkReal64 in_y, ///< y
550  AkReal64 in_z ///< z
551  )
552  {
553  position.X = in_x;
554  position.Y = in_y;
555  position.Z = in_z;
556  }
557 
558  /// Set orientation. Orientation front and top should be orthogonal and normalized.
559  inline void SetOrientation(
560  const AkVector & in_orientationFront, ///< Orientation front
561  const AkVector & in_orientationTop ///< Orientation top
562  )
563  {
564  orientationFront = in_orientationFront;
565  orientationTop = in_orientationTop;
566  }
567 
568  /// Set orientation. Orientation front and top should be orthogonal and normalized.
569  inline void SetOrientation(
570  AkReal32 in_orientFrontX, ///< Orientation front x
571  AkReal32 in_orientFrontY, ///< Orientation front y
572  AkReal32 in_orientFrontZ, ///< Orientation front z
573  AkReal32 in_orientTopX, ///< Orientation top x
574  AkReal32 in_orientTopY, ///< Orientation top y
575  AkReal32 in_orientTopZ ///< Orientation top z
576  )
577  {
578  orientationFront.X = in_orientFrontX;
579  orientationFront.Y = in_orientFrontY;
580  orientationFront.Z = in_orientFrontZ;
581  orientationTop.X = in_orientTopX;
582  orientationTop.Y = in_orientTopY;
583  orientationTop.Z = in_orientTopZ;
584  }
585 
586 private:
587  AkVector orientationFront; ///< Orientation of the listener
588  AkVector orientationTop; ///< Top orientation of the listener
589  AkVector64 position; ///< Position of the listener
590 };
591 
592 /// Position and orientation of objects in a "local" space
593 class AkTransform
594 {
595 public:
596  //
597  // Getters.
598  //
599 
600  /// Get position vector.
601  inline const AkVector& Position() const
602  {
603  return position;
604  }
605 
606  /// Get orientation front vector.
607  inline const AkVector& OrientationFront() const
608  {
609  return orientationFront;
610  }
611 
612  /// Get orientation top vector.
613  inline const AkVector& OrientationTop() const
614  {
615  return orientationTop;
616  }
617 
618  //
619  // Setters.
620  //
621 
622  /// Set position and orientation. Orientation front and top should be orthogonal and normalized.
623  inline void Set(
624  const AkVector& in_position, ///< Position vector.
625  const AkVector& in_orientationFront, ///< Orientation front
626  const AkVector& in_orientationTop ///< Orientation top
627  )
628  {
629  position = in_position;
630  orientationFront = in_orientationFront;
631  orientationTop = in_orientationTop;
632  }
633 
634  /// Set position and orientation. Orientation front and top should be orthogonal and normalized.
635  inline void Set(
636  AkReal32 in_positionX, ///< Position x
637  AkReal32 in_positionY, ///< Position y
638  AkReal32 in_positionZ, ///< Position z
639  AkReal32 in_orientFrontX, ///< Orientation front x
640  AkReal32 in_orientFrontY, ///< Orientation front y
641  AkReal32 in_orientFrontZ, ///< Orientation front z
642  AkReal32 in_orientTopX, ///< Orientation top x
643  AkReal32 in_orientTopY, ///< Orientation top y
644  AkReal32 in_orientTopZ ///< Orientation top z
645  )
646  {
647  position.X = in_positionX;
648  position.Y = in_positionY;
649  position.Z = in_positionZ;
650  orientationFront.X = in_orientFrontX;
651  orientationFront.Y = in_orientFrontY;
652  orientationFront.Z = in_orientFrontZ;
653  orientationTop.X = in_orientTopX;
654  orientationTop.Y = in_orientTopY;
655  orientationTop.Z = in_orientTopZ;
656  }
657 
658  /// Set position.
659  inline void SetPosition(
660  const AkVector& in_position ///< Position vector.
661  )
662  {
663  position = in_position;
664  }
665 
666  /// Set position.
667  inline void SetPosition(
668  AkReal32 in_x, ///< x
669  AkReal32 in_y, ///< y
670  AkReal32 in_z ///< z
671  )
672  {
673  position.X = in_x;
674  position.Y = in_y;
675  position.Z = in_z;
676  }
677 
678  /// Set orientation. Orientation front and top should be orthogonal and normalized.
679  inline void SetOrientation(
680  const AkVector& in_orientationFront, ///< Orientation front
681  const AkVector& in_orientationTop ///< Orientation top
682  )
683  {
684  orientationFront = in_orientationFront;
685  orientationTop = in_orientationTop;
686  }
687 
688  /// Set orientation. Orientation front and top should be orthogonal and normalized.
689  inline void SetOrientation(
690  AkReal32 in_orientFrontX, ///< Orientation front x
691  AkReal32 in_orientFrontY, ///< Orientation front y
692  AkReal32 in_orientFrontZ, ///< Orientation front z
693  AkReal32 in_orientTopX, ///< Orientation top x
694  AkReal32 in_orientTopY, ///< Orientation top y
695  AkReal32 in_orientTopZ ///< Orientation top z
696  )
697  {
698  orientationFront.X = in_orientFrontX;
699  orientationFront.Y = in_orientFrontY;
700  orientationFront.Z = in_orientFrontZ;
701  orientationTop.X = in_orientTopX;
702  orientationTop.Y = in_orientTopY;
703  orientationTop.Z = in_orientTopZ;
704  }
705 
706  // Helper for implicit conversion to AkWorldTransform. ConvertAkTransformToAkWorldTransform is still preferable to make it more obvious where upconversion occurs.
707  inline operator</span> AkWorldTransform() const {
708  AkWorldTransform ret;
709  ret.Set(position, orientationFront, orientationTop);
710  return ret;
711  }
712 
713 private:
714  AkVector orientationFront; ///< Orientation of the listener
715  AkVector orientationTop; ///< Top orientation of the listener
716  AkVector position; ///< Position of the listener
717 };
718 
719 
720 namespace AK
721 {
722  // Helper functions to make transitions between 64b and 32b conversion easier
723 
724  // Warning: this conversion incurs a loss of precision and range
725  inline AkVector ConvertAkVector64ToAkVector(AkVector64 in)
726  {
727  AkVector out;
728  out.X = (AkReal32)in.X;
729  out.Y = (AkReal32)in.Y;
730  out.Z = (AkReal32)in.Z;
731  return out;
732  }
733 
734  // Warning: this conversion incurs a loss of precision and range in position data
735  inline AkTransform ConvertAkWorldTransformToAkTransform(AkWorldTransform in)
736  {
737  AkTransform out;
738  AkVector pos = ConvertAkVector64ToAkVector(in.Position());
739  out.Set(pos, in.OrientationFront(), in.OrientationTop());
740  return out;
741  }
742 
743  inline AkVector64 ConvertAkVectorToAkVector64(AkVector in)
744  {
745  AkVector64 out;
746  out.X = (AkReal64)in.X;
747  out.Y = (AkReal64)in.Y;
748  out.Z = (AkReal64)in.Z;
749  return out;
750  }
751 
752  inline AkWorldTransform ConvertAkTransformToAkWorldTransform(AkTransform in)
753  {
754  AkWorldTransform out;
755  AkVector64 pos = ConvertAkVectorToAkVector64(in.Position());
756  out.Set(pos, in.OrientationFront(), in.OrientationTop());
757  return out;
758  }
759 }
760 
761 /// Positioning information for a sound.
762 typedef AkWorldTransform AkSoundPosition;
763 
764 /// Positioning information for a listener.
765 typedef AkWorldTransform AkListenerPosition;
766 
767 /// Obstruction/occlusion pair for a position
768 struct AkObstructionOcclusionValues
769 {
770  AkReal32 occlusion; ///< OcclusionLevel: [0.0f..1.0f]
771  AkReal32 obstruction; ///< ObstructionLevel: [0.0f..1.0f]
772 };
773 
774 /// Positioning information for a sound, with specified subset of its channels.
775 struct AkChannelEmitter
776 {
777  AkWorldTransform position; ///< Emitter position.
778  AkChannelMask uInputChannels; ///< Channels to which the above position applies.
779  char padding[4]; ///< In order to preserve consistent struct size across archs, we need some padding
780 };
781 
782 /// Polar coordinates.
783 struct AkPolarCoord
784 {
785  AkReal32 r; ///< Norm/distance
786  AkReal32 theta; ///< Azimuth
787 };
788 
789 /// Spherical coordinates.
790 struct AkSphericalCoord : public AkPolarCoord
791 {
792  AkReal32 phi; ///< Elevation
793 };
794 
795 /// Emitter-listener pair: Positioning data pertaining to a single pair of emitter and listener.
796 class AkEmitterListenerPair
797 {
798 public:
799  /// Constructor.
800  AkEmitterListenerPair()
801  : fDistance(0.f)
802  , fEmitterAngle(0.f)
803  , fListenerAngle(0.f)
804  , fDryMixGain(1.f)
805  , fGameDefAuxMixGain(1.f)
806  , fUserDefAuxMixGain(1.f)
807  , fOcclusion(0.f)
808  , fObstruction(0.f)
809  , fDiffraction(0.f)
810  , fTransmissionLoss(0.f)
811  , fSpread(0.f)
812  , fAperture(100.f)
813  , fScalingFactor(1.f)
814  , uEmitterChannelMask(0xFFFFFFFF)
815  , id(0)
816  , m_uListenerID(0)
817  {
818  }
819  /// Destructor.
820  ~AkEmitterListenerPair() {}
821 
822  /// Get distance.
823  inline AkReal32 Distance() const { return fDistance; }
824 
825  /// Get the absolute angle, in radians between 0 and pi, of the emitter's orientation relative to
826  /// the line that joins the emitter and the listener.
827  inline AkReal32 EmitterAngle() const { return fEmitterAngle; }
828 
829  /// Get the absolute angle, in radians between 0 and pi, of the listener's orientation relative to
830  /// the line that joins the emitter and the listener
831  inline AkReal32 ListenerAngle() const { return fListenerAngle; }
832 
833  /// Get the occlusion factor for this emitter-listener pair
834  inline AkReal32 Occlusion() const { return fOcclusion; }
835 
836  /// Get the obstruction factor for this emitter-listener pair
837  inline AkReal32 Obstruction() const { return fObstruction; }
838 
839  /// Get the diffraction factor for this emitter-listener pair
840  inline AkReal32 Diffraction() const { return fDiffraction; }
841 
842  /// Get the transmission loss factor for this emitter-listener pair
843  inline AkReal32 TransmissionLoss() const { return fTransmissionLoss; }
844 
845  /// Get the emitter-listener-pair-specific gain (due to distance and cone attenuation), linear [0,1], for a given connection type.
846  inline AkReal32 GetGainForConnectionType(AkConnectionType in_eType) const
847  {
848  if (in_eType == ConnectionType_Direct)
849  return fDryMixGain;
850  else if (in_eType == ConnectionType_GameDefSend)
851  return fGameDefAuxMixGain;
852  else if (in_eType == ConnectionType_UserDefSend)
853  return fUserDefAuxMixGain;
854  else
855  return 1.0f;
856  }
857 
858  /// Get the emitter-listener pair's ID.
859  inline AkRayID ID() const { return id; }
860 
861  /// Get listener ID associated with the emitter-listener pair.
862  inline AkGameObjectID ListenerID() const { return m_uListenerID; }
863 
864  AkWorldTransform emitter; ///< Emitter position.
865  AkReal32 fDistance; ///< Distance between emitter and listener.
866  AkReal32 fEmitterAngle; ///< Angle between position vector and emitter orientation.
867  AkReal32 fListenerAngle; ///< Angle between position vector and listener orientation.
868  AkReal32 fDryMixGain; ///< Emitter-listener-pair-specific gain (due to distance and cone attenuation) for direct connections.
869  AkReal32 fGameDefAuxMixGain; ///< Emitter-listener-pair-specific gain (due to distance and cone attenuation) for game-defined send connections.
870  AkReal32 fUserDefAuxMixGain; ///< Emitter-listener-pair-specific gain (due to distance and cone attenuation) for user-defined send connections.
871  AkReal32 fOcclusion; ///< Emitter-listener-pair-specific occlusion factor
872  AkReal32 fObstruction; ///< Emitter-listener-pair-specific obstruction factor
873  AkReal32 fDiffraction; ///< Emitter-listener-pair-specific diffraction coefficient
874  AkReal32 fTransmissionLoss; ///< Emitter-listener-pair-specific transmission occlusion.
875  AkReal32 fSpread; ///< Emitter-listener-pair-specific spread
876  AkReal32 fAperture; ///< Emitter-listener-pair-specific aperture
877  AkReal32 fScalingFactor; ///< Combined scaling factor due to both emitter and listener.
878  AkChannelMask uEmitterChannelMask; ///< Channels of the emitter that apply to this ray.
879 protected:
880  AkRayID id; ///< ID of this emitter-listener pair, unique for a given emitter.
881  AkGameObjectID m_uListenerID; ///< Listener game object ID.
882 };
883 
884 /// Listener information.
885 struct AkListener
886 {
887  AkListener()
888  : fScalingFactor( 1.0f )
889  , bSpatialized( true )
890  {}
891  AkListenerPosition position; /// Listener position (see AK::SoundEngine::SetPosition()).
892  AkReal32 fScalingFactor; /// Listener scaling factor (see AK::SoundEngine::SetListenerScalingFactor()).
893  bool bSpatialized; /// Whether listener is spatialized or not (see AK::SoundEngine::SetListenerSpatialization()).
894 };
895 
896 // If you modify AkCurveInterpolation, don't forget to modify WAAPI validation schema accordingly.
897 
898 /// Curve interpolation types
899 enum AkCurveInterpolation
900 {
901 //DONT GO BEYOND 15! (see below for details)
902 //Curves from 0 to LastFadeCurve NEED TO BE A MIRROR IMAGE AROUND LINEAR (eg. Log3 is the inverse of Exp3)
903  AkCurveInterpolation_Log3 = 0, ///< Log3
904  AkCurveInterpolation_Sine = 1, ///< Sine
905  AkCurveInterpolation_Log1 = 2, ///< Log1
906  AkCurveInterpolation_InvSCurve = 3, ///< Inversed S Curve
907  AkCurveInterpolation_Linear = 4, ///< Linear (Default)
908  AkCurveInterpolation_SCurve = 5, ///< S Curve
909  AkCurveInterpolation_Exp1 = 6, ///< Exp1
910  AkCurveInterpolation_SineRecip = 7, ///< Reciprocal of sine curve
911  AkCurveInterpolation_Exp3 = 8, ///< Exp3
912  AkCurveInterpolation_LastFadeCurve = 8, ///< Update this value to reflect last curve available for fades
913  AkCurveInterpolation_Constant = 9 ///< Constant ( not valid for fading values )
914 //DONT GO BEYOND 15! The value is stored on 5 bits,
915 //but we can use only 4 bits for the actual values, keeping
916 //the 5th bit at 0 to void problems when the value is
917 //expanded to 32 bits.
918 };
919 #define AKCURVEINTERPOLATION_NUM_STORAGE_BIT 5 ///< Internal storage restriction, for internal use only.
920 
921 /// Auxiliary bus sends information per game object per given auxiliary bus.
922 struct AkAuxSendValue
923 {
924  AkGameObjectID listenerID; ///< Game object ID of the listener associated with this send. Use AK_INVALID_GAME_OBJECT as a wildcard to set the auxiliary send to all connected listeners (see AK::SoundEngine::SetListeners).
925  AkAuxBusID auxBusID; ///< Auxiliary bus ID.
926  AkReal32 fControlValue; ///< A value in the range [0.0f:16.0f] ( -∞ dB to +24 dB).
927  ///< Represents the attenuation or amplification factor applied to the volume of the sound going through the auxiliary bus.
928  ///< A value greater than 1.0f will amplify the sound.
929 };
930 
931 /// Volume ramp specified by end points "previous" and "next".
932 struct AkRamp
933 {
934  AkRamp() : fPrev( 1.f ), fNext( 1.f ) {}
935  AkRamp( AkReal32 in_fPrev, AkReal32 in_fNext ) : fPrev( in_fPrev ), fNext( in_fNext ) {}
936  AkRamp & operator*=(const AkRamp& in_rRhs) { fPrev *= in_rRhs.fPrev; fNext *= in_rRhs.fNext; return *this; }
937 
938  AkReal32 fPrev;
939  AkReal32 fNext;
940 };
941 inline AkRamp operator*(const AkRamp& in_rLhs, const AkRamp& in_rRhs)
942 {
943  AkRamp result(in_rLhs);
944  result *= in_rRhs;
945  return result;
946 }
947 
948 /// Type for a point in an RTPC or Attenuation curve.
949 template< class VALUE_TYPE >
950 struct AkGraphPointBase
951 {
952  AkGraphPointBase() = default;
953 
954  AkGraphPointBase(AkReal32 in_from, VALUE_TYPE in_to, AkCurveInterpolation in_interp)
955  : From(in_from)
956  , To(in_to)
957  , Interp(in_interp)
958  {}
959 
960  AkReal32 From; ///< Represents the value on the X axis.
961  VALUE_TYPE To; ///< Represents the value on the Y axis.
962  AkCurveInterpolation Interp; ///< The shape of the interpolation curve between this point and the next.
963 
964  bool operator==(const AkGraphPointBase& other) const
965  {
966  return From == other.From && To == other.To && Interp == other.Interp;
967  }
968 };
969 
970 // Every point of a conversion graph
971 typedef AkGraphPointBase<AkReal32> AkRTPCGraphPoint;
972 
973 /// Curve types of the Attenuation Editor.
974 enum AkAttenuationCurveType
975 {
976  AttenuationCurveID_VolumeDry = 0, ///< The distance-driven dry volume curve.
977  AttenuationCurveID_VolumeAuxGameDef, ///< The distance-driven game-defined auxiliary send curve.
978  AttenuationCurveID_VolumeAuxUserDef, ///< The distance-driven user-defined auxiliary send curve.
979  AttenuationCurveID_LowPassFilter, ///< The distance-driven low-pass filter (pre send) curve.
980  AttenuationCurveID_HighPassFilter, ///< The distance-driven high-pass filter (pre send) curve.
981  AttenuationCurveID_Spread, ///< The distance-driven Spread curve.
982  AttenuationCurveID_Focus, ///< The distance-driven Focus curve.
983  AttenuationCurveID_ObstructionVolume, ///< The obstruction-driven volume curve.
984  AttenuationCurveID_ObstructionLPF, ///< The obstruction-driven low-pass filter curve.
985  AttenuationCurveID_ObstructionHPF, ///< The obstruction-driven high-pass filter curve.
986  AttenuationCurveID_OcclusionVolume, ///< The occlusion-driven volume curve.
987  AttenuationCurveID_OcclusionLPF, ///< The occlusion-driven low-pass filter curve.
988  AttenuationCurveID_OcclusionHPF, ///< The occlusion-driven high-pass filter curve.
989  AttenuationCurveID_DiffractionVolume, ///< The diffraction-driven volume curve.
990  AttenuationCurveID_DiffractionLPF, ///< The diffraction-driven low-pass filter curve.
991  AttenuationCurveID_DiffractionHPF, ///< The diffraction-driven high-pass filter curve.
992  AttenuationCurveID_TransmissionVolume, ///< The transmission-driven volume curve.
993  AttenuationCurveID_TransmissionLPF, ///< The transmission-driven low-pass filter curve.
994  AttenuationCurveID_TransmissionHPF, ///< The transmission-driven high-pass filter curve.
995 
996  AttenuationCurveID_MaxCount, ///< The maximum number of curve types.
997 
998  AttenuationCurveID_Project = 254, ///< Symbol for "Use Project".
999  AttenuationCurveID_None = 255 ///< Symbol for "None".
1000 };
1001 
1002 // ---------------------------------------------------------------
1003 // Languages
1004 // ---------------------------------------------------------------
1005 #define AK_MAX_LANGUAGE_NAME_SIZE (32)
1006 
1007 // ---------------------------------------------------------------
1008 // File Type ID Definitions
1009 // ---------------------------------------------------------------
1010 
1011 // These correspond to IDs specified in the conversion plug-ins' XML
1012 // files. Audio sources persist them to "remember" their format.
1013 // DO NOT CHANGE THEM without talking to someone in charge of persistence!
1014 
1015 // Company ID for plugin development.
1016 #define AKCOMPANYID_PLUGINDEV_MIN (64)
1017 #define AKCOMPANYID_PLUGINDEV_MAX (255)
1018 
1019 // Vendor ID.
1020 #define AKCOMPANYID_AUDIOKINETIC (0) ///< Audiokinetic inc.
1021 #define AKCOMPANYID_AUDIOKINETIC_EXTERNAL (1) ///< Audiokinetic inc.
1022 #define AKCOMPANYID_MCDSP (256) ///< McDSP
1023 #define AKCOMPANYID_WAVEARTS (257) ///< WaveArts
1024 #define AKCOMPANYID_PHONETICARTS (258) ///< Phonetic Arts
1025 #define AKCOMPANYID_IZOTOPE (259) ///< iZotope
1026 #define AKCOMPANYID_CRANKCASEAUDIO (261) ///< Crankcase Audio
1027 #define AKCOMPANYID_IOSONO (262) ///< IOSONO
1028 #define AKCOMPANYID_AUROTECHNOLOGIES (263) ///< Auro Technologies
1029 #define AKCOMPANYID_DOLBY (264) ///< Dolby
1030 #define AKCOMPANYID_TWOBIGEARS (265) ///< Two Big Ears
1031 #define AKCOMPANYID_OCULUS (266) ///< Oculus
1032 #define AKCOMPANYID_BLUERIPPLESOUND (267) ///< Blue Ripple Sound
1033 #define AKCOMPANYID_ENZIEN (268) ///< Enzien Audio
1034 #define AKCOMPANYID_KROTOS (269) ///< Krotos (Dehumanizer)
1035 #define AKCOMPANYID_NURULIZE (270) ///< Nurulize
1036 #define AKCOMPANYID_SUPERPOWERED (271) ///< Super Powered
1037 #define AKCOMPANYID_GOOGLE (272) ///< Google
1038 //#define AKCOMPANYID_NVIDIA (273) ///< NVIDIA // Commented out to avoid redefinition, provider is already defining it.
1039 //#define AKCOMPANYID_RESERVED (274) ///< Reserved // Commented out to avoid redefinition, provider is already defining it.
1040 //#define AKCOMPANYID_MICROSOFT (275) ///< Microsoft // Commented out to avoid redefinition, provider is already defining it.
1041 //#define AKCOMPANYID_YAMAHA (276) ///< YAMAHA // Commented out to avoid redefinition, provider is already defining it.
1042 #define AKCOMPANYID_VISISONICS (277) ///< Visisonics
1043 
1044 // File/encoding types of Audiokinetic.
1045 #define AKCODECID_BANK (0) ///< Bank encoding
1046 #define AKCODECID_PCM (1) ///< PCM encoding
1047 #define AKCODECID_ADPCM (2) ///< ADPCM encoding
1048 #define AKCODECID_XMA (3) ///< XMA encoding
1049 #define AKCODECID_VORBIS (4) ///< Vorbis encoding
1050 #define AKCODECID_WIIADPCM (5) ///< ADPCM encoding on the Wii
1051 #define AKCODECID_PCMEX (7) ///< Standard PCM WAV file parser for Wwise Authoring
1052 #define AKCODECID_EXTERNAL_SOURCE (8) ///< External Source (unknown encoding)
1053 #define AKCODECID_XWMA (9) ///< xWMA encoding
1054 #define AKCODECID_FILE_PACKAGE (11) ///< File package files generated by the File Packager utility.
1055 #define AKCODECID_ATRAC9 (12) ///< ATRAC-9 encoding
1056 #define AKCODECID_VAG (13) ///< VAG/HE-VAG encoding
1057 #define AKCODECID_PROFILERCAPTURE (14) ///< Profiler capture file (.prof) as written through AK::SoundEngine::StartProfilerCapture
1058 #define AKCODECID_ANALYSISFILE (15) ///< Analysis file
1059 #define AKCODECID_MIDI (16) ///< MIDI file
1060 #define AKCODECID_OPUSNX (17) ///< OpusNX encoding
1061 #define AKCODECID_CAF (18) ///< CAF file
1062 #define AKCODECID_AKOPUS (19) ///< Opus encoding, 2018.1 to 2019.2
1063 #define AKCODECID_AKOPUS_WEM (20) ///< Opus encoding, wrapped in WEM
1064 #define AKCODECID_MEMORYMGR_DUMP (21) ///< Memory stats file as written through AK::MemoryMgr::DumpToFile();
1065 #define AKCODECID_SONY360 (22) ///< Sony 360 encoding
1066 
1067 #define AKCODECID_BANK_EVENT (30) ///< Bank encoding for event banks. These banks are contained in the /event sub-folder.
1068 #define AKCODECID_BANK_BUS (31) ///< Bank encoding for bus banks. These banks are contained in the /bus sub-folder.
1069 
1070 #define AKPLUGINID_METER (129) ///< Meter Plugin
1071 #define AKPLUGINID_RECORDER (132) ///< Recorder Plugin
1072 #define AKPLUGINID_IMPACTER (184)
1073 #define AKPLUGINID_SYSTEM_OUTPUT_META (900) ///< System output metadata
1074 #define AKPLUGINID_AUDIO_OBJECT_ATTENUATION_META (901) ///< Attenuation curve metadata
1075 #define AKPLUGINID_AUDIO_OBJECT_PRIORITY_META (902) ///< Audio object priority metadata
1076 
1077 #define AKEXTENSIONID_SPATIALAUDIO (800) ///< Spatial Audio
1078 #define AKEXTENSIONID_INTERACTIVEMUSIC (801) ///< Interactive Music
1079 #define AKEXTENSIONID_MIDIDEVICEMGR (802) ///< MIDI Device Manager (Authoring)
1080 
1081 //The following are internally defined
1082 #define AK_WAVE_FORMAT_VAG 0xFFFB
1083 #define AK_WAVE_FORMAT_AT9 0xFFFC
1084 #define AK_WAVE_FORMAT_VORBIS 0xFFFF
1085 #define AK_WAVE_FORMAT_OPUSNX 0x3039
1086 #define AK_WAVE_FORMAT_OPUS 0x3040
1087 #define AK_WAVE_FORMAT_OPUS_WEM 0x3041
1088 #define WAVE_FORMAT_XMA2 0x166
1089 
1090 //-----------------------------------------------------------------------------
1091 // Codecs
1092 //-----------------------------------------------------------------------------
1093 
1094 class IAkSoftwareCodec;
1095 class IAkFileCodec;
1096 class IAkGrainCodec;
1097 /// Registered file source creation function prototype.
1098 AK_CALLBACK( IAkSoftwareCodec*, AkCreateFileSourceCallback )( void* in_pCtx );
1099 /// Registered bank source node creation function prototype.
1100 AK_CALLBACK( IAkSoftwareCodec*, AkCreateBankSourceCallback )( void* in_pCtx );
1101 /// Registered FileCodec creation function prototype.
1102 AK_CALLBACK( IAkFileCodec*, AkCreateFileCodecCallback )();
1103 /// Registered IAkGrainCodec creation function prototype.
1104 AK_CALLBACK( IAkGrainCodec*, AkCreateGrainCodecCallback )();
1105 
1106 struct AkCodecDescriptor
1107 {
1108  AkCreateFileSourceCallback pFileSrcCreateFunc; // File VPL source.
1109  AkCreateBankSourceCallback pBankSrcCreateFunc; // Bank VPL source.
1110  AkCreateFileCodecCallback pFileCodecCreateFunc; // FileCodec utility.
1111  AkCreateGrainCodecCallback pGrainCodecCreateFunc; // GrainCodec utility.
1112 };
1113 
1114 //-----------------------------------------------------------------------------
1115 // Banks
1116 //-----------------------------------------------------------------------------
1117 
1118 /// Bank types
1119 enum AkBankTypeEnum
1120 {
1121  AkBankType_User = AKCODECID_BANK, ///< User-defined bank.
1122  AkBankType_Event = AKCODECID_BANK_EVENT, ///< Bank generated for one event.
1123  AkBankType_Bus = AKCODECID_BANK_BUS, ///< Bank generated for one bus or aux bus.
1124 };
1125 
1126 //-----------------------------------------------------------------------------
1127 // Positioning
1128 //-----------------------------------------------------------------------------
1129 
1130 namespace AK
1131 {
1132  namespace SoundEngine
1133  {
1134  // If you modify MultiPositionType, don't forget to modify WAAPI validation schema accordingly.
1135 
1136  /// MultiPositionType.
1137  /// \aknote
1138  /// - If a sound has diffraction enabled, it is treated as <tt>MultiPositionType_MultiDirections</tt>. <tt>MultiPositionType_MultiSources</tt> is not supported in this case.
1139  /// \endaknote
1140  /// \sa
1141  /// - AK::SoundEngine::SetMultiplePosition()
1142  /// - \ref soundengine_3dpositions_multiplepos
1143  enum MultiPositionType : AkUInt8
1144  {
1145  MultiPositionType_SingleSource, ///< Used for normal sounds, not expected to pass to AK::SoundEngine::SetMultiplePosition() (if done, only the first position will be used).
1146  MultiPositionType_MultiSources, ///< Simulate multiple sources in one sound playing, adding volumes. For instance, all the torches on your level emitting using only one sound.
1147  MultiPositionType_MultiDirections ///< Simulate one sound coming from multiple directions. Useful for repositionning sounds based on wall openings or to simulate areas like forest or rivers ( in combination with spreading in the attenuation of the sounds ).
1148  };
1149  }
1150 }
1151 
1152 #define AK_PANNER_NUM_STORAGE_BITS 3
1153 /// Speaker panning type: type of panning logic when object is not 3D spatialized (i.e. when Ak3DSpatializationMode is AK_SpatializationMode_None).
1154 enum AkSpeakerPanningType : AkUInt8
1155 {
1156  AK_DirectSpeakerAssignment = 0, ///< No panning: route to matching channels between input and output.
1157  AK_BalanceFadeHeight = 1, ///< Balance-Fade-Height: Traditional "box" or "car"-like panner.
1158  AK_SteeringPanner = 2 ///< Steering panner.
1159 };
1160 
1161 #define AK_POSSOURCE_NUM_STORAGE_BITS 3
1162 /// 3D position type: defines what acts as the emitter position for computing spatialization against the listener. Used when Ak3DSpatializationMode is AK_SpatializationMode_PositionOnly or AK_SpatializationMode_PositionAndOrientation.
1163 enum Ak3DPositionType : AkUInt8
1164 {
1165  AK_3DPositionType_Emitter = 0, ///< 3D spatialization is computed directly from the emitter game object position.
1166  AK_3DPositionType_EmitterWithAutomation = 1, ///< 3D spatialization is computed from the emitter game object position, translated by user-defined automation.
1167  AK_3DPositionType_ListenerWithAutomation = 2 ///< 3D spatialization is computed from the listener game object position, translated by user-defined automation.
1168 };
1169 
1170 /// Flags to independently set the position of the emitter or listener component on a game object.
1171 enum AkSetPositionFlags : AkUInt8
1172 {
1173  AkSetPositionFlags_Emitter = 1 << 0, // Only set the emitter component position.
1174  AkSetPositionFlags_Listener = 1 << 1, // Only set the listener component position.
1175 
1176  AkSetPositionFlags_Default = (AkSetPositionFlags_Emitter | AkSetPositionFlags_Listener) // Default: set both emitter and listener component positions.
1177 };
1178 
1179 /// Headphone / speakers panning rules
1180 enum AkPanningRule : AkUInt8
1181 {
1182  AkPanningRule_Speakers = 0, ///< Left and right positioned 60 degrees apart (by default - see AK::SoundEngine::GetSpeakerAngles()).
1183  AkPanningRule_Headphones = 1 ///< Left and right positioned 180 degrees apart.
1184 };
1185 
1186 #define AK_SPAT_NUM_STORAGE_BITS 3
1187 /// 3D spatialization mode.
1188 enum Ak3DSpatializationMode : AkUInt8
1189 {
1190  AK_SpatializationMode_None = 0, ///< No spatialization
1191  AK_SpatializationMode_PositionOnly = 1, ///< Spatialization based on emitter position only.
1192  AK_SpatializationMode_PositionAndOrientation = 2 ///< Spatialization based on both emitter position and emitter orientation.
1193 };
1194 
1195 /// Bus type bit field.
1196 enum AkBusHierarchyFlags : AkUInt8
1197 {
1198  AkBusHierarchy_Primary = 1 << 0, ///< Flag is set to indicate the primary bus hierarchy.
1199  AkBusHierarchy_Secondary = 1 << 1, ///< Flag is set to indicate the secondary bus hierarchy.
1200  AkBusHierarchy_IsMaster = 1 << 7 ///< Flag is set to indicate a master bus (may be used in combination with other flags).
1201 };
1202 
1203 #define AK_MAX_BITS_METERING_FLAGS (5) // Keep in sync with AkMeteringFlags.
1204 
1205 /// Metering flags. Used for specifying bus metering, through AK::SoundEngine::RegisterBusVolumeCallback() or AK::IAkMixerPluginContext::SetMeteringFlags().
1206 enum AkMeteringFlags : AkUInt8
1207 {
1208  AK_NoMetering = 0, ///< No metering.
1209  AK_EnableBusMeter_Peak = 1 << 0, ///< Enable computation of peak metering.
1210  AK_EnableBusMeter_TruePeak = 1 << 1, ///< Enable computation of true peak metering (most CPU and memory intensive).
1211  AK_EnableBusMeter_RMS = 1 << 2, ///< Enable computation of RMS metering.
1212  // 1 << 3 is reserved.
1213  AK_EnableBusMeter_KPower = 1 << 4, ///< Enable computation of K-weighted power metering (used as a basis for computing loudness, as defined by ITU-R BS.1770).
1214  AK_EnableBusMeter_3DMeter = 1 << 5
1215 };
1216 
1217 /// Plug-in type.
1218 /// \sa
1219 /// - AkPluginInfo
1220 enum AkPluginType : AkUInt8
1221 {
1222  AkPluginTypeNone = 0, ///< Unknown/invalid plug-in type.
1223  AkPluginTypeCodec = 1, ///< Compressor/decompressor plug-in (allows support for custom audio file types).
1224  AkPluginTypeSource = 2, ///< Source plug-in: creates sound by synthesis method (no input, just output).
1225  AkPluginTypeEffect = 3, ///< Effect plug-in: applies processing to audio data.
1226  //AkPluginTypeMotionDevice = 4, ///< Motion Device plug-in: feeds movement data to devices. Deprecated by Motion refactor.
1227  //AkPluginTypeMotionSource = 5, ///< Motion Device source plug-in: feeds movement data to device busses. Deprecated by Motion refactor.
1228  AkPluginTypeMixer = 6, ///< Mixer plug-in: mix voices at the bus level.
1229  AkPluginTypeSink = 7, ///< Sink plug-in: implement custom sound engine end point.
1230  AkPluginTypeGlobalExtension = 8, ///< Global Extension plug-in: (e.g. Spatial Audio, Interactive Music)
1231  AkPluginTypeMetadata = 9, ///< Metadata plug-in: applies object-based processing to audio data
1232  AkPluginTypeMask = 0xf ///< Plug-in type mask is 4 bits.
1233 };
1234 
1235 ////////////////////////////////////////////////////////////////////////////////
1236 // Wwise ID system
1237 ////////////////////////////////////////////////////////////////////////////////
1238 enum AkNodeType
1239 {
1240  AkNodeType_Default,
1241  AkNodeType_Bus
1242 };
1243 
1244 struct WwiseObjectIDext
1245 {
1246 public:
1247 
1248  bool operator == ( const WwiseObjectIDext& in_rOther ) const
1249  {
1250  return in_rOther.id == id && in_rOther.bIsBus == bIsBus;
1251  }
1252 
1253  AkNodeType GetType()
1254  {
1255  return bIsBus ? AkNodeType_Bus : AkNodeType_Default;
1256  }
1257 
1258  AkUniqueID id;
1259  bool bIsBus;
1260 };
1261 
1262 struct WwiseObjectID : public WwiseObjectIDext
1263 {
1264  WwiseObjectID()
1265  {
1266  id = AK_INVALID_UNIQUE_ID;
1267  bIsBus = false;
1268  }
1269 
1270  WwiseObjectID( AkUniqueID in_ID )
1271  {
1272  id = in_ID;
1273  bIsBus = false;
1274  }
1275 
1276  WwiseObjectID( AkUniqueID in_ID, bool in_bIsBus )
1277  {
1278  id = in_ID;
1279  bIsBus = in_bIsBus;
1280  }
1281 
1282  WwiseObjectID( AkUniqueID in_ID, AkNodeType in_eNodeType )
1283  {
1284  id = in_ID;
1285  bIsBus = in_eNodeType == AkNodeType_Bus;
1286  }
1287 };
1288 
1289 /// Public data structures for converted file format.
1290 namespace AkFileParser
1291 {
1292 #pragma pack(push, 1)
1293  /// Analyzed envelope point.
1294  struct EnvelopePoint
1295  {
1296  AkUInt32 uPosition; /// Position of this point in samples at the source rate.
1297  AkUInt16 uAttenuation; /// Approximate _attenuation_ at this location relative to this source's maximum, in dB (absolute value).
1298  };
1299 #pragma pack(pop)
1300 }
1301 
1302 #ifndef AK_ASYNC_OPEN_DEFAULT
1303 #define AK_ASYNC_OPEN_DEFAULT (false) ///< Refers to asynchronous file opening in default low-level IO.
1304 #endif
1305 
1306 #ifndef AK_COMM_DEFAULT_DISCOVERY_PORT
1307 #define AK_COMM_DEFAULT_DISCOVERY_PORT 24024 ///< Default discovery port for most platforms using IP sockets for communication.
1308 #endif
1309 
1310 #ifdef AK_CAPTURE_TYPE_FLOAT
1311 typedef AkReal32 AkCaptureType;
1312 #else
1313 typedef AkInt16 AkCaptureType; ///< Default value: capture type is short.
1314 #endif
1315 
1316 #define AkRegister
1317 
1318 #endif //_AK_DATA_TYPES_H_
AkNodeType_Bus
@ AkNodeType_Bus
Definition: AkTypes.h:1241
AK_PathNodeNotInList
@ AK_PathNodeNotInList
This path is not there.
Definition: AkTypes.h:224
AkEmitterListenerPair::AkEmitterListenerPair
AkEmitterListenerPair()
Constructor.
Definition: AkTypes.h:800
AkDeviceDescription::deviceStateMask
AkAudioDeviceState deviceStateMask
Bitmask used to filter the device based on their state.
Definition: AkTypes.h:304
AkEmitterListenerPair::m_uListenerID
AkGameObjectID m_uListenerID
Listener game object ID.
Definition: AkTypes.h:881
AK_EnableBusMeter_Peak
@ AK_EnableBusMeter_Peak
Enable computation of peak metering.
Definition: AkTypes.h:1209
AttenuationCurveID_Focus
@ AttenuationCurveID_Focus
The distance-driven Focus curve.
Definition: AkTypes.h:982
AkStateGroupID
AkUInt32 AkStateGroupID
State group ID.
Definition: AkTypes.h:122
WwiseObjectIDext::id
AkUniqueID id
Definition: AkTypes.h:1258
AkBankType_Bus
@ AkBankType_Bus
Bank generated for one bus or aux bus.
Definition: AkTypes.h:1123
WwiseObjectIDext::GetType
AkNodeType GetType()
Definition: AkTypes.h:1253
AkAuxSendValue::fControlValue
AkReal32 fControlValue
Definition: AkTypes.h:926
AkTransform::SetPosition
void SetPosition(AkReal32 in_x, AkReal32 in_y, AkReal32 in_z)
Set position.
Definition: AkTypes.h:667
AK_DEFAULT_BANK_IO_PRIORITY
static const AkPriority AK_DEFAULT_BANK_IO_PRIORITY
Default bank load I/O priority.
Definition: AkTypes.h:185
AkDataInterleaveID
AkUInt8 AkDataInterleaveID
Data interleaved state ID.
Definition: AkTypes.h:138
AK_UnsupportedChannelConfig
@ AK_UnsupportedChannelConfig
Channel configuration is not supported in the current execution context.
Definition: AkTypes.h:246
AK_NoMetering
@ AK_NoMetering
No metering.
Definition: AkTypes.h:1208
AkJobType_AudioProcessing
static const AkJobType AkJobType_AudioProcessing
Job type for DSP work.
Definition: AkTypes.h:193
AK_DirectSpeakerAssignment
@ AK_DirectSpeakerAssignment
No panning: route to matching channels between input and output.
Definition: AkTypes.h:1156
AK_InvalidCustomPlatformName
@ AK_InvalidCustomPlatformName
Detecting incompatibility between Custom platform of banks and custom platform of connected applicati...
Definition: AkTypes.h:251
AkExternalSourceInfo::AkExternalSourceInfo
AkExternalSourceInfo(AkFileID in_idFile, AkUInt32 in_iExternalSrcCookie, AkCodecID in_idCodec)
Constructor: specify source by streaming file ID.
Definition: AkTypes.h:366
AK_InvalidSwitchType
@ AK_InvalidSwitchType
Invalid switch type (used with the switch container)
Definition: AkTypes.h:233
AkRamp::operator*=
AkRamp & operator*=(const AkRamp &in_rRhs)
Definition: AkTypes.h:936
AkEmitterListenerPair::Occlusion
AkReal32 Occlusion() const
Get the occlusion factor for this emitter-listener pair.
Definition: AkTypes.h:834
AK_FileNotFound
@ AK_FileNotFound
File not found.
Definition: AkTypes.h:236
AkUInt16
uint16_t AkUInt16
Unsigned 16-bit integer.
Definition: AkNumeralTypes.h:37
AkRTPCGraphPoint
AkGraphPointBase< AkReal32 > AkRTPCGraphPoint
Definition: AkTypes.h:971
AkVector::Zero
void Zero()
Definition: AkTypes.h:459
AttenuationCurveID_LowPassFilter
@ AttenuationCurveID_LowPassFilter
The distance-driven low-pass filter (pre send) curve.
Definition: AkTypes.h:979
AK::ConvertAkVectorToAkVector64
AkVector64 ConvertAkVectorToAkVector64(AkVector in)
Definition: AkTypes.h:743
AkWorldTransform::SetOrientation
void SetOrientation(AkReal32 in_orientFrontX, AkReal32 in_orientFrontY, AkReal32 in_orientFrontZ, AkReal32 in_orientTopX, AkReal32 in_orientTopY, AkReal32 in_orientTopZ)
Set orientation. Orientation front and top should be orthogonal and normalized.
Definition: AkTypes.h:569
AK_EnableBusMeter_RMS
@ AK_EnableBusMeter_RMS
Enable computation of RMS metering.
Definition: AkTypes.h:1211
AK
Audiokinetic namespace.
Definition: AkWwiseSDKVersion.cs:31
AkTimeMs
AkInt32 AkTimeMs
Time in ms.
Definition: AkTypes.h:124
AkAuxSendValue
Auxiliary bus sends information per game object per given auxiliary bus.
Definition: AkTypes.h:923
AK_Fail
@ AK_Fail
The operation failed.
Definition: AkTypes.h:202
AkEmitterListenerPair::fEmitterAngle
AkReal32 fEmitterAngle
Angle between position vector and emitter orientation.
Definition: AkTypes.h:866
AttenuationCurveID_DiffractionHPF
@ AttenuationCurveID_DiffractionHPF
The diffraction-driven high-pass filter curve.
Definition: AkTypes.h:991
AttenuationCurveID_VolumeDry
@ AttenuationCurveID_VolumeDry
The distance-driven dry volume curve.
Definition: AkTypes.h:976
AkObstructionOcclusionValues
Obstruction/occlusion pair for a position.
Definition: AkTypes.h:769
AkExternalSourceInfo::pInMemory
void * pInMemory
Pointer to the in-memory file. If not NULL, the source will be read from memory. Set szFile and idFil...
Definition: AkTypes.h:325
AK::SoundEngine::MultiPositionType
MultiPositionType
Definition: AkTypes.h:1144
AkWorldTransform::Set
void Set(const AkVector64 &in_position, const AkVector &in_orientationFront, const AkVector &in_orientationTop)
Set position and orientation. Orientation front and top should be orthogonal and normalized.
Definition: AkTypes.h:503
AkEmitterListenerPair::Diffraction
AkReal32 Diffraction() const
Get the diffraction factor for this emitter-listener pair.
Definition: AkTypes.h:840
AK_DataAlignmentError
@ AK_DataAlignmentError
A pointer to audio data was not aligned to the platform's required alignment (check AkTypes....
Definition: AkTypes.h:257
AkExternalSourceInfo::idCodec
AkCodecID idCodec
Codec ID for the file. One of the audio formats defined in AkTypes.h (AKCODECID_XXX)
Definition: AkTypes.h:323
AttenuationCurveID_DiffractionVolume
@ AttenuationCurveID_DiffractionVolume
The diffraction-driven volume curve.
Definition: AkTypes.h:989
AkModulatorID
AkUInt32 AkModulatorID
Modulator ID.
Definition: AkTypes.h:150
AkRamp::fPrev
AkReal32 fPrev
Definition: AkTypes.h:938
AK_DataReady
@ AK_DataReady
The provider has available data.
Definition: AkTypes.h:227
AkListenerPosition
AkWorldTransform AkListenerPosition
Positioning information for a listener.
Definition: AkTypes.h:765
AK_NotCompatible
@ AK_NotCompatible
Incompatible formats.
Definition: AkTypes.h:204
AkSphericalCoord::phi
AkReal32 phi
Elevation.
Definition: AkTypes.h:792
AK_MAX_PATH
#define AK_MAX_PATH
Maximum path length.
Definition: AkTypes.h:82
AkGroupType_Switch
@ AkGroupType_Switch
Type switch.
Definition: AkTypes.h:279
AkCreateFileSourceCallback
IAkSoftwareCodec *(* AkCreateFileSourceCallback)(void *in_pCtx)
Registered file source creation function prototype.
Definition: AkTypes.h:1098
AkSetPositionFlags_Default
@ AkSetPositionFlags_Default
Definition: AkTypes.h:1176
AttenuationCurveID_VolumeAuxGameDef
@ AttenuationCurveID_VolumeAuxGameDef
The distance-driven game-defined auxiliary send curve.
Definition: AkTypes.h:977
AkRtpcID
AkUInt32 AkRtpcID
Real time parameter control ID.
Definition: AkTypes.h:141
AkAudioObjectID
AkUInt64 AkAudioObjectID
Audio Object ID.
Definition: AkTypes.h:156
AK_SpatializationMode_PositionOnly
@ AK_SpatializationMode_PositionOnly
Spatialization based on emitter position only.
Definition: AkTypes.h:1191
AK_InvalidID
@ AK_InvalidID
The ID is invalid.
Definition: AkTypes.h:209
AkCurveInterpolation_SCurve
@ AkCurveInterpolation_SCurve
S Curve.
Definition: AkTypes.h:908
AkVector64::Zero
void Zero()
Definition: AkTypes.h:413
AttenuationCurveID_Project
@ AttenuationCurveID_Project
Symbol for "Use Project".
Definition: AkTypes.h:998
AkCurveInterpolation_SineRecip
@ AkCurveInterpolation_SineRecip
Reciprocal of sine curve.
Definition: AkTypes.h:910
AK_EnableBusMeter_KPower
@ AK_EnableBusMeter_KPower
Enable computation of K-weighted power metering (used as a basis for computing loudness,...
Definition: AkTypes.h:1213
AK_3DPositionType_EmitterWithAutomation
@ AK_3DPositionType_EmitterWithAutomation
3D spatialization is computed from the emitter game object position, translated by user-defined autom...
Definition: AkTypes.h:1166
ConnectionType_Direct
@ ConnectionType_Direct
Direct (main, dry) connection.
Definition: AkTypes.h:382
AK_InvalidFile
@ AK_InvalidFile
The provided file is the wrong format or unexpected values causes the file to be invalid.
Definition: AkTypes.h:206
AK_SSEInstructionsNotSupported
@ AK_SSEInstructionsNotSupported
The machine does not support SSE instructions (required on PC).
Definition: AkTypes.h:244
AkEmitterListenerPair::Distance
AkReal32 Distance() const
Get distance.
Definition: AkTypes.h:823
AkPipelineID
AkUInt32 AkPipelineID
Unique node (bus, voice) identifier for profiling.
Definition: AkTypes.h:154
AK_NoDistinctListener
@ AK_NoDistinctListener
No distinct listener provided for AddOutput.
Definition: AkTypes.h:265
WwiseObjectIDext::operator==
bool operator==(const WwiseObjectIDext &in_rOther) const
Definition: AkTypes.h:1248
AkSetPositionFlags_Listener
@ AkSetPositionFlags_Listener
Definition: AkTypes.h:1174
AkDeviceDescription::isDefaultDevice
bool isDefaultDevice
Identify default device. Always false when not supported.
Definition: AkTypes.h:305
AK_DLLPathNotFound
@ AK_DLLPathNotFound
Plugin DLL search path could not be found.
Definition: AkTypes.h:253
AK_CommandTooLarge
@ AK_CommandTooLarge
SDK command is too large to fit in the command queue.
Definition: AkTypes.h:249
AK_MaxReached
@ AK_MaxReached
The maximum was reached.
Definition: AkTypes.h:208
AkJobType_Generic
static const AkJobType AkJobType_Generic
Job type for general-purpose work.
Definition: AkTypes.h:192
AkGameObjectID
AkUInt64 AkGameObjectID
Game object ID.
Definition: AkTypes.h:128
AkPluginTypeMixer
@ AkPluginTypeMixer
Mixer plug-in: mix voices at the bus level.
Definition: AkTypes.h:1228
AkNodeType
AkNodeType
Definition: AkTypes.h:1239
AkTransform::Position
const AkVector & Position() const
Get position vector.
Definition: AkTypes.h:601
AkBankID
AkUInt32 AkBankID
Run time bank ID.
Definition: AkTypes.h:143
AkExternalSourceInfo::szFile
AkOSChar * szFile
File path for the source. If not NULL, the source will be streaming from disk. Set pInMemory to NULL....
Definition: AkTypes.h:324
AkTransform::OrientationFront
const AkVector & OrientationFront() const
Get orientation front vector.
Definition: AkTypes.h:607
AkEmitterListenerPair::fSpread
AkReal32 fSpread
Emitter-listener-pair-specific spread.
Definition: AkTypes.h:875
AkTransform::Set
void Set(AkReal32 in_positionX, AkReal32 in_positionY, AkReal32 in_positionZ, AkReal32 in_orientFrontX, AkReal32 in_orientFrontY, AkReal32 in_orientFrontZ, AkReal32 in_orientTopX, AkReal32 in_orientTopY, AkReal32 in_orientTopZ)
Set position and orientation. Orientation front and top should be orthogonal and normalized.
Definition: AkTypes.h:635
AkGraphPointBase::To
VALUE_TYPE To
Represents the value on the Y axis.
Definition: AkTypes.h:961
AkNodeType_Default
@ AkNodeType_Default
Definition: AkTypes.h:1240
AkTransform::OrientationTop
const AkVector & OrientationTop() const
Get orientation top vector.
Definition: AkTypes.h:613
AKRESULT
AKRESULT
Standard function call result.
Definition: AkTypes.h:199
AK_INVALID_DEVICE_ID
static const AkDeviceID AK_INVALID_DEVICE_ID
Invalid streaming device ID.
Definition: AkTypes.h:171
AkRamp::AkRamp
AkRamp()
Definition: AkTypes.h:934
AK_NoDataReady
@ AK_NoDataReady
The provider does not have available data.
Definition: AkTypes.h:228
AkGroupType_State
@ AkGroupType_State
Type state.
Definition: AkTypes.h:280
AK_MIN_PRIORITY
static const AkPriority AK_MIN_PRIORITY
Minimal priority value [0,100].
Definition: AkTypes.h:181
AkMeteringFlags
AkMeteringFlags
Metering flags. Used for specifying bus metering, through AK::SoundEngine::RegisterBusVolumeCallback(...
Definition: AkTypes.h:1207
AK_ResourceInUse
@ AK_ResourceInUse
Resource is in use and cannot be released.
Definition: AkTypes.h:267
AK_DeviceNotFound
@ AK_DeviceNotFound
The specified device ID does not match with any of the output devices that the sound engine is curren...
Definition: AkTypes.h:261
AkDeviceID
AkUInt32 AkDeviceID
I/O device ID.
Definition: AkTypes.h:146
AK_NotInitialized
@ AK_NotInitialized
The component being used is not initialized. Most likely AK::SoundEngine::Init() was not called yet,...
Definition: AkTypes.h:270
AkPolarCoord::r
AkReal32 r
Norm/distance.
Definition: AkTypes.h:785
AK_INVALID_PLUGINID
static const AkPluginID AK_INVALID_PLUGINID
Invalid FX ID.
Definition: AkTypes.h:160
AK_NoMoreData
@ AK_NoMoreData
No more data is available from the source.
Definition: AkTypes.h:212
WwiseObjectID::WwiseObjectID
WwiseObjectID(AkUniqueID in_ID, bool in_bIsBus)
Definition: AkTypes.h:1276
AkCurveInterpolation_Sine
@ AkCurveInterpolation_Sine
Sine.
Definition: AkTypes.h:904
AkImageSourceID
AkUInt32 AkImageSourceID
Image Source ID.
Definition: AkTypes.h:152
AkPluginTypeEffect
@ AkPluginTypeEffect
Effect plug-in: applies processing to audio data.
Definition: AkTypes.h:1225
AkMemPoolId
AkInt32 AkMemPoolId
Memory pool ID.
Definition: AkTypes.h:130
AkArgumentValueID
AkUInt32 AkArgumentValueID
Argument value ID.
Definition: AkTypes.h:148
AkVector64::operator-
AkVector64 operator-(const AkVector64 &b) const
Definition: AkTypes.h:402
AK_NoJavaVM
@ AK_NoJavaVM
No Java VM provided in AkInitSettings.
Definition: AkTypes.h:254
AK_SOUNDBANK_VERSION
static const AkUInt32 AK_SOUNDBANK_VERSION
Version of the soundbank reader.
Definition: AkTypes.h:189
AkEmitterListenerPair::fDistance
AkReal32 fDistance
Distance between emitter and listener.
Definition: AkTypes.h:865
AK_FileFormatMismatch
@ AK_FileFormatMismatch
Media file format unexpected.
Definition: AkTypes.h:264
AK_INVALID_BANK_ID
static const AkBankID AK_INVALID_BANK_ID
Invalid bank ID.
Definition: AkTypes.h:172
AttenuationCurveID_OcclusionHPF
@ AttenuationCurveID_OcclusionHPF
The occlusion-driven high-pass filter curve.
Definition: AkTypes.h:988
AkTransform::Set
void Set(const AkVector &in_position, const AkVector &in_orientationFront, const AkVector &in_orientationTop)
Set position and orientation. Orientation front and top should be orthogonal and normalized.
Definition: AkTypes.h:623
AK_RenderedFX
@ AK_RenderedFX
The effect on the node is rendered.
Definition: AkTypes.h:239
AK_INVALID_AUDIO_OBJECT_ID
static const AkAudioObjectID AK_INVALID_AUDIO_OBJECT_ID
Invalid audio object ID.
Definition: AkTypes.h:177
AkDeviceState_All
@ AkDeviceState_All
Includes audio devices in all states.
Definition: AkTypes.h:297
AkGraphPointBase::AkGraphPointBase
AkGraphPointBase(AkReal32 in_from, VALUE_TYPE in_to, AkCurveInterpolation in_interp)
Definition: AkTypes.h:954
AkChannelMask
AkUInt32 AkChannelMask
Channel mask (similar to WAVE_FORMAT_EXTENSIBLE). Bit values are defined in AkSpeakerConfig....
Definition: AkTypes.h:149
AkLPFType
AkReal32 AkLPFType
Low-pass filter type.
Definition: AkTypes.h:129
AkOSChar
char AkOSChar
Generic character string.
Definition: AkTypes.h:60
AkUInt8
uint8_t AkUInt8
Unsigned 8-bit integer.
Definition: AkNumeralTypes.h:36
AkWorldTransform::Position
const AkVector64 & Position() const
Get position vector.
Definition: AkTypes.h:481
AK_BankReadError
@ AK_BankReadError
Error while reading a bank.
Definition: AkTypes.h:232
AK_InvalidStateGroup
@ AK_InvalidStateGroup
The StateGroup is not a valid channel.
Definition: AkTypes.h:213
AK_DEFAULT_SWITCH_STATE
static const AkUInt32 AK_DEFAULT_SWITCH_STATE
Switch selected if no switch has been set yet.
Definition: AkTypes.h:166
AkWorldTransform::SetPosition
void SetPosition(const AkVector64 &in_position)
Set position.
Definition: AkTypes.h:539
AkExternalSourceInfo::AkExternalSourceInfo
AkExternalSourceInfo(AkOSChar *in_pszFileName, AkUInt32 in_iExternalSrcCookie, AkCodecID in_idCodec)
Constructor: specify source by streaming file name.
Definition: AkTypes.h:353
AK_IDNotFound
@ AK_IDNotFound
The ID was not found.
Definition: AkTypes.h:210
AkPluginTypeMask
@ AkPluginTypeMask
Plug-in type mask is 4 bits.
Definition: AkTypes.h:1232
AkChannelEmitter::padding
char padding[4]
In order to preserve consistent struct size across archs, we need some padding.
Definition: AkTypes.h:779
AkEmitterListenerPair::emitter
AkWorldTransform emitter
Emitter position.
Definition: AkTypes.h:864
AK_BankAlreadyLoaded
@ AK_BankAlreadyLoaded
The bank load failed because the bank is already loaded.
Definition: AkTypes.h:238
AK::SoundEngine::MultiPositionType_SingleSource
@ MultiPositionType_SingleSource
Used for normal sounds, not expected to pass to AK::SoundEngine::SetMultiplePosition() (if done,...
Definition: AkTypes.h:1145
AkVolumeValue
AkReal32 AkVolumeValue
Volume value( also apply to LFE )
Definition: AkTypes.h:127
AkCurveInterpolation_Exp1
@ AkCurveInterpolation_Exp1
Exp1.
Definition: AkTypes.h:909
AttenuationCurveID_TransmissionLPF
@ AttenuationCurveID_TransmissionLPF
The transmission-driven low-pass filter curve.
Definition: AkTypes.h:993
AK_DLLCannotLoad
@ AK_DLLCannotLoad
Plugin DLL could not be loaded, either because it is not found or one dependency is missing.
Definition: AkTypes.h:252
AK_3DPositionType_Emitter
@ AK_3DPositionType_Emitter
3D spatialization is computed directly from the emitter game object position.
Definition: AkTypes.h:1165
AkGraphPointBase::operator==
bool operator==(const AkGraphPointBase &other) const
Definition: AkTypes.h:964
AK_ProcessDone
@ AK_ProcessDone
The executed routine has finished its execution.
Definition: AkTypes.h:241
AkReal32
float AkReal32
32-bit floating point
Definition: AkNumeralTypes.h:46
AK_Success
@ AK_Success
The operation was successful.
Definition: AkTypes.h:201
AkEmitterListenerPair::fObstruction
AkReal32 fObstruction
Emitter-listener-pair-specific obstruction factor.
Definition: AkTypes.h:872
AkInt32
int32_t AkInt32
Signed 32-bit integer.
Definition: AkNumeralTypes.h:43
AkDeviceState_Active
@ AkDeviceState_Active
The audio device is active That is, the audio adapter that connects to the endpoint device is present...
Definition: AkTypes.h:293
AkWorldTransform
Position and orientation of game objects in the world (i.e. supports 64-bit-precision position)
Definition: AkTypes.h:474
AkEmitterListenerPair
Emitter-listener pair: Positioning data pertaining to a single pair of emitter and listener.
Definition: AkTypes.h:797
AkGraphPointBase::From
AkReal32 From
Represents the value on the X axis.
Definition: AkTypes.h:960
AK_PathNodeAlreadyInList
@ AK_PathNodeAlreadyInList
This path is already there.
Definition: AkTypes.h:223
AkSetPositionFlags
AkSetPositionFlags
Flags to independently set the position of the emitter or listener component on a game object.
Definition: AkTypes.h:1172
AkEmitterListenerPair::fGameDefAuxMixGain
AkReal32 fGameDefAuxMixGain
Emitter-listener-pair-specific gain (due to distance and cone attenuation) for game-defined send conn...
Definition: AkTypes.h:869
AkCurveInterpolation_Exp3
@ AkCurveInterpolation_Exp3
Exp3.
Definition: AkTypes.h:911
AkFileID
AkUInt32 AkFileID
Integer-type file identifier.
Definition: AkTypes.h:145
AK_DEFAULT_PRIORITY
static const AkPriority AK_DEFAULT_PRIORITY
Default sound / I/O priority.
Definition: AkTypes.h:180
AK_MemManagerNotInitialized
@ AK_MemManagerNotInitialized
The memory manager should have been initialized at this point.
Definition: AkTypes.h:242
AK_BalanceFadeHeight
@ AK_BalanceFadeHeight
Balance-Fade-Height: Traditional "box" or "car"-like panner.
Definition: AkTypes.h:1157
AkCreateFileCodecCallback
IAkFileCodec *(* AkCreateFileCodecCallback)()
Registered FileCodec creation function prototype.
Definition: AkTypes.h:1102
AK_ProcessNeeded
@ AK_ProcessNeeded
A routine needs to be executed on some CPU.
Definition: AkTypes.h:240
AK::SoundEngine::MultiPositionType_MultiDirections
@ MultiPositionType_MultiDirections
Simulate one sound coming from multiple directions. Useful for repositionning sounds based on wall op...
Definition: AkTypes.h:1147
WwiseObjectID::WwiseObjectID
WwiseObjectID(AkUniqueID in_ID, AkNodeType in_eNodeType)
Definition: AkTypes.h:1282
AK_CannotAddItseflAsAChild
@ AK_CannotAddItseflAsAChild
It is not possible to add itself as its own child.
Definition: AkTypes.h:216
AkExternalSourceInfo::iExternalSrcCookie
AkUInt32 iExternalSrcCookie
Cookie identifying the source, given by hashing the name of the source given in the project....
Definition: AkTypes.h:322
AK_DeviceNotCompatible
@ AK_DeviceNotCompatible
Incompatible Audio device.
Definition: AkTypes.h:258
AkWorldTransform::SetOrientation
void SetOrientation(const AkVector &in_orientationFront, const AkVector &in_orientationTop)
Set orientation. Orientation front and top should be orthogonal and normalized.
Definition: AkTypes.h:559
AkRamp::fNext
AkReal32 fNext
Definition: AkTypes.h:939
AkEmitterListenerPair::EmitterAngle
AkReal32 EmitterAngle() const
Definition: AkTypes.h:827
AK_EnableBusMeter_3DMeter
@ AK_EnableBusMeter_3DMeter
Definition: AkTypes.h:1214
AK_InvalidParameter
@ AK_InvalidParameter
Something is not within bounds, check the documentation of the function returning this code.
Definition: AkTypes.h:217
AK_PluginNotRegistered
@ AK_PluginNotRegistered
Plugin is not registered. Make sure to implement a AK::PluginRegistration class for it and use AK_STA...
Definition: AkTypes.h:256
AttenuationCurveID_MaxCount
@ AttenuationCurveID_MaxCount
The maximum number of curve types.
Definition: AkTypes.h:996
AkVector::Y
AkReal32 Y
Y Position.
Definition: AkTypes.h:468
AK::ConvertAkTransformToAkWorldTransform
AkWorldTransform ConvertAkTransformToAkWorldTransform(AkTransform in)
Definition: AkTypes.h:752
AkUniqueID
AkUInt32 AkUniqueID
Unique 32-bit ID.
Definition: AkTypes.h:120
AkWorldTransform::SetPosition
void SetPosition(AkReal64 in_x, AkReal64 in_y, AkReal64 in_z)
Set position.
Definition: AkTypes.h:547
AkListener::position
AkListenerPosition position
Definition: AkTypes.h:891
AkAudioSettings
Configured audio settings.
Definition: AkTypes.h:285
AkGraphPointBase::AkGraphPointBase
AkGraphPointBase()=default
Ak3DSpatializationMode
Ak3DSpatializationMode
3D spatialization mode.
Definition: AkTypes.h:1189
AkDeviceState_NotPresent
@ AkDeviceState_NotPresent
The audio device is not present because the audio adapter that connects to the endpoint device has be...
Definition: AkTypes.h:295
AkPluginID
AkUInt32 AkPluginID
Source or effect plug-in ID.
Definition: AkTypes.h:131
AkVector::operator+
AkVector operator+(const AkVector &b) const
Definition: AkTypes.h:426
AK_InvalidFloatValue
@ AK_InvalidFloatValue
One parameter has a invalid float value such as NaN, INF or FLT_MAX.
Definition: AkTypes.h:263
AkEmitterListenerPair::ListenerID
AkGameObjectID ListenerID() const
Get listener ID associated with the emitter-listener pair.
Definition: AkTypes.h:862
AK_AudioFileHeaderTooLarge
@ AK_AudioFileHeaderTooLarge
The file header is too large.
Definition: AkTypes.h:207
AkVector::X
AkReal32 X
X Position.
Definition: AkTypes.h:467
AkCurveInterpolation_InvSCurve
@ AkCurveInterpolation_InvSCurve
Inversed S Curve.
Definition: AkTypes.h:906
AkCurveInterpolation_Log3
@ AkCurveInterpolation_Log3
Log3.
Definition: AkTypes.h:903
AkDataTypeID
AkUInt16 AkDataTypeID
Data sample type ID.
Definition: AkTypes.h:137
AK_EnableBusMeter_TruePeak
@ AK_EnableBusMeter_TruePeak
Enable computation of true peak metering (most CPU and memory intensive).
Definition: AkTypes.h:1210
AttenuationCurveID_None
@ AttenuationCurveID_None
Symbol for "None".
Definition: AkTypes.h:999
AkCurveInterpolation_Log1
@ AkCurveInterpolation_Log1
Log1.
Definition: AkTypes.h:905
AttenuationCurveID_ObstructionHPF
@ AttenuationCurveID_ObstructionHPF
The obstruction-driven high-pass filter curve.
Definition: AkTypes.h:985
AK_UnknownFileError
@ AK_UnknownFileError
Rare file error occured, as opposed to AK_FileNotFound or AK_FilePermissionError. This lumps all unre...
Definition: AkTypes.h:272
AttenuationCurveID_OcclusionVolume
@ AttenuationCurveID_OcclusionVolume
The occlusion-driven volume curve.
Definition: AkTypes.h:986
AkAcousticTextureID
AkUInt32 AkAcousticTextureID
Acoustic Texture ID.
Definition: AkTypes.h:151
AkDeviceState_Unknown
@ AkDeviceState_Unknown
The audio device state is unknown or invalid.
Definition: AkTypes.h:292
AK_DeviceNotReady
@ AK_DeviceNotReady
Specified ID doesn't match a valid hardware device: either the device doesn't exist or is disabled.
Definition: AkTypes.h:237
AkCaptureType
AkInt16 AkCaptureType
Default value: capture type is short.
Definition: AkTypes.h:1313
AK_PlayingIDNotFound
@ AK_PlayingIDNotFound
Calling a function with a playing ID that is not known.
Definition: AkTypes.h:262
AkSphericalCoord
Spherical coordinates.
Definition: AkTypes.h:791
AK_Busy
@ AK_Busy
The system is busy and could not process the request.
Definition: AkTypes.h:245
AkEmitterListenerPair::fDiffraction
AkReal32 fDiffraction
Emitter-listener-pair-specific diffraction coefficient.
Definition: AkTypes.h:873
AKCODECID_BANK_BUS
#define AKCODECID_BANK_BUS
Bank encoding for bus banks. These banks are contained in the /bus sub-folder.
Definition: AkTypes.h:1068
AK_AlreadyConnected
@ AK_AlreadyConnected
The stream is already connected to another node.
Definition: AkTypes.h:205
AK_PathNotFound
@ AK_PathNotFound
This path is not known.
Definition: AkTypes.h:219
AkAttenuationCurveType
AkAttenuationCurveType
Curve types of the Attenuation Editor.
Definition: AkTypes.h:975
AK_INVALID_PIPELINE_ID
static const AkPipelineID AK_INVALID_PIPELINE_ID
Invalid pipeline ID (for profiling)
Definition: AkTypes.h:176
AK_InitBankNotLoaded
@ AK_InitBankNotLoaded
The Init bank was not loaded yet, the sound engine isn't completely ready yet.
Definition: AkTypes.h:260
AkCodecID
AkUInt32 AkCodecID
Codec plug-in ID.
Definition: AkTypes.h:132
AkEmitterListenerPair::Obstruction
AkReal32 Obstruction() const
Get the obstruction factor for this emitter-listener pair.
Definition: AkTypes.h:837
AkDataCompID
AkUInt16 AkDataCompID
Data compression format ID.
Definition: AkTypes.h:136
AkChannelEmitter
Positioning information for a sound, with specified subset of its channels.
Definition: AkTypes.h:776
AkRamp
Volume ramp specified by end points "previous" and "next".
Definition: AkTypes.h:933
AkBankTypeEnum
AkBankTypeEnum
Bank types.
Definition: AkTypes.h:1120
AK_PluginMediaNotAvailable
@ AK_PluginMediaNotAvailable
Plugin media is not available for effect.
Definition: AkTypes.h:247
AkPriority
AkInt8 AkPriority
Priority.
Definition: AkTypes.h:135
AkVector::Z
AkReal32 Z
Z Position.
Definition: AkTypes.h:469
AkGroupType
AkGroupType
Game sync group type.
Definition: AkTypes.h:277
operator*
AkRamp operator*(const AkRamp &in_rLhs, const AkRamp &in_rRhs)
Definition: AkTypes.h:941
AkInt16
int16_t AkInt16
Signed 16-bit integer.
Definition: AkNumeralTypes.h:42
AkObstructionOcclusionValues::obstruction
AkReal32 obstruction
ObstructionLevel: [0.0f..1.0f].
Definition: AkTypes.h:771
AK_NUM_JOB_TYPES
static const AkUInt32 AK_NUM_JOB_TYPES
Number of possible job types recognized by the Sound Engine.
Definition: AkTypes.h:195
WwiseObjectID::WwiseObjectID
WwiseObjectID(AkUniqueID in_ID)
Definition: AkTypes.h:1270
AkBusHierarchy_IsMaster
@ AkBusHierarchy_IsMaster
Flag is set to indicate a master bus (may be used in combination with other flags).
Definition: AkTypes.h:1200
AkCurveInterpolation_Constant
@ AkCurveInterpolation_Constant
Constant ( not valid for fading values )
Definition: AkTypes.h:913
AkExternalSourceInfo::AkExternalSourceInfo
AkExternalSourceInfo(void *in_pInMemory, AkUInt32 in_uiMemorySize, AkUInt32 in_iExternalSrcCookie, AkCodecID in_idCodec)
Constructor: specify source by memory.
Definition: AkTypes.h:339
AK_InvalidLanguage
@ AK_InvalidLanguage
The language is invalid (applies to the Low-Level I/O).
Definition: AkTypes.h:215
AkTransform::SetOrientation
void SetOrientation(const AkVector &in_orientationFront, const AkVector &in_orientationTop)
Set orientation. Orientation front and top should be orthogonal and normalized.
Definition: AkTypes.h:679
AkRamp::AkRamp
AkRamp(AkReal32 in_fPrev, AkReal32 in_fNext)
Definition: AkTypes.h:935
AkSoundPosition
AkWorldTransform AkSoundPosition
Positioning information for a sound.
Definition: AkTypes.h:762
AK_INVALID_POOL_ID
static const AkMemPoolId AK_INVALID_POOL_ID
Invalid pool ID.
Definition: AkTypes.h:167
AkPolarCoord
Polar coordinates.
Definition: AkTypes.h:784
AkDeviceState_Unplugged
@ AkDeviceState_Unplugged
The audio device is unplugged.
Definition: AkTypes.h:296
AkVector::operator-
AkVector operator-(const AkVector &b) const
Definition: AkTypes.h:437
AkBusHierarchy_Secondary
@ AkBusHierarchy_Secondary
Flag is set to indicate the secondary bus hierarchy.
Definition: AkTypes.h:1199
AK_NoDataNeeded
@ AK_NoDataNeeded
The consumer does not need more.
Definition: AkTypes.h:226
AkDeviceDescription::deviceName
AkOSChar deviceName[AK_MAX_PATH]
The user-friendly name for the device.
Definition: AkTypes.h:303
AkEmitterListenerPair::GetGainForConnectionType
AkReal32 GetGainForConnectionType(AkConnectionType in_eType) const
Get the emitter-listener-pair-specific gain (due to distance and cone attenuation),...
Definition: AkTypes.h:846
AkPluginTypeSink
@ AkPluginTypeSink
Sink plug-in: implement custom sound engine end point.
Definition: AkTypes.h:1229
AK_INVALID_OUTPUT_DEVICE_ID
static const AkUInt32 AK_INVALID_OUTPUT_DEVICE_ID
Invalid Device ID.
Definition: AkTypes.h:175
AK_PartialSuccess
@ AK_PartialSuccess
The operation succeeded partially.
Definition: AkTypes.h:203
AK::ConvertAkWorldTransformToAkTransform
AkTransform ConvertAkWorldTransformToAkTransform(AkWorldTransform in)
Definition: AkTypes.h:735
AK_SteeringPanner
@ AK_SteeringPanner
Steering panner.
Definition: AkTypes.h:1158
ConnectionType_ReflectionsSend
@ ConnectionType_ReflectionsSend
Connection by a early reflections send.
Definition: AkTypes.h:385
AK_ACP_Error
@ AK_ACP_Error
Generic XMA decoder error.
Definition: AkTypes.h:266
AkCurveInterpolation
AkCurveInterpolation
Curve interpolation types.
Definition: AkTypes.h:900
AK_CALLBACK
#define AK_CALLBACK(_type, _name)
Definition: AkSoundEngineExport.h:87
AttenuationCurveID_VolumeAuxUserDef
@ AttenuationCurveID_VolumeAuxUserDef
The distance-driven user-defined auxiliary send curve.
Definition: AkTypes.h:978
AK_INVALID_SHARE_SET_ID
static const AkPluginID AK_INVALID_SHARE_SET_ID
Invalid Share Set ID.
Definition: AkTypes.h:161
AkPanningRule
AkPanningRule
Headphone / speakers panning rules.
Definition: AkTypes.h:1181
AkSetPositionFlags_Emitter
@ AkSetPositionFlags_Emitter
Definition: AkTypes.h:1173
AkAudioSettings::uNumSamplesPerFrame
AkUInt32 uNumSamplesPerFrame
Number of samples per audio frame (256, 512, 1024 or 2048).
Definition: AkTypes.h:286
AttenuationCurveID_TransmissionVolume
@ AttenuationCurveID_TransmissionVolume
The transmission-driven volume curve.
Definition: AkTypes.h:992
AK_InvalidInstanceID
@ AK_InvalidInstanceID
The InstanceID is invalid.
Definition: AkTypes.h:211
AK_NotImplemented
@ AK_NotImplemented
This feature is not implemented.
Definition: AkTypes.h:200
AkReal64
double AkReal64
64-bit floating point
Definition: AkNumeralTypes.h:47
AkVector::operator*
AkVector operator*(const AkReal32 f) const
Definition: AkTypes.h:448
AkCreateGrainCodecCallback
IAkGrainCodec *(* AkCreateGrainCodecCallback)()
Registered IAkGrainCodec creation function prototype.
Definition: AkTypes.h:1104
AK_INVALID_UNIQUE_ID
static const AkUniqueID AK_INVALID_UNIQUE_ID
Invalid unique 32-bit ID.
Definition: AkTypes.h:163
AkTransform::SetOrientation
void SetOrientation(AkReal32 in_orientFrontX, AkReal32 in_orientFrontY, AkReal32 in_orientFrontZ, AkReal32 in_orientTopX, AkReal32 in_orientTopY, AkReal32 in_orientTopZ)
Set orientation. Orientation front and top should be orthogonal and normalized.
Definition: AkTypes.h:689
AkChannelEmitter::position
AkWorldTransform position
Emitter position.
Definition: AkTypes.h:777
AkStateID
AkUInt32 AkStateID
State ID.
Definition: AkTypes.h:121
AkPluginType
AkPluginType
Definition: AkTypes.h:1221
AkPanningRule_Speakers
@ AkPanningRule_Speakers
Left and right positioned 60 degrees apart (by default - see AK::SoundEngine::GetSpeakerAngles()).
Definition: AkTypes.h:1182
AttenuationCurveID_Spread
@ AttenuationCurveID_Spread
The distance-driven Spread curve.
Definition: AkTypes.h:981
AkCurveInterpolation_Linear
@ AkCurveInterpolation_Linear
Linear (Default)
Definition: AkTypes.h:907
AkListener::bSpatialized
bool bSpatialized
Listener scaling factor (see AK::SoundEngine::SetListenerScalingFactor()).
Definition: AkTypes.h:893
AK::SoundEngine::MultiPositionType_MultiSources
@ MultiPositionType_MultiSources
Simulate multiple sources in one sound playing, adding volumes. For instance, all the torches on your...
Definition: AkTypes.h:1146
WwiseObjectIDext::bIsBus
bool bIsBus
Definition: AkTypes.h:1259
AkPitchValue
AkReal32 AkPitchValue
Pitch value.
Definition: AkTypes.h:126
AK_INVALID_PLAYING_ID
static const AkPlayingID AK_INVALID_PLAYING_ID
Invalid playing ID.
Definition: AkTypes.h:165
AK_DataNeeded
@ AK_DataNeeded
The consumer needs more.
Definition: AkTypes.h:225
AkTransform::SetPosition
void SetPosition(const AkVector &in_position)
Set position.
Definition: AkTypes.h:659
AK::ConvertAkVector64ToAkVector
AkVector ConvertAkVector64ToAkVector(AkVector64 in)
Definition: AkTypes.h:725
AkEmitterListenerPair::fScalingFactor
AkReal32 fScalingFactor
Combined scaling factor due to both emitter and listener.
Definition: AkTypes.h:877
AkDeviceState_Disabled
@ AkDeviceState_Disabled
The audio device is disabled.
Definition: AkTypes.h:294
AKCODECID_BANK_EVENT
#define AKCODECID_BANK_EVENT
Bank encoding for event banks. These banks are contained in the /event sub-folder.
Definition: AkTypes.h:1067
AkUInt64
uint64_t AkUInt64
Unsigned 64-bit integer.
Definition: AkNumeralTypes.h:39
AkSwitchStateID
AkUInt32 AkSwitchStateID
Switch ID.
Definition: AkTypes.h:140
AkEmitterListenerPair::fDryMixGain
AkReal32 fDryMixGain
Emitter-listener-pair-specific gain (due to distance and cone attenuation) for direct connections.
Definition: AkTypes.h:868
AkEmitterListenerPair::fOcclusion
AkReal32 fOcclusion
Emitter-listener-pair-specific occlusion factor.
Definition: AkTypes.h:871
AkVector64::Y
AkReal64 Y
Y Position.
Definition: AkTypes.h:419
AkPanningRule_Headphones
@ AkPanningRule_Headphones
Left and right positioned 180 degrees apart.
Definition: AkTypes.h:1183
AkExternalSourceInfo::AkExternalSourceInfo
AkExternalSourceInfo()
Default constructor.
Definition: AkTypes.h:330
AkEmitterListenerPair::fListenerAngle
AkReal32 fListenerAngle
Angle between position vector and listener orientation.
Definition: AkTypes.h:867
AkPortNumber
AkUInt16 AkPortNumber
Port number.
Definition: AkTypes.h:125
AkExternalSourceInfo::idFile
AkFileID idFile
File ID. If not zero, the source will be streaming from disk. This ID can be anything....
Definition: AkTypes.h:327
AkEmitterListenerPair::uEmitterChannelMask
AkChannelMask uEmitterChannelMask
Channels of the emitter that apply to this ray.
Definition: AkTypes.h:878
AkEmitterListenerPair::fTransmissionLoss
AkReal32 fTransmissionLoss
Emitter-listener-pair-specific transmission occlusion.
Definition: AkTypes.h:874
AKCODECID_BANK
#define AKCODECID_BANK
Bank encoding.
Definition: AkTypes.h:1045
AK_PathNoVertices
@ AK_PathNoVertices
Stuff in vertices before trying to start it.
Definition: AkTypes.h:220
AkPolarCoord::theta
AkReal32 theta
Azimuth.
Definition: AkTypes.h:786
AK_FALLBACK_ARGUMENTVALUE_ID
static const AkArgumentValueID AK_FALLBACK_ARGUMENTVALUE_ID
Fallback argument value ID.
Definition: AkTypes.h:173
AK_PathNotPaused
@ AK_PathNotPaused
Only a paused path can be resumed.
Definition: AkTypes.h:222
AkAudioDeviceState
AkAudioDeviceState
Definition: AkTypes.h:291
AK_SpatializationMode_None
@ AK_SpatializationMode_None
No spatialization.
Definition: AkTypes.h:1190
AK_INVALID_GAME_OBJECT
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
Definition: AkTypes.h:162
AkListener::AkListener
AkListener()
Definition: AkTypes.h:887
AkEmitterListenerPair::ID
AkRayID ID() const
Get the emitter-listener pair's ID.
Definition: AkTypes.h:859
AkBusHierarchy_Primary
@ AkBusHierarchy_Primary
Flag is set to indicate the primary bus hierarchy.
Definition: AkTypes.h:1198
AttenuationCurveID_ObstructionLPF
@ AttenuationCurveID_ObstructionLPF
The obstruction-driven low-pass filter curve.
Definition: AkTypes.h:984
AttenuationCurveID_TransmissionHPF
@ AttenuationCurveID_TransmissionHPF
The transmission-driven high-pass filter curve.
Definition: AkTypes.h:994
AkVector64
3D 64-bit vector. Intended as storage for world positions of sounds and objects, benefiting from 64-b...
Definition: AkTypes.h:390
AkPluginTypeSource
@ AkPluginTypeSource
Source plug-in: creates sound by synthesis method (no input, just output).
Definition: AkTypes.h:1224
AK_ChildAlreadyHasAParent
@ AK_ChildAlreadyHasAParent
The child already has a parent.
Definition: AkTypes.h:214
AkEmitterListenerPair::id
AkRayID id
ID of this emitter-listener pair, unique for a given emitter.
Definition: AkTypes.h:880
AK_UnknownBankID
@ AK_UnknownBankID
Trying to load a bank using an ID which is not defined.
Definition: AkTypes.h:231
AkFileParser
Public data structures for converted file format.
Definition: AkTypes.h:1291
AttenuationCurveID_DiffractionLPF
@ AttenuationCurveID_DiffractionLPF
The diffraction-driven low-pass filter curve.
Definition: AkTypes.h:990
AkRayID
AkUInt32 AkRayID
Unique (per emitter) identifier for an emitter-listener ray.
Definition: AkTypes.h:155
AkFileParser::EnvelopePoint::uAttenuation
AkUInt16 uAttenuation
Position of this point in samples at the source rate.
Definition: AkTypes.h:1297
AK_FilePermissionError
@ AK_FilePermissionError
The file access permissions prevent opening a file.
Definition: AkTypes.h:271
ConnectionType_UserDefSend
@ ConnectionType_UserDefSend
Connection by a user-defined send.
Definition: AkTypes.h:384
AK_StreamMgrNotInitialized
@ AK_StreamMgrNotInitialized
The stream manager should have been initialized at this point.
Definition: AkTypes.h:243
AkGraphPointBase
Type for a point in an RTPC or Attenuation curve.
Definition: AkTypes.h:951
AkUInt32
uint32_t AkUInt32
Unsigned 32-bit integer.
Definition: AkNumeralTypes.h:38
AkEmitterListenerPair::fUserDefAuxMixGain
AkReal32 fUserDefAuxMixGain
Emitter-listener-pair-specific gain (due to distance and cone attenuation) for user-defined send conn...
Definition: AkTypes.h:870
AK_INVALID_FILE_ID
static const AkFileID AK_INVALID_FILE_ID
Invalid file ID.
Definition: AkTypes.h:170
AkPluginParamID
AkInt16 AkPluginParamID
Source or effect plug-in parameter ID.
Definition: AkTypes.h:134
AK_INVALID_AUX_ID
static const AkAuxBusID AK_INVALID_AUX_ID
Invalid auxiliary bus ID (or no Aux bus ID)
Definition: AkTypes.h:169
AK_ElementAlreadyInList
@ AK_ElementAlreadyInList
The item could not be added because it was already in the list.
Definition: AkTypes.h:218
AkSpeakerPanningType
AkSpeakerPanningType
Speaker panning type: type of panning logic when object is not 3D spatialized (i.e....
Definition: AkTypes.h:1155
AK_Cancelled
@ AK_Cancelled
The requested action was cancelled (not an error).
Definition: AkTypes.h:230
AkEmitterListenerPair::~AkEmitterListenerPair
~AkEmitterListenerPair()
Destructor.
Definition: AkTypes.h:820
AkAuxSendValue::listenerID
AkGameObjectID listenerID
Game object ID of the listener associated with this send. Use AK_INVALID_GAME_OBJECT as a wildcard to...
Definition: AkTypes.h:924
AkPluginTypeNone
@ AkPluginTypeNone
Unknown/invalid plug-in type.
Definition: AkTypes.h:1222
WwiseObjectID::WwiseObjectID
WwiseObjectID()
Definition: AkTypes.h:1264
AkAuxBusID
AkUInt32 AkAuxBusID
Auxilliary bus ID.
Definition: AkTypes.h:133
AkOutputDeviceID
AkUInt64 AkOutputDeviceID
Audio Output device ID.
Definition: AkTypes.h:153
AkCodecDescriptor::pBankSrcCreateFunc
AkCreateBankSourceCallback pBankSrcCreateFunc
Definition: AkTypes.h:1109
AkVector64::operator+
AkVector64 operator+(const AkVector64 &b) const
Definition: AkTypes.h:391
AK_DuplicateUniqueID
@ AK_DuplicateUniqueID
Two Wwise objects share the same ID.
Definition: AkTypes.h:259
AttenuationCurveID_ObstructionVolume
@ AttenuationCurveID_ObstructionVolume
The obstruction-driven volume curve.
Definition: AkTypes.h:983
AkWorldTransform::OrientationTop
const AkVector & OrientationTop() const
Get orientation top vector.
Definition: AkTypes.h:493
AkBankType_User
@ AkBankType_User
User-defined bank.
Definition: AkTypes.h:1121
AttenuationCurveID_OcclusionLPF
@ AttenuationCurveID_OcclusionLPF
The occlusion-driven low-pass filter curve.
Definition: AkTypes.h:987
AK_FormatNotReady
@ AK_FormatNotReady
Source format not known yet.
Definition: AkTypes.h:234
AkVector
3D vector for some operations in 3D space. Typically intended only for localized calculations due to ...
Definition: AkTypes.h:425
AK_InsufficientMemory
@ AK_InsufficientMemory
Memory error.
Definition: AkTypes.h:229
AkPluginTypeCodec
@ AkPluginTypeCodec
Compressor/decompressor plug-in (allows support for custom audio file types).
Definition: AkTypes.h:1223
AkCodecDescriptor::pFileSrcCreateFunc
AkCreateFileSourceCallback pFileSrcCreateFunc
Definition: AkTypes.h:1108
AK_3DPositionType_ListenerWithAutomation
@ AK_3DPositionType_ListenerWithAutomation
3D spatialization is computed from the listener game object position, translated by user-defined auto...
Definition: AkTypes.h:1167
AkBusHierarchyFlags
AkBusHierarchyFlags
Bus type bit field.
Definition: AkTypes.h:1197
AkGraphPointBase::Interp
AkCurveInterpolation Interp
The shape of the interpolation curve between this point and the next.
Definition: AkTypes.h:962
AkChannelEmitter::uInputChannels
AkChannelMask uInputChannels
Channels to which the above position applies.
Definition: AkTypes.h:778
AK_DEFAULT_BANK_THROUGHPUT
static const AkReal32 AK_DEFAULT_BANK_THROUGHPUT
Default bank load throughput (1 Mb/ms)
Definition: AkTypes.h:186
AkRtpcValue
AkReal32 AkRtpcValue
Real time parameter control value.
Definition: AkTypes.h:142
AkJobType_SpatialAudio
static const AkJobType AkJobType_SpatialAudio
Job type for Spatial Audio computations.
Definition: AkTypes.h:194
AkListener::fScalingFactor
AkReal32 fScalingFactor
Listener position (see AK::SoundEngine::SetPosition()).
Definition: AkTypes.h:892
AkEmitterListenerPair::ListenerAngle
AkReal32 ListenerAngle() const
Definition: AkTypes.h:831
AttenuationCurveID_HighPassFilter
@ AttenuationCurveID_HighPassFilter
The distance-driven high-pass filter (pre send) curve.
Definition: AkTypes.h:980
AkAudioSettings::uNumSamplesPerSecond
AkUInt32 uNumSamplesPerSecond
Number of samples per second.
Definition: AkTypes.h:287
AkListener
Listener information.
Definition: AkTypes.h:886
AK_OpenSLError
@ AK_OpenSLError
OpenSL returned an error. Check error log for more details.
Definition: AkTypes.h:255
AkSwitchGroupID
AkUInt32 AkSwitchGroupID
Switch group ID.
Definition: AkTypes.h:139
AkEmitterListenerPair::TransmissionLoss
AkReal32 TransmissionLoss() const
Get the transmission loss factor for this emitter-listener pair.
Definition: AkTypes.h:843
AkEmitterListenerPair::fAperture
AkReal32 fAperture
Emitter-listener-pair-specific aperture.
Definition: AkTypes.h:876
AK_PathNotRunning
@ AK_PathNotRunning
Only a running path can be paused.
Definition: AkTypes.h:221
AK_WrongBankVersion
@ AK_WrongBankVersion
The bank version is not compatible with the current bank reader.
Definition: AkTypes.h:235
AkVector64::Z
AkReal64 Z
Z Position.
Definition: AkTypes.h:420
AK_DEFAULT_POOL_ID
static const AkMemPoolId AK_DEFAULT_POOL_ID
Default pool ID, same as AK_INVALID_POOL_ID.
Definition: AkTypes.h:168
AkInt8
int8_t AkInt8
Signed 8-bit integer.
Definition: AkNumeralTypes.h:41
AK_AlreadyInitialized
@ AK_AlreadyInitialized
Init() was called but that element was already initialized.
Definition: AkTypes.h:269
AK_MustBeVirtualized
@ AK_MustBeVirtualized
Sound was Not Allowed to play.
Definition: AkTypes.h:248
AK_MAX_PRIORITY
static const AkPriority AK_MAX_PRIORITY
Maximal priority value [0,100].
Definition: AkTypes.h:182
AkCreateBankSourceCallback
IAkSoftwareCodec *(* AkCreateBankSourceCallback)(void *in_pCtx)
Registered bank source node creation function prototype.
Definition: AkTypes.h:1100
Ak3DPositionType
Ak3DPositionType
3D position type: defines what acts as the emitter position for computing spatialization against the ...
Definition: AkTypes.h:1164
AK_INVALID_RTPC_ID
static const AkRtpcID AK_INVALID_RTPC_ID
Invalid RTPC ID.
Definition: AkTypes.h:164
AkWorldTransform::OrientationFront
const AkVector & OrientationFront() const
Get orientation front vector.
Definition: AkTypes.h:487
AkObstructionOcclusionValues::occlusion
AkReal32 occlusion
OcclusionLevel: [0.0f..1.0f].
Definition: AkTypes.h:770
AkBankType
AkUInt32 AkBankType
Run time bank type.
Definition: AkTypes.h:144
AkConnectionType
AkConnectionType
Nature of the connection binding an input to a bus.
Definition: AkTypes.h:381
AkTransform
Position and orientation of objects in a "local" space.
Definition: AkTypes.h:594
AK_SpatializationMode_PositionAndOrientation
@ AK_SpatializationMode_PositionAndOrientation
Spatialization based on both emitter position and emitter orientation.
Definition: AkTypes.h:1192
AkJobType
AkUInt32 AkJobType
Job type identifier.
Definition: AkTypes.h:157
AkPlayingID
AkUInt32 AkPlayingID
Playing ID.
Definition: AkTypes.h:123
AkCodecDescriptor::pGrainCodecCreateFunc
AkCreateGrainCodecCallback pGrainCodecCreateFunc
Definition: AkTypes.h:1111
ConnectionType_GameDefSend
@ ConnectionType_GameDefSend
Connection by a game-defined send.
Definition: AkTypes.h:383
AK_RejectedByFilter
@ AK_RejectedByFilter
A play request was rejected due to the MIDI filter parameters.
Definition: AkTypes.h:250
AkAuxSendValue::auxBusID
AkAuxBusID auxBusID
Auxiliary bus ID.
Definition: AkTypes.h:925
AkVector64::X
AkReal64 X
X Position.
Definition: AkTypes.h:418
AkCurveInterpolation_LastFadeCurve
@ AkCurveInterpolation_LastFadeCurve
Update this value to reflect last curve available for fades.
Definition: AkTypes.h:912
AkPluginTypeGlobalExtension
@ AkPluginTypeGlobalExtension
Global Extension plug-in: (e.g. Spatial Audio, Interactive Music)
Definition: AkTypes.h:1230
AkWorldTransform::Set
void Set(AkReal64 in_positionX, AkReal64 in_positionY, AkReal64 in_positionZ, AkReal32 in_orientFrontX, AkReal32 in_orientFrontY, AkReal32 in_orientFrontZ, AkReal32 in_orientTopX, AkReal32 in_orientTopY, AkReal32 in_orientTopZ)
Set position and orientation. Orientation front and top should be orthogonal and normalized.
Definition: AkTypes.h:515
AkExternalSourceInfo::uiMemorySize
AkUInt32 uiMemorySize
Size of the data pointed by pInMemory.
Definition: AkTypes.h:326
AkCodecDescriptor::pFileCodecCreateFunc
AkCreateFileCodecCallback pFileCodecCreateFunc
Definition: AkTypes.h:1110
AkBankType_Event
@ AkBankType_Event
Bank generated for one event.
Definition: AkTypes.h:1122
AK_INVALID_CHANNELMASK
static const AkChannelMask AK_INVALID_CHANNELMASK
Invalid channel mask.
Definition: AkTypes.h:174
AkPluginTypeMetadata
@ AkPluginTypeMetadata
Metadata plug-in: applies object-based processing to audio data.
Definition: AkTypes.h:1231
AkDeviceDescription::idDevice
AkUInt32 idDevice
Device ID for Wwise. This is the same as what is returned from AK::GetDeviceID and AK::GetDeviceIDFro...
Definition: AkTypes.h:302
AkTriggerID
AkUInt32 AkTriggerID
Trigger ID.
Definition: AkTypes.h:147
AK_InvalidBankType
@ AK_InvalidBankType
Invalid bank type. The bank type was either supplied through a function call (e.g....
Definition: AkTypes.h:268
AkFileParser::EnvelopePoint
Analyzed envelope point.
Definition: AkTypes.h:1295

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