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

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