Wwise Version
Wwise SDK 2021.1.3
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  Version: v2021.1.3 Build: 7665
25  Copyright (c) 2006-2021 Audiokinetic Inc.
26 *******************************************************************************/
27 
28 // AkTypes.h
29 
30 /// \file
31 /// Data type definitions.
32 
33 #ifndef _AK_DATA_TYPES_H_
34 #define _AK_DATA_TYPES_H_
35 
36 // Platform-specific section.
37 //----------------------------------------------------------------------------------------------------
38 #include <AK/AkPlatforms.h>
39 
40 
41 //----------------------------------------------------------------------------------------------------
42 
43 #include <AK/SoundEngine/Common/AkSoundEngineExport.h>
44 
45 #ifndef NULL
46  #ifdef __cplusplus
47  #define NULL 0
48  #else
49  #define NULL ((void *)0)
50  #endif
51 #endif
52 
53 #if defined(AK_CPU_X86_64) || defined(AK_CPU_ARM_64)
54 #define AK_POINTER_64
55 #endif // #if defined(AK_CPU_X86_64) || defined(AK_CPU_ARM_64)
56 
57 typedef AkUInt32 AkUniqueID; ///< Unique 32-bit ID
58 typedef AkUInt32 AkStateID; ///< State ID
59 typedef AkUInt32 AkStateGroupID; ///< State group ID
60 typedef AkUInt32 AkPlayingID; ///< Playing ID
61 typedef AkInt32 AkTimeMs; ///< Time in ms
62 typedef AkUInt16 AkPortNumber; ///< Port number
63 typedef AkReal32 AkPitchValue; ///< Pitch value
64 typedef AkReal32 AkVolumeValue; ///< Volume value( also apply to LFE )
65 typedef AkUInt64 AkGameObjectID; ///< Game object ID
66 typedef AkReal32 AkLPFType; ///< Low-pass filter type
67 typedef AkInt32 AkMemPoolId; ///< Memory pool ID
68 typedef AkUInt32 AkPluginID; ///< Source or effect plug-in ID
69 typedef AkUInt32 AkCodecID; ///< Codec plug-in ID
70 typedef AkUInt32 AkAuxBusID; ///< Auxilliary bus ID
71 typedef AkInt16 AkPluginParamID; ///< Source or effect plug-in parameter ID
72 typedef AkInt8 AkPriority; ///< Priority
73 typedef AkUInt16 AkDataCompID; ///< Data compression format ID
74 typedef AkUInt16 AkDataTypeID; ///< Data sample type ID
75 typedef AkUInt8 AkDataInterleaveID; ///< Data interleaved state ID
76 typedef AkUInt32 AkSwitchGroupID; ///< Switch group ID
77 typedef AkUInt32 AkSwitchStateID; ///< Switch ID
78 typedef AkUInt32 AkRtpcID; ///< Real time parameter control ID
79 typedef AkReal32 AkRtpcValue; ///< Real time parameter control value
80 typedef AkUInt32 AkBankID; ///< Run time bank ID
81 typedef AkUInt32 AkFileID; ///< Integer-type file identifier
82 typedef AkUInt32 AkDeviceID; ///< I/O device ID
83 typedef AkUInt32 AkTriggerID; ///< Trigger ID
84 typedef AkUInt32 AkArgumentValueID; ///< Argument value ID
85 typedef AkUInt32 AkChannelMask; ///< Channel mask (similar to WAVE_FORMAT_EXTENSIBLE). Bit values are defined in AkSpeakerConfig.h.
86 typedef AkUInt32 AkModulatorID; ///< Modulator ID
87 typedef AkUInt32 AkAcousticTextureID; ///< Acoustic Texture ID
88 typedef AkUInt32 AkImageSourceID; ///< Image Source ID
89 typedef AkUInt64 AkOutputDeviceID; ///< Audio Output device ID
90 typedef AkUInt32 AkPipelineID; ///< Unique node (bus, voice) identifier for profiling.
91 typedef AkUInt32 AkRayID; ///< Unique (per emitter) identifier for an emitter-listener ray.
92 typedef AkUInt64 AkAudioObjectID; ///< Audio Object ID
93 
94 // Constants.
95 static const AkPluginID AK_INVALID_PLUGINID = (AkPluginID)-1; ///< Invalid FX ID
96 static const AkGameObjectID AK_INVALID_GAME_OBJECT = (AkGameObjectID)-1; ///< Invalid game object (may also mean all game objects)
97 static const AkUniqueID AK_INVALID_UNIQUE_ID = 0; ///< Invalid unique 32-bit ID
98 static const AkRtpcID AK_INVALID_RTPC_ID = AK_INVALID_UNIQUE_ID;///< Invalid RTPC ID
99 static const AkPlayingID AK_INVALID_PLAYING_ID = AK_INVALID_UNIQUE_ID;///< Invalid playing ID
100 static const AkUInt32 AK_DEFAULT_SWITCH_STATE = 0; ///< Switch selected if no switch has been set yet
101 static const AkMemPoolId AK_INVALID_POOL_ID = -1; ///< Invalid pool ID
102 static const AkMemPoolId AK_DEFAULT_POOL_ID = -1; ///< Default pool ID, same as AK_INVALID_POOL_ID
103 static const AkAuxBusID AK_INVALID_AUX_ID = AK_INVALID_UNIQUE_ID;///< Invalid auxiliary bus ID (or no Aux bus ID)
104 static const AkFileID AK_INVALID_FILE_ID = (AkFileID)-1; ///< Invalid file ID
105 static const AkDeviceID AK_INVALID_DEVICE_ID = (AkDeviceID)-1; ///< Invalid streaming device ID
106 static const AkBankID AK_INVALID_BANK_ID = AK_INVALID_UNIQUE_ID;///< Invalid bank ID
107 static const AkArgumentValueID AK_FALLBACK_ARGUMENTVALUE_ID = 0; ///< Fallback argument value ID
108 static const AkChannelMask AK_INVALID_CHANNELMASK = 0; ///< Invalid channel mask
109 static const AkUInt32 AK_INVALID_OUTPUT_DEVICE_ID = AK_INVALID_UNIQUE_ID;///< Invalid Device ID
110 static const AkPipelineID AK_INVALID_PIPELINE_ID = AK_INVALID_UNIQUE_ID;///< Invalid pipeline ID (for profiling)
111 static const AkAudioObjectID AK_INVALID_AUDIO_OBJECT_ID = (AkAudioObjectID)-1; ///< Invalid audio object ID
112 
113 // Priority.
114 static const AkPriority AK_DEFAULT_PRIORITY = 50; ///< Default sound / I/O priority
115 static const AkPriority AK_MIN_PRIORITY = 0; ///< Minimal priority value [0,100]
116 static const AkPriority AK_MAX_PRIORITY = 100; ///< Maximal priority value [0,100]
117 
118 // Default bank I/O settings.
119 static const AkPriority AK_DEFAULT_BANK_IO_PRIORITY = AK_DEFAULT_PRIORITY; ///< Default bank load I/O priority
120 static const AkReal32 AK_DEFAULT_BANK_THROUGHPUT = 1*1024*1024/1000.f; ///< Default bank load throughput (1 Mb/ms)
121 
122 // Bank version
123 static const AkUInt32 AK_SOUNDBANK_VERSION = 140; ///< Version of the soundbank reader
124 
125 /// Standard function call result.
126 enum AKRESULT
127 {
128  AK_NotImplemented = 0, ///< This feature is not implemented.
129  AK_Success = 1, ///< The operation was successful.
130  AK_Fail = 2, ///< The operation failed.
131  AK_PartialSuccess = 3, ///< The operation succeeded partially.
132  AK_NotCompatible = 4, ///< Incompatible formats
133  AK_AlreadyConnected = 5, ///< The stream is already connected to another node.
134  AK_InvalidFile = 7, ///< An unexpected value causes the file to be invalid.
135  AK_AudioFileHeaderTooLarge = 8, ///< The file header is too large.
136  AK_MaxReached = 9, ///< The maximum was reached.
137  AK_InvalidID = 14, ///< The ID is invalid.
138  AK_IDNotFound = 15, ///< The ID was not found.
139  AK_InvalidInstanceID = 16, ///< The InstanceID is invalid.
140  AK_NoMoreData = 17, ///< No more data is available from the source.
141  AK_InvalidStateGroup = 20, ///< The StateGroup is not a valid channel.
142  AK_ChildAlreadyHasAParent = 21, ///< The child already has a parent.
143  AK_InvalidLanguage = 22, ///< The language is invalid (applies to the Low-Level I/O).
144  AK_CannotAddItseflAsAChild = 23, ///< It is not possible to add itself as its own child.
145  AK_InvalidParameter = 31, ///< Something is not within bounds.
146  AK_ElementAlreadyInList = 35, ///< The item could not be added because it was already in the list.
147  AK_PathNotFound = 36, ///< This path is not known.
148  AK_PathNoVertices = 37, ///< Stuff in vertices before trying to start it
149  AK_PathNotRunning = 38, ///< Only a running path can be paused.
150  AK_PathNotPaused = 39, ///< Only a paused path can be resumed.
151  AK_PathNodeAlreadyInList = 40, ///< This path is already there.
152  AK_PathNodeNotInList = 41, ///< This path is not there.
153  AK_DataNeeded = 43, ///< The consumer needs more.
154  AK_NoDataNeeded = 44, ///< The consumer does not need more.
155  AK_DataReady = 45, ///< The provider has available data.
156  AK_NoDataReady = 46, ///< The provider does not have available data.
157  AK_InsufficientMemory = 52, ///< Memory error.
158  AK_Cancelled = 53, ///< The requested action was cancelled (not an error).
159  AK_UnknownBankID = 54, ///< Trying to load a bank using an ID which is not defined.
160  AK_BankReadError = 56, ///< Error while reading a bank.
161  AK_InvalidSwitchType = 57, ///< Invalid switch type (used with the switch container)
162  AK_FormatNotReady = 63, ///< Source format not known yet.
163  AK_WrongBankVersion = 64, ///< The bank version is not compatible with the current bank reader.
164  AK_FileNotFound = 66, ///< File not found.
165  AK_DeviceNotReady = 67, ///< Specified ID doesn't match a valid hardware device: either the device doesn't exist or is disabled.
166  AK_BankAlreadyLoaded = 69, ///< The bank load failed because the bank is already loaded.
167  AK_RenderedFX = 71, ///< The effect on the node is rendered.
168  AK_ProcessNeeded = 72, ///< A routine needs to be executed on some CPU.
169  AK_ProcessDone = 73, ///< The executed routine has finished its execution.
170  AK_MemManagerNotInitialized = 74, ///< The memory manager should have been initialized at this point.
171  AK_StreamMgrNotInitialized = 75, ///< The stream manager should have been initialized at this point.
172  AK_SSEInstructionsNotSupported = 76,///< The machine does not support SSE instructions (required on PC).
173  AK_Busy = 77, ///< The system is busy and could not process the request.
174  AK_UnsupportedChannelConfig = 78, ///< Channel configuration is not supported in the current execution context.
175  AK_PluginMediaNotAvailable = 79, ///< Plugin media is not available for effect.
176  AK_MustBeVirtualized = 80, ///< Sound was Not Allowed to play.
177  AK_CommandTooLarge = 81, ///< SDK command is too large to fit in the command queue.
178  AK_RejectedByFilter = 82, ///< A play request was rejected due to the MIDI filter parameters.
179  AK_InvalidCustomPlatformName= 83, ///< Detecting incompatibility between Custom platform of banks and custom platform of connected application
180  AK_DLLCannotLoad = 84, ///< Plugin DLL could not be loaded, either because it is not found or one dependency is missing.
181  AK_DLLPathNotFound = 85, ///< Plugin DLL search path could not be found.
182  AK_NoJavaVM = 86, ///< No Java VM provided in AkInitSettings.
183  AK_OpenSLError = 87, ///< OpenSL returned an error. Check error log for more details.
184  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.
185  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)
186  AK_DeviceNotCompatible = 90, ///< Incompatible Audio device.
187  AK_DuplicateUniqueID = 91, ///< Two Wwise objects share the same ID.
188  AK_InitBankNotLoaded = 92, ///< The Init bank was not loaded yet, the sound engine isn't completely ready yet.
189  AK_DeviceNotFound = 93, ///< The specified device ID does not match with any of the output devices that the sound engine is currently using.
190  AK_PlayingIDNotFound = 94, ///< Calling a function with a playing ID that is not known.
191  AK_InvalidFloatValue = 95, ///< One parameter has a invalid float value such as NaN, INF or FLT_MAX.
192  AK_FileFormatMismatch = 96, ///< Media file format unexpected
193  AK_NoDistinctListener = 97, ///< No distinct listener provided for AddOutput
194  AK_ACP_Error = 98, ///< Generic XMA decoder error.
195  AK_ResourceInUse = 99, ///< Resource is in use and cannot be released.
196 };
197 
198 /// Game sync group type
199 enum AkGroupType
200 {
201  // should stay set as Switch = 0 and State = 1
202  AkGroupType_Switch = 0, ///< Type switch
203  AkGroupType_State = 1 ///< Type state
204 };
205 
206 /// Configured audio settings
207 struct AkAudioSettings
208 {
209  AkUInt32 uNumSamplesPerFrame; ///< Number of samples per audio frame (256, 512, 1024 or 2048).
210  AkUInt32 uNumSamplesPerSecond; ///< Number of samples per second.
211 };
212 
213 enum AkAudioDeviceState
214 {
215  AkDeviceState_Unknown = 0, ///< The audio device state is unknown or invalid.
216  AkDeviceState_Active = 1 << 0, ///< The audio device is active That is, the audio adapter that connects to the endpoint device is present and enabled.
217  AkDeviceState_Disabled = 1 << 1, ///< The audio device is disabled.
218  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.
219  AkDeviceState_Unplugged = 1 << 3, ///< The audio device is unplugged.
220  AkDeviceState_All = AkDeviceState_Active | AkDeviceState_Disabled | AkDeviceState_NotPresent | AkDeviceState_Unplugged, ///< Includes audio devices in all states.
221 };
222 
223 struct AkDeviceDescription
224 {
225  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.
226  AkOSChar deviceName[AK_MAX_PATH]; ///< The user-friendly name for the device.
227  AkAudioDeviceState deviceStateMask = AkDeviceState_Unknown; ///< Bitmask used to filter the device based on their state.
228  bool isDefaultDevice = false; ///< Identify default device. Always false when not supported.
229 };
230 
231 /// This structure allows the game to provide audio files to fill the external sources. See \ref AK::SoundEngine::PostEvent
232 /// You can specify a streaming file or a file in-memory, regardless of the "Stream" option in the Wwise project.
233 /// \akwarning
234 /// 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).
235 /// \endakwarning
236 struct AkExternalSourceInfo
237 {
238  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
239  AkCodecID idCodec; ///< Codec ID for the file. One of the audio formats defined in AkTypes.h (AKCODECID_XXX)
240  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).
241  void* pInMemory; ///< Pointer to the in-memory file. If not NULL, the source will be read from memory. Set szFile and idFile to NULL.
242  AkUInt32 uiMemorySize; ///< Size of the data pointed by pInMemory
243  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.
244 
245  /// Default constructor.
246  AkExternalSourceInfo()
247  : iExternalSrcCookie( 0 )
248  , idCodec( 0 )
249  , szFile( 0 )
250  , pInMemory( 0 )
251  , uiMemorySize( 0 )
252  , idFile( 0 ) {}
253 
254  /// Constructor: specify source by memory.
255  AkExternalSourceInfo(
256  void* in_pInMemory, ///< Pointer to the in-memory file.
257  AkUInt32 in_uiMemorySize, ///< Size of data.
258  AkUInt32 in_iExternalSrcCookie, ///< Cookie.
259  AkCodecID in_idCodec ///< Codec ID.
260  )
261  : iExternalSrcCookie( in_iExternalSrcCookie )
262  , idCodec( in_idCodec )
263  , szFile( 0 )
264  , pInMemory( in_pInMemory )
265  , uiMemorySize( in_uiMemorySize )
266  , idFile( 0 ) {}
267 
268  /// Constructor: specify source by streaming file name.
269  AkExternalSourceInfo(
270  AkOSChar * in_pszFileName, ///< File name.
271  AkUInt32 in_iExternalSrcCookie, ///< Cookie.
272  AkCodecID in_idCodec ///< Codec ID.
273  )
274  : iExternalSrcCookie( in_iExternalSrcCookie )
275  , idCodec( in_idCodec )
276  , szFile( in_pszFileName )
277  , pInMemory( 0 )
278  , uiMemorySize( 0 )
279  , idFile( 0 ) {}
280 
281  /// Constructor: specify source by streaming file ID.
282  AkExternalSourceInfo(
283  AkFileID in_idFile, ///< File ID.
284  AkUInt32 in_iExternalSrcCookie, ///< Cookie.
285  AkCodecID in_idCodec ///< Codec ID.
286  )
287  : iExternalSrcCookie( in_iExternalSrcCookie )
288  , idCodec( in_idCodec )
289  , szFile( 0 )
290  , pInMemory( 0 )
291  , uiMemorySize( 0 )
292  , idFile( in_idFile ) {}
293 };
294 
295 /// Nature of the connection binding an input to a bus.
296 enum AkConnectionType
297 {
298  ConnectionType_Direct = 0x0, ///< Direct (main, dry) connection.
299  ConnectionType_GameDefSend = 0x1, ///< Connection by a game-defined send.
300  ConnectionType_UserDefSend = 0x2, ///< Connection by a user-defined send.
301  ConnectionType_ReflectionsSend = 0x3, ///< Connection by a early reflections send.
302 };
303 
304 /// 3D vector.
305 struct AkVector
306 {
307  inline AkVector operator+(const AkVector& b) const
308  {
309  AkVector v;
310 
311  v.X = X + b.X;
312  v.Y = Y + b.Y;
313  v.Z = Z + b.Z;
314 
315  return v;
316  }
317 
318  inline void Zero()
319  {
320  X = 0; Y = 0; Z = 0;
321  }
322 
323  AkReal32 X; ///< X Position
324  AkReal32 Y; ///< Y Position
325  AkReal32 Z; ///< Z Position
326 };
327 
328 /// Position and orientation of game objects.
329 class AkTransform
330 {
331 public:
332  //
333  // Getters.
334  //
335 
336  /// Get position vector.
337  inline const AkVector & Position() const
338  {
339  return position;
340  }
341 
342  /// Get orientation front vector.
343  inline const AkVector & OrientationFront() const
344  {
345  return orientationFront;
346  }
347 
348  /// Get orientation top vector.
349  inline const AkVector & OrientationTop() const
350  {
351  return orientationTop;
352  }
353 
354  //
355  // Setters.
356  //
357 
358  /// Set position and orientation. Orientation front and top should be orthogonal and normalized.
359  inline void Set(
360  const AkVector & in_position, ///< Position vector.
361  const AkVector & in_orientationFront, ///< Orientation front
362  const AkVector & in_orientationTop ///< Orientation top
363  )
364  {
365  position = in_position;
366  orientationFront = in_orientationFront;
367  orientationTop = in_orientationTop;
368  }
369 
370  /// Set position and orientation. Orientation front and top should be orthogonal and normalized.
371  inline void Set(
372  AkReal32 in_positionX, ///< Position x
373  AkReal32 in_positionY, ///< Position y
374  AkReal32 in_positionZ, ///< Position z
375  AkReal32 in_orientFrontX, ///< Orientation front x
376  AkReal32 in_orientFrontY, ///< Orientation front y
377  AkReal32 in_orientFrontZ, ///< Orientation front z
378  AkReal32 in_orientTopX, ///< Orientation top x
379  AkReal32 in_orientTopY, ///< Orientation top y
380  AkReal32 in_orientTopZ ///< Orientation top z
381  )
382  {
383  position.X = in_positionX;
384  position.Y = in_positionY;
385  position.Z = in_positionZ;
386  orientationFront.X = in_orientFrontX;
387  orientationFront.Y = in_orientFrontY;
388  orientationFront.Z = in_orientFrontZ;
389  orientationTop.X = in_orientTopX;
390  orientationTop.Y = in_orientTopY;
391  orientationTop.Z = in_orientTopZ;
392  }
393 
394  /// Set position.
395  inline void SetPosition(
396  const AkVector & in_position ///< Position vector.
397  )
398  {
399  position = in_position;
400  }
401 
402  /// Set position.
403  inline void SetPosition(
404  AkReal32 in_x, ///< x
405  AkReal32 in_y, ///< y
406  AkReal32 in_z ///< z
407  )
408  {
409  position.X = in_x;
410  position.Y = in_y;
411  position.Z = in_z;
412  }
413 
414  /// Set orientation. Orientation front and top should be orthogonal and normalized.
415  inline void SetOrientation(
416  const AkVector & in_orientationFront, ///< Orientation front
417  const AkVector & in_orientationTop ///< Orientation top
418  )
419  {
420  orientationFront = in_orientationFront;
421  orientationTop = in_orientationTop;
422  }
423 
424  /// Set orientation. Orientation front and top should be orthogonal and normalized.
425  inline void SetOrientation(
426  AkReal32 in_orientFrontX, ///< Orientation front x
427  AkReal32 in_orientFrontY, ///< Orientation front y
428  AkReal32 in_orientFrontZ, ///< Orientation front z
429  AkReal32 in_orientTopX, ///< Orientation top x
430  AkReal32 in_orientTopY, ///< Orientation top y
431  AkReal32 in_orientTopZ ///< Orientation top z
432  )
433  {
434  orientationFront.X = in_orientFrontX;
435  orientationFront.Y = in_orientFrontY;
436  orientationFront.Z = in_orientFrontZ;
437  orientationTop.X = in_orientTopX;
438  orientationTop.Y = in_orientTopY;
439  orientationTop.Z = in_orientTopZ;
440  }
441 
442 private:
443  AkVector orientationFront; ///< Orientation of the listener
444  AkVector orientationTop; ///< Top orientation of the listener
445  AkVector position; ///< Position of the listener
446 };
447 
448 /// Positioning information for a sound.
449 typedef AkTransform AkSoundPosition;
450 
451 /// Positioning information for a listener.
452 typedef AkTransform AkListenerPosition;
453 
454 /// Obstruction/occlusion pair for a position
455 struct AkObstructionOcclusionValues
456 {
457  AkReal32 occlusion; ///< OcclusionLevel: [0.0f..1.0f]
458  AkReal32 obstruction; ///< ObstructionLevel: [0.0f..1.0f]
459 };
460 
461 /// Positioning information for a sound, with specified subset of its channels.
462 struct AkChannelEmitter
463 {
464  AkTransform position; ///< Emitter position.
465  AkChannelMask uInputChannels; ///< Channels to which the above position applies.
466 };
467 
468 /// Polar coordinates.
469 struct AkPolarCoord
470 {
471  AkReal32 r; ///< Norm/distance
472  AkReal32 theta; ///< Azimuth
473 };
474 
475 /// Spherical coordinates.
476 struct AkSphericalCoord : public AkPolarCoord
477 {
478  AkReal32 phi; ///< Elevation
479 };
480 
481 /// Emitter-listener pair: Positioning data pertaining to a single pair of emitter and listener.
482 class AkEmitterListenerPair
483 {
484 public:
485  /// Constructor.
486  AkEmitterListenerPair()
487  : fDistance(0.f)
488  , fEmitterAngle(0.f)
489  , fListenerAngle(0.f)
490  , fDryMixGain(1.f)
491  , fGameDefAuxMixGain(1.f)
492  , fUserDefAuxMixGain(1.f)
493  , fOcclusion(0.f)
494  , fObstruction(0.f)
495  , fDiffraction(0.f)
496  , fTransmissionLoss(0.f)
497  , fSpread(0.f)
498  , fAperture(100.f)
499  , fScalingFactor(1.f)
500  , uEmitterChannelMask(0xFFFFFFFF)
501  , id(0)
502  , m_uListenerID(0)
503  {
504  }
505  /// Destructor.
506  ~AkEmitterListenerPair() {}
507 
508  /// Get distance.
509  inline AkReal32 Distance() const { return fDistance; }
510 
511  /// Get the absolute angle, in radians between 0 and pi, of the emitter's orientation relative to
512  /// the line that joins the emitter and the listener.
513  inline AkReal32 EmitterAngle() const { return fEmitterAngle; }
514 
515  /// Get the absolute angle, in radians between 0 and pi, of the listener's orientation relative to
516  /// the line that joins the emitter and the listener
517  inline AkReal32 ListenerAngle() const { return fListenerAngle; }
518 
519  /// Get the occlusion factor for this emitter-listener pair
520  inline AkReal32 Occlusion() const { return fOcclusion; }
521 
522  /// Get the obstruction factor for this emitter-listener pair
523  inline AkReal32 Obstruction() const { return fObstruction; }
524 
525  /// Get the diffraction factor for this emitter-listener pair
526  inline AkReal32 Diffraction() const { return fDiffraction; }
527 
528  /// Get the transmission loss factor for this emitter-listener pair
529  inline AkReal32 TransmissionLoss() const { return fTransmissionLoss; }
530 
531  /// Get the emitter-listener-pair-specific gain (due to distance and cone attenuation), linear [0,1], for a given connection type.
532  inline AkReal32 GetGainForConnectionType(AkConnectionType in_eType) const
533  {
534  if (in_eType == ConnectionType_Direct)
535  return fDryMixGain;
536  else if (in_eType == ConnectionType_GameDefSend)
537  return fGameDefAuxMixGain;
538  else if (in_eType == ConnectionType_UserDefSend)
539  return fUserDefAuxMixGain;
540  else
541  return 1.0f;
542  }
543 
544  /// Get the emitter-listener pair's ID.
545  inline AkRayID ID() const { return id; }
546 
547  /// Get listener ID associated with the emitter-listener pair.
548  inline AkGameObjectID ListenerID() const { return m_uListenerID; }
549 
550  AkTransform emitter; ///< Emitter position.
551  AkReal32 fDistance; ///< Distance between emitter and listener.
552  AkReal32 fEmitterAngle; ///< Angle between position vector and emitter orientation.
553  AkReal32 fListenerAngle; ///< Angle between position vector and listener orientation.
554  AkReal32 fDryMixGain; ///< Emitter-listener-pair-specific gain (due to distance and cone attenuation) for direct connections.
555  AkReal32 fGameDefAuxMixGain; ///< Emitter-listener-pair-specific gain (due to distance and cone attenuation) for game-defined send connections.
556  AkReal32 fUserDefAuxMixGain; ///< Emitter-listener-pair-specific gain (due to distance and cone attenuation) for user-defined send connections.
557  AkReal32 fOcclusion; ///< Emitter-listener-pair-specific occlusion factor
558  AkReal32 fObstruction; ///< Emitter-listener-pair-specific obstruction factor
559  AkReal32 fDiffraction; ///< Emitter-listener-pair-specific diffraction coefficient
560  AkReal32 fTransmissionLoss; ///< Emitter-listener-pair-specific transmission occlusion.
561  AkReal32 fSpread; ///< Emitter-listener-pair-specific spread
562  AkReal32 fAperture; ///< Emitter-listener-pair-specific aperture
563  AkReal32 fScalingFactor; ///< Combined scaling factor due to both emitter and listener.
564  AkChannelMask uEmitterChannelMask; ///< Channels of the emitter that apply to this ray.
565 protected:
566  AkRayID id; ///< ID of this emitter-listener pair, unique for a given emitter.
567  AkGameObjectID m_uListenerID; ///< Listener game object ID.
568 };
569 
570 /// Listener information.
571 struct AkListener
572 {
573  AkListener()
574  : fScalingFactor( 1.0f )
575  , bSpatialized( true )
576  {}
577  AkListenerPosition position; /// Listener position (see AK::SoundEngine::SetPosition()).
578  AkReal32 fScalingFactor; /// Listener scaling factor (see AK::SoundEngine::SetListenerScalingFactor()).
579  bool bSpatialized; /// Whether listener is spatialized or not (see AK::SoundEngine::SetListenerSpatialization()).
580 };
581 
582 // If you modify AkCurveInterpolation, don't forget to modify WAAPI validation schema accordingly.
583 
584 /// Curve interpolation types
585 enum AkCurveInterpolation
586 {
587 //DONT GO BEYOND 15! (see below for details)
588 //Curves from 0 to LastFadeCurve NEED TO BE A MIRROR IMAGE AROUND LINEAR (eg. Log3 is the inverse of Exp3)
589  AkCurveInterpolation_Log3 = 0, ///< Log3
590  AkCurveInterpolation_Sine = 1, ///< Sine
591  AkCurveInterpolation_Log1 = 2, ///< Log1
592  AkCurveInterpolation_InvSCurve = 3, ///< Inversed S Curve
593  AkCurveInterpolation_Linear = 4, ///< Linear (Default)
594  AkCurveInterpolation_SCurve = 5, ///< S Curve
595  AkCurveInterpolation_Exp1 = 6, ///< Exp1
596  AkCurveInterpolation_SineRecip = 7, ///< Reciprocal of sine curve
597  AkCurveInterpolation_Exp3 = 8, ///< Exp3
598  AkCurveInterpolation_LastFadeCurve = 8, ///< Update this value to reflect last curve available for fades
599  AkCurveInterpolation_Constant = 9 ///< Constant ( not valid for fading values )
600 //DONT GO BEYOND 15! The value is stored on 5 bits,
601 //but we can use only 4 bits for the actual values, keeping
602 //the 5th bit at 0 to void problems when the value is
603 //expanded to 32 bits.
604 };
605 #define AKCURVEINTERPOLATION_NUM_STORAGE_BIT 5 ///< Internal storage restriction, for internal use only.
606 
607 /// Auxiliary bus sends information per game object per given auxiliary bus.
608 struct AkAuxSendValue
609 {
610  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).
611  AkAuxBusID auxBusID; ///< Auxiliary bus ID.
612  AkReal32 fControlValue; ///< A value in the range [0.0f:16.0f] ( -∞ dB to +24 dB).
613  ///< Represents the attenuation or amplification factor applied to the volume of the sound going through the auxiliary bus.
614  ///< A value greater than 1.0f will amplify the sound.
615 };
616 
617 /// Volume ramp specified by end points "previous" and "next".
618 struct AkRamp
619 {
620  AkRamp() : fPrev( 1.f ), fNext( 1.f ) {}
621  AkRamp( AkReal32 in_fPrev, AkReal32 in_fNext ) : fPrev( in_fPrev ), fNext( in_fNext ) {}
622  AkRamp & operator*=(const AkRamp& in_rRhs) { fPrev *= in_rRhs.fPrev; fNext *= in_rRhs.fNext; return *this; }
623 
624  AkReal32 fPrev;
625  AkReal32 fNext;
626 };
627 inline AkRamp operator*(const AkRamp& in_rLhs, const AkRamp& in_rRhs)
628 {
629  AkRamp result(in_rLhs);
630  result *= in_rRhs;
631  return result;
632 }
633 
634 // ---------------------------------------------------------------
635 // Languages
636 // ---------------------------------------------------------------
637 #define AK_MAX_LANGUAGE_NAME_SIZE (32)
638 
639 // ---------------------------------------------------------------
640 // File Type ID Definitions
641 // ---------------------------------------------------------------
642 
643 // These correspond to IDs specified in the conversion plug-ins' XML
644 // files. Audio sources persist them to "remember" their format.
645 // DO NOT CHANGE THEM without talking to someone in charge of persistence!
646 
647 // Company ID for plugin development.
648 #define AKCOMPANYID_PLUGINDEV_MIN (64)
649 #define AKCOMPANYID_PLUGINDEV_MAX (255)
650 
651 // Vendor ID.
652 #define AKCOMPANYID_AUDIOKINETIC (0) ///< Audiokinetic inc.
653 #define AKCOMPANYID_AUDIOKINETIC_EXTERNAL (1) ///< Audiokinetic inc.
654 #define AKCOMPANYID_MCDSP (256) ///< McDSP
655 #define AKCOMPANYID_WAVEARTS (257) ///< WaveArts
656 #define AKCOMPANYID_PHONETICARTS (258) ///< Phonetic Arts
657 #define AKCOMPANYID_IZOTOPE (259) ///< iZotope
658 #define AKCOMPANYID_CRANKCASEAUDIO (261) ///< Crankcase Audio
659 #define AKCOMPANYID_IOSONO (262) ///< IOSONO
660 #define AKCOMPANYID_AUROTECHNOLOGIES (263) ///< Auro Technologies
661 #define AKCOMPANYID_DOLBY (264) ///< Dolby
662 #define AKCOMPANYID_TWOBIGEARS (265) ///< Two Big Ears
663 #define AKCOMPANYID_OCULUS (266) ///< Oculus
664 #define AKCOMPANYID_BLUERIPPLESOUND (267) ///< Blue Ripple Sound
665 #define AKCOMPANYID_ENZIEN (268) ///< Enzien Audio
666 #define AKCOMPANYID_KROTOS (269) ///< Krotos (Dehumanizer)
667 #define AKCOMPANYID_NURULIZE (270) ///< Nurulize
668 #define AKCOMPANYID_SUPERPOWERED (271) ///< Super Powered
669 #define AKCOMPANYID_GOOGLE (272) ///< Google
670 //#define AKCOMPANYID_NVIDIA (273) ///< NVIDIA // Commented out to avoid redefinition, provider is already defining it.
671 //#define AKCOMPANYID_RESERVED (274) ///< Reserved // Commented out to avoid redefinition, provider is already defining it.
672 //#define AKCOMPANYID_MICROSOFT (275) ///< Microsoft // Commented out to avoid redefinition, provider is already defining it.
673 //#define AKCOMPANYID_YAMAHA (276) ///< YAMAHA // Commented out to avoid redefinition, provider is already defining it.
674 #define AKCOMPANYID_VISISONICS (277) ///< Visisonics
675 
676 // File/encoding types of Audiokinetic.
677 #define AKCODECID_BANK (0) ///< Bank encoding
678 #define AKCODECID_PCM (1) ///< PCM encoding
679 #define AKCODECID_ADPCM (2) ///< ADPCM encoding
680 #define AKCODECID_XMA (3) ///< XMA encoding
681 #define AKCODECID_VORBIS (4) ///< Vorbis encoding
682 #define AKCODECID_WIIADPCM (5) ///< ADPCM encoding on the Wii
683 #define AKCODECID_PCMEX (7) ///< Standard PCM WAV file parser for Wwise Authoring
684 #define AKCODECID_EXTERNAL_SOURCE (8) ///< External Source (unknown encoding)
685 #define AKCODECID_XWMA (9) ///< xWMA encoding
686 #define AKCODECID_AAC (10) ///< AAC encoding (only available on Apple devices) -- see AkAACFactory.h
687 #define AKCODECID_FILE_PACKAGE (11) ///< File package files generated by the File Packager utility.
688 #define AKCODECID_ATRAC9 (12) ///< ATRAC-9 encoding
689 #define AKCODECID_VAG (13) ///< VAG/HE-VAG encoding
690 #define AKCODECID_PROFILERCAPTURE (14) ///< Profiler capture file (.prof) as written through AK::SoundEngine::StartProfilerCapture
691 #define AKCODECID_ANALYSISFILE (15) ///< Analysis file
692 #define AKCODECID_MIDI (16) ///< MIDI file
693 #define AKCODECID_OPUSNX (17) ///< OpusNX encoding
694 #define AKCODECID_CAF (18) ///< CAF file
695 #define AKCODECID_AKOPUS (19) ///< Opus encoding, 2018.1 to 2019.2
696 #define AKCODECID_AKOPUS_WEM (20) ///< Opus encoding, wrapped in WEM
697 #define AKCODECID_MEMORYMGR_DUMP (21) ///< Memory stats file as written through AK::MemoryMgr::DumpToFile();
698 
699 #define AKPLUGINID_METER (129) ///< Meter Plugin
700 #define AKPLUGINID_RECORDER (132) ///< Recorder Plugin
701 #define AKPLUGINID_IMPACTER (184)
702 #define AKPLUGINID_SYSTEM_OUTPUT_META (900) ///< System output metadata
703 
704 #define AKEXTENSIONID_SPATIALAUDIO (800) ///< Spatial Audio
705 #define AKEXTENSIONID_INTERACTIVEMUSIC (801) ///< Interactive Music
706 #define AKEXTENSIONID_EVENTMGRTHREAD (900) ///< Profiling: Event Manager
707 
708 //The following are internally defined
709 #define AK_WAVE_FORMAT_VAG 0xFFFB
710 #define AK_WAVE_FORMAT_AT9 0xFFFC
711 #define AK_WAVE_FORMAT_VORBIS 0xFFFF
712 #define AK_WAVE_FORMAT_AAC 0xAAC0
713 #define AK_WAVE_FORMAT_OPUSNX 0x3039
714 #define AK_WAVE_FORMAT_OPUS 0x3040
715 #define AK_WAVE_FORMAT_OPUS_WEM 0x3041
716 #define WAVE_FORMAT_XMA2 0x166
717 
718 //-----------------------------------------------------------------------------
719 // Codecs
720 //-----------------------------------------------------------------------------
721 
722 class IAkSoftwareCodec;
723 class IAkFileCodec;
724 class IAkGrainCodec;
725 /// Registered file source creation function prototype.
726 AK_CALLBACK( IAkSoftwareCodec*, AkCreateFileSourceCallback )( void* in_pCtx );
727 /// Registered bank source node creation function prototype.
728 AK_CALLBACK( IAkSoftwareCodec*, AkCreateBankSourceCallback )( void* in_pCtx );
729 /// Registered FileCodec creation function prototype.
730 AK_CALLBACK( IAkFileCodec*, AkCreateFileCodecCallback )();
731 /// Registered IAkGrainCodec creation function prototype.
732 AK_CALLBACK( IAkGrainCodec*, AkCreateGrainCodecCallback )();
733 
734 struct AkCodecDescriptor
735 {
736  AkCreateFileSourceCallback pFileSrcCreateFunc; // File VPL source.
737  AkCreateBankSourceCallback pBankSrcCreateFunc; // Bank VPL source.
738  AkCreateFileCodecCallback pFileCodecCreateFunc; // FileCodec utility.
739  AkCreateGrainCodecCallback pGrainCodecCreateFunc; // GrainCodec utility.
740 };
741 
742 
743 //-----------------------------------------------------------------------------
744 // Positioning
745 //-----------------------------------------------------------------------------
746 
747 namespace AK
748 {
749  namespace SoundEngine
750  {
751  // If you modify MultiPositionType, don't forget to modify WAAPI validation schema accordingly.
752 
753  /// MultiPositionType.
754  /// \sa
755  /// - AK::SoundEngine::SetMultiplePosition()
756  /// - \ref soundengine_3dpositions_multiplepos
757  enum MultiPositionType
758  {
759  MultiPositionType_SingleSource, ///< Used for normal sounds, not expected to pass to AK::SoundEngine::SetMultiplePosition() (if done, only the first position will be used).
760  MultiPositionType_MultiSources, ///< Simulate multiple sources in one sound playing, adding volumes. For instance, all the torches on your level emitting using only one sound.
761  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 ).
762  };
763  }
764 }
765 
766 #define AK_PANNER_NUM_STORAGE_BITS 3
767 /// Speaker panning type: type of panning logic when object is not 3D spatialized (i.e. when Ak3DSpatializationMode is AK_SpatializationMode_None).
768 enum AkSpeakerPanningType
769 {
770  AK_DirectSpeakerAssignment = 0, ///< No panning: route to matching channels between input and output.
771  AK_BalanceFadeHeight = 1, ///< Balance-Fade-Height: Traditional "box" or "car"-like panner.
772  AK_SteeringPanner = 2 ///< Steering panner.
773 };
774 
775 #define AK_POSSOURCE_NUM_STORAGE_BITS 3
776 /// 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.
777 enum Ak3DPositionType
778 {
779  AK_3DPositionType_Emitter = 0, ///< 3D spatialization is computed directly from the emitter game object position.
780  AK_3DPositionType_EmitterWithAutomation = 1, ///< 3D spatialization is computed from the emitter game object position, translated by user-defined automation.
781  AK_3DPositionType_ListenerWithAutomation = 2 ///< 3D spatialization is computed from the listener game object position, translated by user-defined automation.
782 };
783 
784 /// Headphone / speakers panning rules
785 enum AkPanningRule
786 {
787  AkPanningRule_Speakers = 0, ///< Left and right positioned 60 degrees apart (by default - see AK::SoundEngine::GetSpeakerAngles()).
788  AkPanningRule_Headphones = 1 ///< Left and right positioned 180 degrees apart.
789 };
790 
791 #define AK_SPAT_NUM_STORAGE_BITS 3
792 /// 3D spatialization mode.
793 enum Ak3DSpatializationMode
794 {
795  AK_SpatializationMode_None = 0, ///< No spatialization
796  AK_SpatializationMode_PositionOnly = 1, ///< Spatialization based on emitter position only.
797  AK_SpatializationMode_PositionAndOrientation = 2 ///< Spatialization based on both emitter position and emitter orientation.
798 };
799 
800 /// Bus type bit field.
801 enum AkBusHierarchyFlags
802 {
803  AkBusHierarchy_Primary = 1 << 0, ///< Flag is set to indicate the primary bus hierarchy.
804  AkBusHierarchy_Secondary = 1 << 1, ///< Flag is set to indicate the secondary bus hierarchy.
805  AkBusHierarchy_IsMaster = 1 << 7 ///< Flag is set to indicate a master bus (may be used in combination with other flags).
806 };
807 
808 #define AK_MAX_BITS_METERING_FLAGS (5) // Keep in sync with AkMeteringFlags.
809 
810 /// Metering flags. Used for specifying bus metering, through AK::SoundEngine::RegisterBusVolumeCallback() or AK::IAkMixerPluginContext::SetMeteringFlags().
811 enum AkMeteringFlags
812 {
813  AK_NoMetering = 0, ///< No metering.
814  AK_EnableBusMeter_Peak = 1 << 0, ///< Enable computation of peak metering.
815  AK_EnableBusMeter_TruePeak = 1 << 1, ///< Enable computation of true peak metering (most CPU and memory intensive).
816  AK_EnableBusMeter_RMS = 1 << 2, ///< Enable computation of RMS metering.
817  // 1 << 3 is reserved.
818  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).
819  AK_EnableBusMeter_3DMeter = 1 << 5
820 };
821 
822 /// Plug-in type.
823 /// \sa
824 /// - AkPluginInfo
825 enum AkPluginType
826 {
827  AkPluginTypeNone = 0, ///< Unknown/invalid plug-in type.
828  AkPluginTypeCodec = 1, ///< Compressor/decompressor plug-in (allows support for custom audio file types).
829  AkPluginTypeSource = 2, ///< Source plug-in: creates sound by synthesis method (no input, just output).
830  AkPluginTypeEffect = 3, ///< Effect plug-in: applies processing to audio data.
831  //AkPluginTypeMotionDevice = 4, ///< Motion Device plug-in: feeds movement data to devices. Deprecated by Motion refactor.
832  //AkPluginTypeMotionSource = 5, ///< Motion Device source plug-in: feeds movement data to device busses. Deprecated by Motion refactor.
833  AkPluginTypeMixer = 6, ///< Mixer plug-in: mix voices at the bus level.
834  AkPluginTypeSink = 7, ///< Sink plug-in: implement custom sound engine end point.
835  AkPluginTypeGlobalExtension = 8, ///< Global Extension plug-in: (e.g. Spatial Audio, Interactive Music)
836  AkPluginTypeMetadata = 9, ///< Metadata plug-in: applies object-based processing to audio data
837  AkPluginTypeMask = 0xf ///< Plug-in type mask is 4 bits.
838 };
839 
840 ////////////////////////////////////////////////////////////////////////////////
841 // Wwise ID system
842 ////////////////////////////////////////////////////////////////////////////////
843 enum AkNodeType
844 {
845  AkNodeType_Default,
846  AkNodeType_Bus
847 };
848 
849 struct WwiseObjectIDext
850 {
851 public:
852 
853  bool operator == ( const WwiseObjectIDext& in_rOther ) const
854  {
855  return in_rOther.id == id && in_rOther.bIsBus == bIsBus;
856  }
857 
858  AkNodeType GetType()
859  {
860  return bIsBus ? AkNodeType_Bus : AkNodeType_Default;
861  }
862 
863  AkUniqueID id;
864  bool bIsBus;
865 };
866 
867 struct WwiseObjectID : public WwiseObjectIDext
868 {
869  WwiseObjectID()
870  {
871  id = AK_INVALID_UNIQUE_ID;
872  bIsBus = false;
873  }
874 
875  WwiseObjectID( AkUniqueID in_ID )
876  {
877  id = in_ID;
878  bIsBus = false;
879  }
880 
881  WwiseObjectID( AkUniqueID in_ID, bool in_bIsBus )
882  {
883  id = in_ID;
884  bIsBus = in_bIsBus;
885  }
886 
887  WwiseObjectID( AkUniqueID in_ID, AkNodeType in_eNodeType )
888  {
889  id = in_ID;
890  bIsBus = in_eNodeType == AkNodeType_Bus;
891  }
892 };
893 
894 /// Public data structures for converted file format.
895 namespace AkFileParser
896 {
897 #pragma pack(push, 1)
898  /// Analyzed envelope point.
899  struct EnvelopePoint
900  {
901  AkUInt32 uPosition; /// Position of this point in samples at the source rate.
902  AkUInt16 uAttenuation; /// Approximate _attenuation_ at this location relative to this source's maximum, in dB (absolute value).
903  };
904 #pragma pack(pop)
905 }
906 
907 #ifndef AK_ALIGN
908 #if defined(SWIG)
909 #define AK_ALIGN( _declaration_, _alignment_ ) _declaration_
910 #else
911 #if defined(_MSC_VER)
912 #define AK_ALIGN( _declaration_, _alignment_ ) __declspec( align( _alignment_ ) ) _declaration_
913 #else
914 #define AK_ALIGN( _declaration_, _alignment_ ) _declaration_ __attribute__( ( aligned( _alignment_ ) ) )
915 #endif // _MSC_VER
916 #endif // SWIG
917 #endif // AK_ALIGN
918 
919 #if !defined(AK_ENDIANNESS_LITTLE) && !defined(AK_ENDIANNESS_BIG)
920 #define AK_ENDIANNESS_LITTLE
921 #endif
922 
923 #ifndef AK_UNALIGNED
924 #define 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 *.
925 #endif
926 
927 #if __cplusplus <= 199711L
928 #define AK_FINAL
929 #else
930 #define AK_FINAL final ///< Refers to the C++11 final keyword
931 #endif
932 
933 #ifndef AK_ASYNC_OPEN_DEFAULT
934 #define AK_ASYNC_OPEN_DEFAULT (false) ///< Refers to asynchronous file opening in default low-level IO.
935 #endif
936 
937 #ifndef AK_COMM_DEFAULT_DISCOVERY_PORT
938 #define AK_COMM_DEFAULT_DISCOVERY_PORT 24024 ///< Default discovery port for most platforms using IP sockets for communication.
939 #endif
940 
941 #ifndef AK_CAPTURE_TYPE_FLOAT
942 typedef AkInt16 AkCaptureType; ///< Default value: capture type is short.
943 #endif
944 
945 #define AkRegister
946 
947 #endif //_AK_DATA_TYPES_H_
AkNodeType_Bus
@ AkNodeType_Bus
Definition: AkTypes.h:846
AK_PathNodeNotInList
@ AK_PathNodeNotInList
This path is not there.
Definition: AkTypes.h:152
AkEmitterListenerPair::AkEmitterListenerPair
AkEmitterListenerPair()
Constructor.
Definition: AkTypes.h:486
AkDeviceDescription::deviceStateMask
AkAudioDeviceState deviceStateMask
Bitmask used to filter the device based on their state.
Definition: AkTypes.h:227
AkReal32
float AkReal32
32-bit floating point
Definition: AkTypes.h:68
AkEmitterListenerPair::m_uListenerID
AkGameObjectID m_uListenerID
Listener game object ID.
Definition: AkTypes.h:567
AkStateGroupID
AkUInt32 AkStateGroupID
State group ID.
Definition: AkTypes.h:59
AK::SoundEngine::MultiPositionType
MultiPositionType
Definition: AkTypes.h:758
WwiseObjectIDext::id
AkUniqueID id
Definition: AkTypes.h:863
WwiseObjectIDext::GetType
AkNodeType GetType()
Definition: AkTypes.h:858
AkAuxSendValue::fControlValue
AkReal32 fControlValue
Definition: AkTypes.h:612
AkTransform::SetPosition
void SetPosition(AkReal32 in_x, AkReal32 in_y, AkReal32 in_z)
Set position.
Definition: AkTypes.h:403
AK_DEFAULT_BANK_IO_PRIORITY
static const AkPriority AK_DEFAULT_BANK_IO_PRIORITY
Default bank load I/O priority.
Definition: AkTypes.h:119
AkDataInterleaveID
AkUInt8 AkDataInterleaveID
Data interleaved state ID.
Definition: AkTypes.h:75
AK_UnsupportedChannelConfig
@ AK_UnsupportedChannelConfig
Channel configuration is not supported in the current execution context.
Definition: AkTypes.h:174
AK_NoMetering
@ AK_NoMetering
No metering.
Definition: AkTypes.h:813
AK_InvalidCustomPlatformName
@ AK_InvalidCustomPlatformName
Detecting incompatibility between Custom platform of banks and custom platform of connected applicati...
Definition: AkTypes.h:179
AkSpeakerPanningType
AkSpeakerPanningType
Speaker panning type: type of panning logic when object is not 3D spatialized (i.e....
Definition: AkTypes.h:769
AkExternalSourceInfo::AkExternalSourceInfo
AkExternalSourceInfo(AkFileID in_idFile, AkUInt32 in_iExternalSrcCookie, AkCodecID in_idCodec)
Constructor: specify source by streaming file ID.
Definition: AkTypes.h:282
AK_InvalidSwitchType
@ AK_InvalidSwitchType
Invalid switch type (used with the switch container)
Definition: AkTypes.h:161
AkRamp::operator*=
AkRamp & operator*=(const AkRamp &in_rRhs)
Definition: AkTypes.h:622
AkEmitterListenerPair::Occlusion
AkReal32 Occlusion() const
Get the occlusion factor for this emitter-listener pair.
Definition: AkTypes.h:520
AK_FileNotFound
@ AK_FileNotFound
File not found.
Definition: AkTypes.h:164
AkVector::Zero
void Zero()
Definition: AkTypes.h:318
AK
Audiokinetic namespace.
Definition: AkWwiseSDKVersion.cs:32
AkTimeMs
AkInt32 AkTimeMs
Time in ms.
Definition: AkTypes.h:61
AkAuxSendValue
Auxiliary bus sends information per game object per given auxiliary bus.
Definition: AkTypes.h:609
AK_Fail
@ AK_Fail
The operation failed.
Definition: AkTypes.h:130
AkEmitterListenerPair::fEmitterAngle
AkReal32 fEmitterAngle
Angle between position vector and emitter orientation.
Definition: AkTypes.h:552
AkObstructionOcclusionValues
Obstruction/occlusion pair for a position.
Definition: AkTypes.h:456
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:241
AkEmitterListenerPair::Diffraction
AkReal32 Diffraction() const
Get the diffraction factor for this emitter-listener pair.
Definition: AkTypes.h:526
AK_DataAlignmentError
@ AK_DataAlignmentError
A pointer to audio data was not aligned to the platform's required alignment (check AkTypes....
Definition: AkTypes.h:185
AkExternalSourceInfo::idCodec
AkCodecID idCodec
Codec ID for the file. One of the audio formats defined in AkTypes.h (AKCODECID_XXX)
Definition: AkTypes.h:239
AkListenerPosition
AkTransform AkListenerPosition
Positioning information for a listener.
Definition: AkTypes.h:452
AkPluginTypeGlobalExtension
@ AkPluginTypeGlobalExtension
Global Extension plug-in: (e.g. Spatial Audio, Interactive Music)
Definition: AkTypes.h:835
AkModulatorID
AkUInt32 AkModulatorID
Modulator ID.
Definition: AkTypes.h:86
AkRamp::fPrev
AkReal32 fPrev
Definition: AkTypes.h:624
AK_DataReady
@ AK_DataReady
The provider has available data.
Definition: AkTypes.h:155
AkPluginTypeMask
@ AkPluginTypeMask
Plug-in type mask is 4 bits.
Definition: AkTypes.h:837
AK_NotCompatible
@ AK_NotCompatible
Incompatible formats.
Definition: AkTypes.h:132
AkSphericalCoord::phi
AkReal32 phi
Elevation.
Definition: AkTypes.h:478
AK_MAX_PATH
#define AK_MAX_PATH
Maximum path length.
Definition: AkTypes.h:86
AkGroupType_Switch
@ AkGroupType_Switch
Type switch.
Definition: AkTypes.h:202
AkCreateFileSourceCallback
IAkSoftwareCodec *(* AkCreateFileSourceCallback)(void *in_pCtx)
Registered file source creation function prototype.
Definition: AkTypes.h:726
AkRtpcID
AkUInt32 AkRtpcID
Real time parameter control ID.
Definition: AkTypes.h:78
AkAudioObjectID
AkUInt64 AkAudioObjectID
Audio Object ID.
Definition: AkTypes.h:92
AkPanningRule_Headphones
@ AkPanningRule_Headphones
Left and right positioned 180 degrees apart.
Definition: AkTypes.h:788
AK_InvalidID
@ AK_InvalidID
The ID is invalid.
Definition: AkTypes.h:137
AkCurveInterpolation_SCurve
@ AkCurveInterpolation_SCurve
S Curve.
Definition: AkTypes.h:594
AkCurveInterpolation_SineRecip
@ AkCurveInterpolation_SineRecip
Reciprocal of sine curve.
Definition: AkTypes.h:596
ConnectionType_Direct
@ ConnectionType_Direct
Direct (main, dry) connection.
Definition: AkTypes.h:298
AK_InvalidFile
@ AK_InvalidFile
An unexpected value causes the file to be invalid.
Definition: AkTypes.h:134
AK_SSEInstructionsNotSupported
@ AK_SSEInstructionsNotSupported
The machine does not support SSE instructions (required on PC).
Definition: AkTypes.h:172
AkEmitterListenerPair::Distance
AkReal32 Distance() const
Get distance.
Definition: AkTypes.h:509
AkPipelineID
AkUInt32 AkPipelineID
Unique node (bus, voice) identifier for profiling.
Definition: AkTypes.h:90
AK_NoDistinctListener
@ AK_NoDistinctListener
No distinct listener provided for AddOutput.
Definition: AkTypes.h:193
AK_SpatializationMode_None
@ AK_SpatializationMode_None
No spatialization.
Definition: AkTypes.h:795
WwiseObjectIDext::operator==
bool operator==(const WwiseObjectIDext &in_rOther) const
Definition: AkTypes.h:853
AkDeviceDescription::isDefaultDevice
bool isDefaultDevice
Identify default device. Always false when not supported.
Definition: AkTypes.h:228
AK_DLLPathNotFound
@ AK_DLLPathNotFound
Plugin DLL search path could not be found.
Definition: AkTypes.h:181
AK_CommandTooLarge
@ AK_CommandTooLarge
SDK command is too large to fit in the command queue.
Definition: AkTypes.h:177
AK_MaxReached
@ AK_MaxReached
The maximum was reached.
Definition: AkTypes.h:136
AkGameObjectID
AkUInt64 AkGameObjectID
Game object ID.
Definition: AkTypes.h:65
AkNodeType
AkNodeType
Definition: AkTypes.h:844
AkTransform::Position
const AkVector & Position() const
Get position vector.
Definition: AkTypes.h:337
AkBankID
AkUInt32 AkBankID
Run time bank ID.
Definition: AkTypes.h:80
AkPluginTypeMetadata
@ AkPluginTypeMetadata
Metadata plug-in: applies object-based processing to audio data.
Definition: AkTypes.h:836
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:240
AkTransform::OrientationFront
const AkVector & OrientationFront() const
Get orientation front vector.
Definition: AkTypes.h:343
AkEmitterListenerPair::fSpread
AkReal32 fSpread
Emitter-listener-pair-specific spread.
Definition: AkTypes.h:561
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:371
AK::SoundEngine::MultiPositionType_MultiDirections
@ MultiPositionType_MultiDirections
Simulate one sound coming from multiple directions. Useful for repositionning sounds based on wall op...
Definition: AkTypes.h:761
AkNodeType_Default
@ AkNodeType_Default
Definition: AkTypes.h:845
AkTransform::OrientationTop
const AkVector & OrientationTop() const
Get orientation top vector.
Definition: AkTypes.h:349
AKRESULT
AKRESULT
Standard function call result.
Definition: AkTypes.h:127
AK_INVALID_DEVICE_ID
static const AkDeviceID AK_INVALID_DEVICE_ID
Invalid streaming device ID.
Definition: AkTypes.h:105
AkRamp::AkRamp
AkRamp()
Definition: AkTypes.h:620
AK_NoDataReady
@ AK_NoDataReady
The provider does not have available data.
Definition: AkTypes.h:156
AkGroupType_State
@ AkGroupType_State
Type state.
Definition: AkTypes.h:203
AkPanningRule_Speakers
@ AkPanningRule_Speakers
Left and right positioned 60 degrees apart (by default - see AK::SoundEngine::GetSpeakerAngles()).
Definition: AkTypes.h:787
AK_MIN_PRIORITY
static const AkPriority AK_MIN_PRIORITY
Minimal priority value [0,100].
Definition: AkTypes.h:115
AK_ResourceInUse
@ AK_ResourceInUse
Resource is in use and cannot be released.
Definition: AkTypes.h:195
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:189
AkDeviceID
AkUInt32 AkDeviceID
I/O device ID.
Definition: AkTypes.h:82
AkPolarCoord::r
AkReal32 r
Norm/distance.
Definition: AkTypes.h:471
AK_INVALID_PLUGINID
static const AkPluginID AK_INVALID_PLUGINID
Invalid FX ID.
Definition: AkTypes.h:95
AkSoundPosition
AkTransform AkSoundPosition
Positioning information for a sound.
Definition: AkTypes.h:449
AkUInt8
uint8_t AkUInt8
Unsigned 8-bit integer.
Definition: AkTypes.h:55
AK_NoMoreData
@ AK_NoMoreData
No more data is available from the source.
Definition: AkTypes.h:140
WwiseObjectID::WwiseObjectID
WwiseObjectID(AkUniqueID in_ID, bool in_bIsBus)
Definition: AkTypes.h:881
AkCurveInterpolation_Sine
@ AkCurveInterpolation_Sine
Sine.
Definition: AkTypes.h:590
AkImageSourceID
AkUInt32 AkImageSourceID
Image Source ID.
Definition: AkTypes.h:88
AkMemPoolId
AkInt32 AkMemPoolId
Memory pool ID.
Definition: AkTypes.h:67
AkArgumentValueID
AkUInt32 AkArgumentValueID
Argument value ID.
Definition: AkTypes.h:84
AK_SpatializationMode_PositionOnly
@ AK_SpatializationMode_PositionOnly
Spatialization based on emitter position only.
Definition: AkTypes.h:796
AK_NoJavaVM
@ AK_NoJavaVM
No Java VM provided in AkInitSettings.
Definition: AkTypes.h:182
AK_SOUNDBANK_VERSION
static const AkUInt32 AK_SOUNDBANK_VERSION
Version of the soundbank reader.
Definition: AkTypes.h:123
AkEmitterListenerPair::fDistance
AkReal32 fDistance
Distance between emitter and listener.
Definition: AkTypes.h:551
AK_FileFormatMismatch
@ AK_FileFormatMismatch
Media file format unexpected.
Definition: AkTypes.h:192
AK_EnableBusMeter_Peak
@ AK_EnableBusMeter_Peak
Enable computation of peak metering.
Definition: AkTypes.h:814
AK_INVALID_BANK_ID
static const AkBankID AK_INVALID_BANK_ID
Invalid bank ID.
Definition: AkTypes.h:106
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:359
AK_RenderedFX
@ AK_RenderedFX
The effect on the node is rendered.
Definition: AkTypes.h:167
AK_INVALID_AUDIO_OBJECT_ID
static const AkAudioObjectID AK_INVALID_AUDIO_OBJECT_ID
Invalid audio object ID.
Definition: AkTypes.h:111
AkDeviceState_All
@ AkDeviceState_All
Includes audio devices in all states.
Definition: AkTypes.h:220
AkChannelMask
AkUInt32 AkChannelMask
Channel mask (similar to WAVE_FORMAT_EXTENSIBLE). Bit values are defined in AkSpeakerConfig....
Definition: AkTypes.h:85
AkLPFType
AkReal32 AkLPFType
Low-pass filter type.
Definition: AkTypes.h:66
AkOSChar
char AkOSChar
Generic character string.
Definition: AkTypes.h:66
AK_BankReadError
@ AK_BankReadError
Error while reading a bank.
Definition: AkTypes.h:160
AK_InvalidStateGroup
@ AK_InvalidStateGroup
The StateGroup is not a valid channel.
Definition: AkTypes.h:141
AK_DEFAULT_SWITCH_STATE
static const AkUInt32 AK_DEFAULT_SWITCH_STATE
Switch selected if no switch has been set yet.
Definition: AkTypes.h:100
AkExternalSourceInfo::AkExternalSourceInfo
AkExternalSourceInfo(AkOSChar *in_pszFileName, AkUInt32 in_iExternalSrcCookie, AkCodecID in_idCodec)
Constructor: specify source by streaming file name.
Definition: AkTypes.h:269
AK_IDNotFound
@ AK_IDNotFound
The ID was not found.
Definition: AkTypes.h:138
AK_3DPositionType_EmitterWithAutomation
@ AK_3DPositionType_EmitterWithAutomation
3D spatialization is computed from the emitter game object position, translated by user-defined autom...
Definition: AkTypes.h:780
AK_BankAlreadyLoaded
@ AK_BankAlreadyLoaded
The bank load failed because the bank is already loaded.
Definition: AkTypes.h:166
AkVolumeValue
AkReal32 AkVolumeValue
Volume value( also apply to LFE )
Definition: AkTypes.h:64
AkCurveInterpolation_Exp1
@ AkCurveInterpolation_Exp1
Exp1.
Definition: AkTypes.h:595
AK_DLLCannotLoad
@ AK_DLLCannotLoad
Plugin DLL could not be loaded, either because it is not found or one dependency is missing.
Definition: AkTypes.h:180
AK_SteeringPanner
@ AK_SteeringPanner
Steering panner.
Definition: AkTypes.h:772
AK_ProcessDone
@ AK_ProcessDone
The executed routine has finished its execution.
Definition: AkTypes.h:169
AK_Success
@ AK_Success
The operation was successful.
Definition: AkTypes.h:129
AkEmitterListenerPair::fObstruction
AkReal32 fObstruction
Emitter-listener-pair-specific obstruction factor.
Definition: AkTypes.h:558
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:216
AkEmitterListenerPair
Emitter-listener pair: Positioning data pertaining to a single pair of emitter and listener.
Definition: AkTypes.h:483
AK_PathNodeAlreadyInList
@ AK_PathNodeAlreadyInList
This path is already there.
Definition: AkTypes.h:151
AK::SoundEngine::MultiPositionType_SingleSource
@ MultiPositionType_SingleSource
Used for normal sounds, not expected to pass to AK::SoundEngine::SetMultiplePosition() (if done,...
Definition: AkTypes.h:759
AkEmitterListenerPair::fGameDefAuxMixGain
AkReal32 fGameDefAuxMixGain
Emitter-listener-pair-specific gain (due to distance and cone attenuation) for game-defined send conn...
Definition: AkTypes.h:555
AkCurveInterpolation_Exp3
@ AkCurveInterpolation_Exp3
Exp3.
Definition: AkTypes.h:597
AkFileID
AkUInt32 AkFileID
Integer-type file identifier.
Definition: AkTypes.h:81
AK_DEFAULT_PRIORITY
static const AkPriority AK_DEFAULT_PRIORITY
Default sound / I/O priority.
Definition: AkTypes.h:114
AkInt16
int16_t AkInt16
Signed 16-bit integer.
Definition: AkTypes.h:61
AK_MemManagerNotInitialized
@ AK_MemManagerNotInitialized
The memory manager should have been initialized at this point.
Definition: AkTypes.h:170
AkCreateFileCodecCallback
IAkFileCodec *(* AkCreateFileCodecCallback)()
Registered FileCodec creation function prototype.
Definition: AkTypes.h:730
AK_ProcessNeeded
@ AK_ProcessNeeded
A routine needs to be executed on some CPU.
Definition: AkTypes.h:168
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:760
AkUInt64
uint64_t AkUInt64
Unsigned 64-bit integer.
Definition: AkTypes.h:58
WwiseObjectID::WwiseObjectID
WwiseObjectID(AkUniqueID in_ID, AkNodeType in_eNodeType)
Definition: AkTypes.h:887
AK_EnableBusMeter_3DMeter
@ AK_EnableBusMeter_3DMeter
Definition: AkTypes.h:819
AK_CannotAddItseflAsAChild
@ AK_CannotAddItseflAsAChild
It is not possible to add itself as its own child.
Definition: AkTypes.h:144
AkExternalSourceInfo::iExternalSrcCookie
AkUInt32 iExternalSrcCookie
Cookie identifying the source, given by hashing the name of the source given in the project....
Definition: AkTypes.h:238
AK_DeviceNotCompatible
@ AK_DeviceNotCompatible
Incompatible Audio device.
Definition: AkTypes.h:186
AkRamp::fNext
AkReal32 fNext
Definition: AkTypes.h:625
AkEmitterListenerPair::EmitterAngle
AkReal32 EmitterAngle() const
Definition: AkTypes.h:513
AK_InvalidParameter
@ AK_InvalidParameter
Something is not within bounds.
Definition: AkTypes.h:145
Ak3DPositionType
Ak3DPositionType
3D position type: defines what acts as the emitter position for computing spatialization against the ...
Definition: AkTypes.h:778
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:184
AkVector::Y
AkReal32 Y
Y Position.
Definition: AkTypes.h:324
AkUniqueID
AkUInt32 AkUniqueID
Unique 32-bit ID.
Definition: AkTypes.h:57
AkListener::position
AkListenerPosition position
Definition: AkTypes.h:577
AkBusHierarchy_IsMaster
@ AkBusHierarchy_IsMaster
Flag is set to indicate a master bus (may be used in combination with other flags).
Definition: AkTypes.h:805
AkAudioSettings
Configured audio settings.
Definition: AkTypes.h:208
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:218
AkPluginID
AkUInt32 AkPluginID
Source or effect plug-in ID.
Definition: AkTypes.h:68
AkVector::operator+
AkVector operator+(const AkVector &b) const
Definition: AkTypes.h:307
AK_InvalidFloatValue
@ AK_InvalidFloatValue
One parameter has a invalid float value such as NaN, INF or FLT_MAX.
Definition: AkTypes.h:191
AkEmitterListenerPair::ListenerID
AkGameObjectID ListenerID() const
Get listener ID associated with the emitter-listener pair.
Definition: AkTypes.h:548
AK_AudioFileHeaderTooLarge
@ AK_AudioFileHeaderTooLarge
The file header is too large.
Definition: AkTypes.h:135
AkVector::X
AkReal32 X
X Position.
Definition: AkTypes.h:323
AkCurveInterpolation_InvSCurve
@ AkCurveInterpolation_InvSCurve
Inversed S Curve.
Definition: AkTypes.h:592
AkCurveInterpolation_Log3
@ AkCurveInterpolation_Log3
Log3.
Definition: AkTypes.h:589
AkDataTypeID
AkUInt16 AkDataTypeID
Data sample type ID.
Definition: AkTypes.h:74
AkCurveInterpolation_Log1
@ AkCurveInterpolation_Log1
Log1.
Definition: AkTypes.h:591
AkAcousticTextureID
AkUInt32 AkAcousticTextureID
Acoustic Texture ID.
Definition: AkTypes.h:87
AkDeviceState_Unknown
@ AkDeviceState_Unknown
The audio device state is unknown or invalid.
Definition: AkTypes.h:215
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:165
AkCaptureType
AkInt16 AkCaptureType
Default value: capture type is short.
Definition: AkTypes.h:942
AK_PlayingIDNotFound
@ AK_PlayingIDNotFound
Calling a function with a playing ID that is not known.
Definition: AkTypes.h:190
AkSphericalCoord
Spherical coordinates.
Definition: AkTypes.h:477
AK_Busy
@ AK_Busy
The system is busy and could not process the request.
Definition: AkTypes.h:173
AkEmitterListenerPair::fDiffraction
AkReal32 fDiffraction
Emitter-listener-pair-specific diffraction coefficient.
Definition: AkTypes.h:559
AK_AlreadyConnected
@ AK_AlreadyConnected
The stream is already connected to another node.
Definition: AkTypes.h:133
AK_PathNotFound
@ AK_PathNotFound
This path is not known.
Definition: AkTypes.h:147
AK_INVALID_PIPELINE_ID
static const AkPipelineID AK_INVALID_PIPELINE_ID
Invalid pipeline ID (for profiling)
Definition: AkTypes.h:110
AK_InitBankNotLoaded
@ AK_InitBankNotLoaded
The Init bank was not loaded yet, the sound engine isn't completely ready yet.
Definition: AkTypes.h:188
AkCodecID
AkUInt32 AkCodecID
Codec plug-in ID.
Definition: AkTypes.h:69
AkFileParser::EnvelopePoint::uPosition
AkUInt32 uPosition
Definition: AkTypes.h:901
AkMeteringFlags
AkMeteringFlags
Metering flags. Used for specifying bus metering, through AK::SoundEngine::RegisterBusVolumeCallback(...
Definition: AkTypes.h:812
AkEmitterListenerPair::Obstruction
AkReal32 Obstruction() const
Get the obstruction factor for this emitter-listener pair.
Definition: AkTypes.h:523
AkDataCompID
AkUInt16 AkDataCompID
Data compression format ID.
Definition: AkTypes.h:73
AkChannelEmitter
Positioning information for a sound, with specified subset of its channels.
Definition: AkTypes.h:463
AkRamp
Volume ramp specified by end points "previous" and "next".
Definition: AkTypes.h:619
AK_PluginMediaNotAvailable
@ AK_PluginMediaNotAvailable
Plugin media is not available for effect.
Definition: AkTypes.h:175
AkPriority
AkInt8 AkPriority
Priority.
Definition: AkTypes.h:72
AkVector::Z
AkReal32 Z
Z Position.
Definition: AkTypes.h:325
AkGroupType
AkGroupType
Game sync group type.
Definition: AkTypes.h:200
AkPluginTypeEffect
@ AkPluginTypeEffect
Effect plug-in: applies processing to audio data.
Definition: AkTypes.h:830
operator*
AkRamp operator*(const AkRamp &in_rLhs, const AkRamp &in_rRhs)
Definition: AkTypes.h:627
AkObstructionOcclusionValues::obstruction
AkReal32 obstruction
ObstructionLevel: [0.0f..1.0f].
Definition: AkTypes.h:458
WwiseObjectID::WwiseObjectID
WwiseObjectID(AkUniqueID in_ID)
Definition: AkTypes.h:875
AkCurveInterpolation_Constant
@ AkCurveInterpolation_Constant
Constant ( not valid for fading values )
Definition: AkTypes.h:599
AkExternalSourceInfo::AkExternalSourceInfo
AkExternalSourceInfo(void *in_pInMemory, AkUInt32 in_uiMemorySize, AkUInt32 in_iExternalSrcCookie, AkCodecID in_idCodec)
Constructor: specify source by memory.
Definition: AkTypes.h:255
AK_3DPositionType_ListenerWithAutomation
@ AK_3DPositionType_ListenerWithAutomation
3D spatialization is computed from the listener game object position, translated by user-defined auto...
Definition: AkTypes.h:781
AK_InvalidLanguage
@ AK_InvalidLanguage
The language is invalid (applies to the Low-Level I/O).
Definition: AkTypes.h:143
AkInt8
int8_t AkInt8
Signed 8-bit integer.
Definition: AkTypes.h:60
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:415
AkRamp::AkRamp
AkRamp(AkReal32 in_fPrev, AkReal32 in_fNext)
Definition: AkTypes.h:621
AK_INVALID_POOL_ID
static const AkMemPoolId AK_INVALID_POOL_ID
Invalid pool ID.
Definition: AkTypes.h:101
AkPolarCoord
Polar coordinates.
Definition: AkTypes.h:470
AkDeviceState_Unplugged
@ AkDeviceState_Unplugged
The audio device is unplugged.
Definition: AkTypes.h:219
AK_NoDataNeeded
@ AK_NoDataNeeded
The consumer does not need more.
Definition: AkTypes.h:154
AkDeviceDescription::deviceName
AkOSChar deviceName[AK_MAX_PATH]
The user-friendly name for the device.
Definition: AkTypes.h:226
AkEmitterListenerPair::GetGainForConnectionType
AkReal32 GetGainForConnectionType(AkConnectionType in_eType) const
Get the emitter-listener-pair-specific gain (due to distance and cone attenuation),...
Definition: AkTypes.h:532
AkPluginTypeMixer
@ AkPluginTypeMixer
Mixer plug-in: mix voices at the bus level.
Definition: AkTypes.h:833
AK_SpatializationMode_PositionAndOrientation
@ AK_SpatializationMode_PositionAndOrientation
Spatialization based on both emitter position and emitter orientation.
Definition: AkTypes.h:797
AK_INVALID_OUTPUT_DEVICE_ID
static const AkUInt32 AK_INVALID_OUTPUT_DEVICE_ID
Invalid Device ID.
Definition: AkTypes.h:109
AK_PartialSuccess
@ AK_PartialSuccess
The operation succeeded partially.
Definition: AkTypes.h:131
ConnectionType_ReflectionsSend
@ ConnectionType_ReflectionsSend
Connection by a early reflections send.
Definition: AkTypes.h:301
AK_ACP_Error
@ AK_ACP_Error
Generic XMA decoder error.
Definition: AkTypes.h:194
AkCurveInterpolation
AkCurveInterpolation
Curve interpolation types.
Definition: AkTypes.h:586
AK_CALLBACK
#define AK_CALLBACK(_type, _name)
Definition: AkSoundEngineExport.h:84
AkAudioSettings::uNumSamplesPerFrame
AkUInt32 uNumSamplesPerFrame
Number of samples per audio frame (256, 512, 1024 or 2048).
Definition: AkTypes.h:209
AK_InvalidInstanceID
@ AK_InvalidInstanceID
The InstanceID is invalid.
Definition: AkTypes.h:139
Ak3DSpatializationMode
Ak3DSpatializationMode
3D spatialization mode.
Definition: AkTypes.h:794
AK_NotImplemented
@ AK_NotImplemented
This feature is not implemented.
Definition: AkTypes.h:128
AkUInt16
uint16_t AkUInt16
Unsigned 16-bit integer.
Definition: AkTypes.h:56
AkCreateGrainCodecCallback
IAkGrainCodec *(* AkCreateGrainCodecCallback)()
Registered IAkGrainCodec creation function prototype.
Definition: AkTypes.h:732
AK_INVALID_UNIQUE_ID
static const AkUniqueID AK_INVALID_UNIQUE_ID
Invalid unique 32-bit ID.
Definition: AkTypes.h:97
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:425
AkPluginTypeSink
@ AkPluginTypeSink
Sink plug-in: implement custom sound engine end point.
Definition: AkTypes.h:834
AkPanningRule
AkPanningRule
Headphone / speakers panning rules.
Definition: AkTypes.h:786
AkStateID
AkUInt32 AkStateID
State ID.
Definition: AkTypes.h:58
AK_EnableBusMeter_KPower
@ AK_EnableBusMeter_KPower
Enable computation of K-weighted power metering (used as a basis for computing loudness,...
Definition: AkTypes.h:818
AkCurveInterpolation_Linear
@ AkCurveInterpolation_Linear
Linear (Default)
Definition: AkTypes.h:593
AkListener::bSpatialized
bool bSpatialized
Listener scaling factor (see AK::SoundEngine::SetListenerScalingFactor()).
Definition: AkTypes.h:579
WwiseObjectIDext::bIsBus
bool bIsBus
Definition: AkTypes.h:864
AkPitchValue
AkReal32 AkPitchValue
Pitch value.
Definition: AkTypes.h:63
AK_INVALID_PLAYING_ID
static const AkPlayingID AK_INVALID_PLAYING_ID
Invalid playing ID.
Definition: AkTypes.h:99
AK_DataNeeded
@ AK_DataNeeded
The consumer needs more.
Definition: AkTypes.h:153
AkTransform::SetPosition
void SetPosition(const AkVector &in_position)
Set position.
Definition: AkTypes.h:395
AkEmitterListenerPair::fScalingFactor
AkReal32 fScalingFactor
Combined scaling factor due to both emitter and listener.
Definition: AkTypes.h:563
AkDeviceState_Disabled
@ AkDeviceState_Disabled
The audio device is disabled.
Definition: AkTypes.h:217
AkSwitchStateID
AkUInt32 AkSwitchStateID
Switch ID.
Definition: AkTypes.h:77
AkEmitterListenerPair::fDryMixGain
AkReal32 fDryMixGain
Emitter-listener-pair-specific gain (due to distance and cone attenuation) for direct connections.
Definition: AkTypes.h:554
AkEmitterListenerPair::fOcclusion
AkReal32 fOcclusion
Emitter-listener-pair-specific occlusion factor.
Definition: AkTypes.h:557
AkExternalSourceInfo::AkExternalSourceInfo
AkExternalSourceInfo()
Default constructor.
Definition: AkTypes.h:246
AkEmitterListenerPair::fListenerAngle
AkReal32 fListenerAngle
Angle between position vector and listener orientation.
Definition: AkTypes.h:553
AkPortNumber
AkUInt16 AkPortNumber
Port number.
Definition: AkTypes.h:62
AkExternalSourceInfo::idFile
AkFileID idFile
File ID. If not zero, the source will be streaming from disk. This ID can be anything....
Definition: AkTypes.h:243
AkEmitterListenerPair::uEmitterChannelMask
AkChannelMask uEmitterChannelMask
Channels of the emitter that apply to this ray.
Definition: AkTypes.h:564
AkPluginTypeSource
@ AkPluginTypeSource
Source plug-in: creates sound by synthesis method (no input, just output).
Definition: AkTypes.h:829
AkEmitterListenerPair::fTransmissionLoss
AkReal32 fTransmissionLoss
Emitter-listener-pair-specific transmission occlusion.
Definition: AkTypes.h:560
AK_PathNoVertices
@ AK_PathNoVertices
Stuff in vertices before trying to start it.
Definition: AkTypes.h:148
AkPolarCoord::theta
AkReal32 theta
Azimuth.
Definition: AkTypes.h:472
AK_FALLBACK_ARGUMENTVALUE_ID
static const AkArgumentValueID AK_FALLBACK_ARGUMENTVALUE_ID
Fallback argument value ID.
Definition: AkTypes.h:107
AK_PathNotPaused
@ AK_PathNotPaused
Only a paused path can be resumed.
Definition: AkTypes.h:150
AkAudioDeviceState
AkAudioDeviceState
Definition: AkTypes.h:214
AkBusHierarchyFlags
AkBusHierarchyFlags
Bus type bit field.
Definition: AkTypes.h:802
AkEmitterListenerPair::emitter
AkTransform emitter
Emitter position.
Definition: AkTypes.h:550
AK_INVALID_GAME_OBJECT
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
Definition: AkTypes.h:96
AkListener::AkListener
AkListener()
Definition: AkTypes.h:573
AkEmitterListenerPair::ID
AkRayID ID() const
Get the emitter-listener pair's ID.
Definition: AkTypes.h:545
AK_BalanceFadeHeight
@ AK_BalanceFadeHeight
Balance-Fade-Height: Traditional "box" or "car"-like panner.
Definition: AkTypes.h:771
AK_ChildAlreadyHasAParent
@ AK_ChildAlreadyHasAParent
The child already has a parent.
Definition: AkTypes.h:142
AkEmitterListenerPair::id
AkRayID id
ID of this emitter-listener pair, unique for a given emitter.
Definition: AkTypes.h:566
AK_UnknownBankID
@ AK_UnknownBankID
Trying to load a bank using an ID which is not defined.
Definition: AkTypes.h:159
AkFileParser
Public data structures for converted file format.
Definition: AkTypes.h:896
AkRayID
AkUInt32 AkRayID
Unique (per emitter) identifier for an emitter-listener ray.
Definition: AkTypes.h:91
AkFileParser::EnvelopePoint::uAttenuation
AkUInt16 uAttenuation
Position of this point in samples at the source rate.
Definition: AkTypes.h:902
AkPluginTypeCodec
@ AkPluginTypeCodec
Compressor/decompressor plug-in (allows support for custom audio file types).
Definition: AkTypes.h:828
AkUInt32
uint32_t AkUInt32
Unsigned 32-bit integer.
Definition: AkTypes.h:57
ConnectionType_UserDefSend
@ ConnectionType_UserDefSend
Connection by a user-defined send.
Definition: AkTypes.h:300
AK_StreamMgrNotInitialized
@ AK_StreamMgrNotInitialized
The stream manager should have been initialized at this point.
Definition: AkTypes.h:171
AkEmitterListenerPair::fUserDefAuxMixGain
AkReal32 fUserDefAuxMixGain
Emitter-listener-pair-specific gain (due to distance and cone attenuation) for user-defined send conn...
Definition: AkTypes.h:556
AK_INVALID_FILE_ID
static const AkFileID AK_INVALID_FILE_ID
Invalid file ID.
Definition: AkTypes.h:104
AkPluginParamID
AkInt16 AkPluginParamID
Source or effect plug-in parameter ID.
Definition: AkTypes.h:71
AK_INVALID_AUX_ID
static const AkAuxBusID AK_INVALID_AUX_ID
Invalid auxiliary bus ID (or no Aux bus ID)
Definition: AkTypes.h:103
AK_ElementAlreadyInList
@ AK_ElementAlreadyInList
The item could not be added because it was already in the list.
Definition: AkTypes.h:146
AK_Cancelled
@ AK_Cancelled
The requested action was cancelled (not an error).
Definition: AkTypes.h:158
AkEmitterListenerPair::~AkEmitterListenerPair
~AkEmitterListenerPair()
Destructor.
Definition: AkTypes.h:506
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:610
WwiseObjectID::WwiseObjectID
WwiseObjectID()
Definition: AkTypes.h:869
AK_EnableBusMeter_TruePeak
@ AK_EnableBusMeter_TruePeak
Enable computation of true peak metering (most CPU and memory intensive).
Definition: AkTypes.h:815
AkAuxBusID
AkUInt32 AkAuxBusID
Auxilliary bus ID.
Definition: AkTypes.h:70
AkOutputDeviceID
AkUInt64 AkOutputDeviceID
Audio Output device ID.
Definition: AkTypes.h:89
AkCodecDescriptor::pBankSrcCreateFunc
AkCreateBankSourceCallback pBankSrcCreateFunc
Definition: AkTypes.h:737
AK_DuplicateUniqueID
@ AK_DuplicateUniqueID
Two Wwise objects share the same ID.
Definition: AkTypes.h:187
AK_FormatNotReady
@ AK_FormatNotReady
Source format not known yet.
Definition: AkTypes.h:162
AkVector
3D vector.
Definition: AkTypes.h:306
AK_InsufficientMemory
@ AK_InsufficientMemory
Memory error.
Definition: AkTypes.h:157
AkCodecDescriptor::pFileSrcCreateFunc
AkCreateFileSourceCallback pFileSrcCreateFunc
Definition: AkTypes.h:736
AkBusHierarchy_Secondary
@ AkBusHierarchy_Secondary
Flag is set to indicate the secondary bus hierarchy.
Definition: AkTypes.h:804
AkChannelEmitter::uInputChannels
AkChannelMask uInputChannels
Channels to which the above position applies.
Definition: AkTypes.h:465
AK_DEFAULT_BANK_THROUGHPUT
static const AkReal32 AK_DEFAULT_BANK_THROUGHPUT
Default bank load throughput (1 Mb/ms)
Definition: AkTypes.h:120
AkRtpcValue
AkReal32 AkRtpcValue
Real time parameter control value.
Definition: AkTypes.h:79
AkInt32
int32_t AkInt32
Signed 32-bit integer.
Definition: AkTypes.h:62
AkListener::fScalingFactor
AkReal32 fScalingFactor
Listener position (see AK::SoundEngine::SetPosition()).
Definition: AkTypes.h:578
AK_3DPositionType_Emitter
@ AK_3DPositionType_Emitter
3D spatialization is computed directly from the emitter game object position.
Definition: AkTypes.h:779
AkEmitterListenerPair::ListenerAngle
AkReal32 ListenerAngle() const
Definition: AkTypes.h:517
AkAudioSettings::uNumSamplesPerSecond
AkUInt32 uNumSamplesPerSecond
Number of samples per second.
Definition: AkTypes.h:210
AkListener
Listener information.
Definition: AkTypes.h:572
AK_OpenSLError
@ AK_OpenSLError
OpenSL returned an error. Check error log for more details.
Definition: AkTypes.h:183
AkSwitchGroupID
AkUInt32 AkSwitchGroupID
Switch group ID.
Definition: AkTypes.h:76
AkEmitterListenerPair::TransmissionLoss
AkReal32 TransmissionLoss() const
Get the transmission loss factor for this emitter-listener pair.
Definition: AkTypes.h:529
AkEmitterListenerPair::fAperture
AkReal32 fAperture
Emitter-listener-pair-specific aperture.
Definition: AkTypes.h:562
AK_PathNotRunning
@ AK_PathNotRunning
Only a running path can be paused.
Definition: AkTypes.h:149
AK_WrongBankVersion
@ AK_WrongBankVersion
The bank version is not compatible with the current bank reader.
Definition: AkTypes.h:163
AK_DEFAULT_POOL_ID
static const AkMemPoolId AK_DEFAULT_POOL_ID
Default pool ID, same as AK_INVALID_POOL_ID.
Definition: AkTypes.h:102
AK_DirectSpeakerAssignment
@ AK_DirectSpeakerAssignment
No panning: route to matching channels between input and output.
Definition: AkTypes.h:770
AK_MustBeVirtualized
@ AK_MustBeVirtualized
Sound was Not Allowed to play.
Definition: AkTypes.h:176
AK_MAX_PRIORITY
static const AkPriority AK_MAX_PRIORITY
Maximal priority value [0,100].
Definition: AkTypes.h:116
AkChannelEmitter::position
AkTransform position
Emitter position.
Definition: AkTypes.h:464
AkPluginTypeNone
@ AkPluginTypeNone
Unknown/invalid plug-in type.
Definition: AkTypes.h:827
AkCreateBankSourceCallback
IAkSoftwareCodec *(* AkCreateBankSourceCallback)(void *in_pCtx)
Registered bank source node creation function prototype.
Definition: AkTypes.h:728
AK_INVALID_RTPC_ID
static const AkRtpcID AK_INVALID_RTPC_ID
Invalid RTPC ID.
Definition: AkTypes.h:98
AkObstructionOcclusionValues::occlusion
AkReal32 occlusion
OcclusionLevel: [0.0f..1.0f].
Definition: AkTypes.h:457
AkConnectionType
AkConnectionType
Nature of the connection binding an input to a bus.
Definition: AkTypes.h:297
AkTransform
Position and orientation of game objects.
Definition: AkTypes.h:330
AkPluginType
AkPluginType
Definition: AkTypes.h:826
AkPlayingID
AkUInt32 AkPlayingID
Playing ID.
Definition: AkTypes.h:60
AkCodecDescriptor::pGrainCodecCreateFunc
AkCreateGrainCodecCallback pGrainCodecCreateFunc
Definition: AkTypes.h:739
AkBusHierarchy_Primary
@ AkBusHierarchy_Primary
Flag is set to indicate the primary bus hierarchy.
Definition: AkTypes.h:803
ConnectionType_GameDefSend
@ ConnectionType_GameDefSend
Connection by a game-defined send.
Definition: AkTypes.h:299
AK_RejectedByFilter
@ AK_RejectedByFilter
A play request was rejected due to the MIDI filter parameters.
Definition: AkTypes.h:178
AkAuxSendValue::auxBusID
AkAuxBusID auxBusID
Auxiliary bus ID.
Definition: AkTypes.h:611
AkCurveInterpolation_LastFadeCurve
@ AkCurveInterpolation_LastFadeCurve
Update this value to reflect last curve available for fades.
Definition: AkTypes.h:598
AkExternalSourceInfo::uiMemorySize
AkUInt32 uiMemorySize
Size of the data pointed by pInMemory.
Definition: AkTypes.h:242
AkCodecDescriptor::pFileCodecCreateFunc
AkCreateFileCodecCallback pFileCodecCreateFunc
Definition: AkTypes.h:738
AK_INVALID_CHANNELMASK
static const AkChannelMask AK_INVALID_CHANNELMASK
Invalid channel mask.
Definition: AkTypes.h:108
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:225
AkTriggerID
AkUInt32 AkTriggerID
Trigger ID.
Definition: AkTypes.h:83
AK_EnableBusMeter_RMS
@ AK_EnableBusMeter_RMS
Enable computation of RMS metering.
Definition: AkTypes.h:816
AkFileParser::EnvelopePoint
Analyzed envelope point.
Definition: AkTypes.h:900