Table of Contents

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