バージョン
menu
Wwise SDK 2025.1.0
AkEnums.h
[詳解]
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) 2025 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 #pragma once
28 
29 #include <AK/SoundEngine/Common/AkConstants.h>
30 
31 enum AKRESULT
32 {
33  AK_NotImplemented = 0, ///< This feature is not implemented.
34  AK_Success = 1, ///< The operation was successful.
35  AK_Fail = 2, ///< The operation failed.
36  AK_PartialSuccess = 3, ///< The operation succeeded partially.
37  AK_NotCompatible = 4, ///< Incompatible formats
38  AK_AlreadyConnected = 5, ///< The stream is already connected to another node.
39  AK_InvalidFile = 7, ///< The provided file is the wrong format or unexpected values causes the file to be invalid.
40  AK_AudioFileHeaderTooLarge = 8, ///< The file header is too large.
41  AK_MaxReached = 9, ///< The maximum was reached.
42  AK_InvalidID = 14, ///< The ID is invalid.
43  AK_IDNotFound = 15, ///< The ID was not found.
44  AK_InvalidInstanceID = 16, ///< The InstanceID is invalid.
45  AK_NoMoreData = 17, ///< No more data is available from the source.
46  AK_InvalidStateGroup = 20, ///< The StateGroup is not a valid channel.
47  AK_ChildAlreadyHasAParent = 21, ///< The child already has a parent.
48  AK_InvalidLanguage = 22, ///< The language is invalid (applies to the Low-Level I/O).
49  AK_CannotAddItselfAsAChild = 23, ///< It is not possible to add itself as its own child.
50  AK_InvalidParameter = 31, ///< Something is not within bounds, check the documentation of the function returning this code.
51  AK_ElementAlreadyInList = 35, ///< The item could not be added because it was already in the list.
52  AK_PathNotFound = 36, ///< This path is not known.
53  AK_PathNoVertices = 37, ///< Stuff in vertices before trying to start it
54  AK_PathNotRunning = 38, ///< Only a running path can be paused.
55  AK_PathNotPaused = 39, ///< Only a paused path can be resumed.
56  AK_PathNodeAlreadyInList = 40, ///< This path is already there.
57  AK_PathNodeNotInList = 41, ///< This path is not there.
58  AK_DataNeeded = 43, ///< The consumer needs more.
59  AK_NoDataNeeded = 44, ///< The consumer does not need more.
60  AK_DataReady = 45, ///< The provider has available data.
61  AK_NoDataReady = 46, ///< The provider does not have available data.
62  AK_InsufficientMemory = 52, ///< Memory error.
63  AK_Cancelled = 53, ///< The requested action was cancelled (not an error).
64  AK_UnknownBankID = 54, ///< Trying to load a bank using an ID which is not defined.
65  AK_BankReadError = 56, ///< Error while reading a bank.
66  AK_InvalidSwitchType = 57, ///< Invalid switch type (used with the switch container)
67  AK_FormatNotReady = 63, ///< Source format not known yet.
68  AK_WrongBankVersion = 64, ///< The bank version is not compatible with the current bank reader.
69  AK_FileNotFound = 66, ///< File not found.
70  AK_DeviceNotReady = 67, ///< Specified ID doesn't match a valid hardware device: either the device doesn't exist or is disabled.
71  AK_BankAlreadyLoaded = 69, ///< The bank load failed because the bank is already loaded.
72  AK_RenderedFX = 71, ///< The effect on the node is rendered.
73  AK_ProcessNeeded = 72, ///< A routine needs to be executed on some CPU.
74  AK_ProcessDone = 73, ///< The executed routine has finished its execution.
75  AK_MemManagerNotInitialized = 74, ///< The memory manager should have been initialized at this point.
76  AK_StreamMgrNotInitialized = 75, ///< The stream manager should have been initialized at this point.
77  AK_SSEInstructionsNotSupported = 76, ///< The machine does not support SSE instructions (required on PC).
78  AK_Busy = 77, ///< The system is busy and could not process the request.
79  AK_UnsupportedChannelConfig = 78, ///< Channel configuration is not supported in the current execution context.
80  AK_PluginMediaNotAvailable = 79, ///< Plugin media is not available for effect.
81  AK_MustBeVirtualized = 80, ///< Sound was Not Allowed to play.
82  AK_CommandTooLarge = 81, ///< SDK command is too large to fit in the command queue.
83  AK_RejectedByFilter = 82, ///< A play request was rejected due to the MIDI filter parameters.
84  AK_InvalidCustomPlatformName = 83, ///< Detecting incompatibility between Custom platform of banks and custom platform of connected application
85  AK_DLLCannotLoad = 84, ///< Plugin DLL could not be loaded, either because it is not found or one dependency is missing.
86  AK_DLLPathNotFound = 85, ///< Plugin DLL search path could not be found.
87  AK_NoJavaVM = 86, ///< No Java VM provided in AkInitSettings.
88  AK_OpenSLError = 87, ///< OpenSL returned an error. Check error log for more details.
89  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.
90  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)
91  AK_DeviceNotCompatible = 90, ///< Incompatible Audio device.
92  AK_DuplicateUniqueID = 91, ///< Two Wwise objects share the same ID.
93  AK_InitBankNotLoaded = 92, ///< The Init bank was not loaded yet, the sound engine isn't completely ready yet.
94  AK_DeviceNotFound = 93, ///< The specified device ID does not match with any of the output devices that the sound engine is currently using.
95  AK_PlayingIDNotFound = 94, ///< Calling a function with a playing ID that is not known.
96  AK_InvalidFloatValue = 95, ///< One parameter has a invalid float value such as NaN, INF or FLT_MAX.
97  AK_FileFormatMismatch = 96, ///< Media file format unexpected
98  AK_NoDistinctListener = 97, ///< No distinct listener provided for AddOutput
99  AK_ResourceInUse = 99, ///< Resource is in use and cannot be released.
100  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.
101  AK_AlreadyInitialized = 101, ///< Init() was called but that element was already initialized.
102  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.
103  AK_FilePermissionError = 103, ///< The file access permissions prevent opening a file.
104  AK_UnknownFileError = 104, ///< Rare file error occured, as opposed to AK_FileNotFound or AK_FilePermissionError. This lumps all unrecognized OS file system errors.
105  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.
106  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.
107  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.
108  AK_FilePathTooLong = 108, ///< The combination of base path and file name exceeds maximum buffer lengths.
109  AK_InvalidState = 109, ///< This method should not be called when the object is in its current state.
110 
111  AKRESULT_Last ///< End of enum, invalid value.
112 };
113 typedef AkUInt32 AKRESULT_t;
114 
115 /// Game sync group type
116 enum AkGroupType
117 {
118  // should stay set as Switch = 0 and State = 1
119  AkGroupType_Switch = 0, ///< Type switch
120  AkGroupType_State = 1 ///< Type state
121 };
122 typedef AkUInt8 AkGroupType_t;
123 
124 enum AkAudioDeviceState
125 {
126  AkDeviceState_Unknown = 0, ///< The audio device state is unknown or invalid.
127  AkDeviceState_Active = 1 << 0, ///< The audio device is active That is, the audio adapter that connects to the endpoint device is present and enabled.
128  AkDeviceState_Disabled = 1 << 1, ///< The audio device is disabled.
129  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.
130  AkDeviceState_Unplugged = 1 << 3, ///< The audio device is unplugged.
131  AkDeviceState_Last, ///< End of enum, invalid value.
132 
133  AkDeviceState_All = AkDeviceState_Active | AkDeviceState_Disabled | AkDeviceState_NotPresent | AkDeviceState_Unplugged, ///< Includes audio devices in all states.
134 };
135 typedef AkUInt8 AkAudioDeviceState_t;
136 
137 /// Nature of the connection binding an input to a bus.
138 enum AkConnectionType
139 {
140  ConnectionType_Direct = 0x0, ///< Direct (main, dry) connection.
141  ConnectionType_GameDefSend = 0x1, ///< Connection by a game-defined send.
142  ConnectionType_UserDefSend = 0x2, ///< Connection by a user-defined send.
143  ConnectionType_ReflectionsSend = 0x3, ///< Connection by a early reflections send.
144  ConnectionType_Last, ///< End of enum, invalid value.
145 };
146 typedef AkUInt8 AkConnectionType_t;
147 
148 /// Curve types of the Attenuation Editor.
149 enum AkAttenuationCurveType
150 {
151  AttenuationCurveID_VolumeDry = 0, ///< The distance-driven dry volume curve.
152  AttenuationCurveID_VolumeAuxGameDef, ///< The distance-driven game-defined auxiliary send curve.
153  AttenuationCurveID_VolumeAuxUserDef, ///< The distance-driven user-defined auxiliary send curve.
154  AttenuationCurveID_LowPassFilter, ///< The distance-driven low-pass filter (pre send) curve.
155  AttenuationCurveID_HighPassFilter, ///< The distance-driven high-pass filter (pre send) curve.
156  AttenuationCurveID_HighShelf, ///< The distance-driven high shelf filter curve.
157  AttenuationCurveID_Spread, ///< The distance-driven Spread curve.
158  AttenuationCurveID_Focus, ///< The distance-driven Focus curve.
159  AttenuationCurveID_ObstructionVolume, ///< The obstruction-driven volume curve.
160  AttenuationCurveID_ObstructionLPF, ///< The obstruction-driven low-pass filter curve.
161  AttenuationCurveID_ObstructionHPF, ///< The obstruction-driven high-pass filter curve.
162  AttenuationCurveID_ObstructionHSF, ///< The obstruction-driven high shelf filter curve.
163  AttenuationCurveID_OcclusionVolume, ///< The occlusion-driven volume curve.
164  AttenuationCurveID_OcclusionLPF, ///< The occlusion-driven low-pass filter curve.
165  AttenuationCurveID_OcclusionHPF, ///< The occlusion-driven high-pass filter curve.
166  AttenuationCurveID_OcclusionHSF, ///< The occlusion-driven high shelf filter curve.
167  AttenuationCurveID_DiffractionVolume, ///< The diffraction-driven volume curve.
168  AttenuationCurveID_DiffractionLPF, ///< The diffraction-driven low-pass filter curve.
169  AttenuationCurveID_DiffractionHPF, ///< The diffraction-driven high-pass filter curve.
170  AttenuationCurveID_DiffractionHSF, ///< The diffraction-driven high shelf filter curve.
171  AttenuationCurveID_TransmissionVolume, ///< The transmission-driven volume curve.
172  AttenuationCurveID_TransmissionLPF, ///< The transmission-driven low-pass filter curve.
173  AttenuationCurveID_TransmissionHPF, ///< The transmission-driven high-pass filter curve.
174  AttenuationCurveID_TransmissionHSF, ///< The transmission-driven high shelf filter curve.
175 
176  AttenuationCurveID_MaxCount, ///< The maximum number of curve types.
177 
178  AttenuationCurveID_Project = 254, ///< Symbol for "Use Project".
179  AttenuationCurveID_None = 255 ///< Symbol for "None".
180 };
181 typedef AkUInt8 AkAttenuationCurveType_t;
182 
183 /// Curve interpolation types
184 enum AkCurveInterpolation
185 {
186  //DONT GO BEYOND 15! (see below for details)
187  //Curves from 0 to LastFadeCurve NEED TO BE A MIRROR IMAGE AROUND LINEAR (eg. Log3 is the inverse of Exp3)
188  AkCurveInterpolation_Log3 = 0, ///< Log3
189  AkCurveInterpolation_Sine = 1, ///< Sine
190  AkCurveInterpolation_Log1 = 2, ///< Log1
191  AkCurveInterpolation_InvSCurve = 3, ///< Inversed S Curve
192  AkCurveInterpolation_Linear = 4, ///< Linear (Default)
193  AkCurveInterpolation_SCurve = 5, ///< S Curve
194  AkCurveInterpolation_Exp1 = 6, ///< Exp1
195  AkCurveInterpolation_SineRecip = 7, ///< Reciprocal of sine curve
196  AkCurveInterpolation_Exp3 = 8, ///< Exp3
197  AkCurveInterpolation_LastFadeCurve = 8, ///< Update this value to reflect last curve available for fades
198  AkCurveInterpolation_Constant = 9, ///< Constant ( not valid for fading values )
199 
200  AkCurveInterpolation_Last, ///< End of enum, invalid value.
201  //DONT GO BEYOND 15! The value is stored on 5 bits,
202  //but we can use only 4 bits for the actual values, keeping
203  //the 5th bit at 0 to void problems when the value is
204  //expanded to 32 bits.
205 };
206 typedef AkUInt8 AkCurveInterpolation_t;
207 #define AKCURVEINTERPOLATION_NUM_STORAGE_BIT 5 ///< Internal storage restriction, for internal use only.
208 
209 /// Bank types
210 enum AkBankTypeEnum
211 {
212  AkBankType_User = AKCODECID_BANK, ///< User-defined bank.
213  AkBankType_Event = AKCODECID_BANK_EVENT, ///< Bank generated for one event.
214  AkBankType_Bus = AKCODECID_BANK_BUS, ///< Bank generated for one bus or aux bus.
215  AkBankType_Last ///< End of enum, invalid value.
216 };
217 typedef AkUInt8 AkBankTypeEnum_t;
218 
219 #define AK_PANNER_NUM_STORAGE_BITS 3
220 /// Speaker panning type: type of panning logic when object is not 3D spatialized (i.e. when Ak3DSpatializationMode is AK_SpatializationMode_None).
221 enum AkSpeakerPanningType
222 {
223  AK_DirectSpeakerAssignment = 0, ///< No panning: route to matching channels between input and output.
224  AK_BalanceFadeHeight = 1, ///< Balance-Fade-Height: Traditional "box" or "car"-like panner.
225  AK_SteeringPanner = 2, ///< Steering panner.
226  AkSpeakerPanning_Last ///< End of enum, invalid value.
227 };
228 typedef AkUInt8 AkSpeakerPanningType_t;
229 
230 #define AK_POSSOURCE_NUM_STORAGE_BITS 3
231 /// 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.
232 enum Ak3DPositionType
233 {
234  AK_3DPositionType_Emitter = 0, ///< 3D spatialization is computed directly from the emitter game object position.
235  AK_3DPositionType_EmitterWithAutomation = 1, ///< 3D spatialization is computed from the emitter game object position, translated by user-defined automation.
236  AK_3DPositionType_ListenerWithAutomation = 2, ///< 3D spatialization is computed from the listener game object position, translated by user-defined automation.
237  AK_3DPositionType_Last ///< End of enum, invalid value.
238 };
239 typedef AkUInt8 Ak3DPositionType_t;
240 
241 /// Headphone / speakers panning rules
242 enum AkPanningRule
243 {
244  AkPanningRule_Speakers = 0, ///< Left and right positioned 60 degrees apart (by default - see AK::SoundEngine::GetSpeakerAngles()).
245  AkPanningRule_Headphones = 1, ///< Left and right positioned 180 degrees apart.
246  AkPanningRule_Last ///< End of enum, invalid value.
247 };
248 typedef AkUInt8 AkPanningRule_t;
249 
250 #define AK_SPAT_NUM_STORAGE_BITS 3
251 /// 3D spatialization mode.
252 enum Ak3DSpatializationMode
253 {
254  AK_SpatializationMode_None = 0, ///< No spatialization
255  AK_SpatializationMode_PositionOnly = 1, ///< Spatialization based on emitter position only.
256  AK_SpatializationMode_PositionAndOrientation = 2, ///< Spatialization based on both emitter position and emitter orientation.
257  AK_SpatializationMode_Last ///< End of enum, invalid value.
258 };
259 typedef AkUInt8 Ak3DSpatializationMode_t;
260 
261 #define AK_MAX_BITS_METERING_FLAGS (5) // Keep in sync with AkMeteringFlags.
262 
263 /// Metering flags. Used for specifying bus metering, through AK::SoundEngine::RegisterBusVolumeCallback() or AK::IAkMixerPluginContext::SetMeteringFlags().
264 enum AkMeteringFlags
265 {
266  AK_NoMetering = 0, ///< No metering.
267  AK_EnableBusMeter_Peak = 1 << 0, ///< Enable computation of peak metering.
268  AK_EnableBusMeter_TruePeak = 1 << 1, ///< Enable computation of true peak metering (most CPU and memory intensive).
269  AK_EnableBusMeter_RMS = 1 << 2, ///< Enable computation of RMS metering.
270  // 1 << 3 is reserved.
271  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).
272  AK_EnableBusMeter_3DMeter = 1 << 5, ///< Enable computation of data necessary to render a 3D visualization of volume distribution over the surface of a sphere.
273  AK_EnableBusMeter_Last ///< End of enum, invalid value.
274 };
275 typedef AkUInt8 AkMeteringFlags_t;
276 
277 /// Plug-in type.
278 /// \sa
279 /// - AkPluginInfo
280 enum AkPluginType
281 {
282  AkPluginTypeNone = 0, ///< Unknown/invalid plug-in type.
283  AkPluginTypeCodec = 1, ///< Compressor/decompressor plug-in (allows support for custom audio file types).
284  AkPluginTypeSource = 2, ///< Source plug-in: creates sound by synthesis method (no input, just output).
285  AkPluginTypeEffect = 3, ///< Effect plug-in: applies processing to audio data.
286  //AkPluginTypeMotionDevice = 4, ///< Motion Device plug-in: feeds movement data to devices. Deprecated by Motion refactor.
287  //AkPluginTypeMotionSource = 5, ///< Motion Device source plug-in: feeds movement data to device busses. Deprecated by Motion refactor.
288  AkPluginTypeMixer = 6, ///< Mixer plug-in: mix voices at the bus level.
289  AkPluginTypeSink = 7, ///< Sink plug-in: implement custom sound engine end point.
290  AkPluginTypeGlobalExtension = 8, ///< Global Extension plug-in: (e.g. Spatial Audio, Interactive Music)
291  AkPluginTypeMetadata = 9, ///< Metadata plug-in: applies object-based processing to audio data
292 
293  AkPluginType_Last, ///< End of enum, invalid value.
294  AkPluginTypeMask = 0xf ///< Plug-in type mask is 4 bits.
295 };
296 typedef AkUInt8 AkPluginType_t;
297 
298 enum AkNodeType
299 {
300  AkNodeType_Default,
301  AkNodeType_Bus,
302  AkNodeType_Last ///< End of enum, invalid value.
303 };
304 typedef AkUInt8 AkNodeType_t;
305 
306 /// AkMultiPositionType.
307 /// \aknote
308 /// - If a sound has diffraction enabled, it is treated as <tt>AkMultiPositionType_MultiDirections</tt>. <tt>AkMultiPositionType_MultiSources</tt> is not supported in this case.
309 /// \endaknote
310 /// \sa
311 /// - AK::SoundEngine::SetMultiplePosition()
312 /// - AkCommand_SetMultiplePositions
313 /// - \ref soundengine_3dpositions_multiplepos
314 enum AkMultiPositionType
315 {
316  AkMultiPositionType_SingleSource, ///< Used for normal sounds, not expected to pass to AK::SoundEngine::SetMultiplePosition() (if done, only the first position will be used).
317  AkMultiPositionType_MultiSources, ///< Simulate multiple sources in one sound playing, adding volumes. For instance, all the torches on your level emitting using only one sound.
318  AkMultiPositionType_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 ).
319 
320  AkMultiPositionType_Last ///< End of enum, invalid value.
321 };
322 typedef AkUInt8 AkMultiPositionType_t;
323 
324 /// Flags to independently set the position of the emitter or listener component on a game object.
325 enum AkSetPositionFlags
326 {
327  AkSetPositionFlags_Emitter = 1 << 0, ///< Only set the emitter component position.
328  AkSetPositionFlags_Listener = 1 << 1, ///< Only set the listener component position.
329 
330  AkSetPositionFlags_Default = (AkSetPositionFlags_Emitter | AkSetPositionFlags_Listener) ///< Default: set both emitter and listener component positions.
331 };
332 typedef AkUInt8 AkSetPositionFlags_t;
333 
334 // Type of operation for the listener commands.
335 enum AkListenerOp
336 {
337  AkListenerOp_Set, ///< Set the list of listeners
338  AkListenerOp_Add, ///< Add listeners
339  AkListenerOp_Remove, ///< Remove listeners
340 };
341 typedef AkUInt8 AkListenerOp_t;
342 
343 /// Denotes actions that can be executed on nodes referenced by events in an action of type Play
344 /// \sa
345 /// - <tt>AK::SoundEngine::ExecuteActionOnEvent()</tt>
346 /// - <tt>AkCommand_ExecuteActionOnEvent</tt>
347 enum AkActionOnEventType
348 {
349  AkActionOnEventType_Stop = 0, ///< Stop
350  AkActionOnEventType_Pause = 1, ///< Pause
351  AkActionOnEventType_Resume = 2, ///< Resume
352  AkActionOnEventType_Break = 3, ///< Break
353  AkActionOnEventType_ReleaseEnvelope = 4, ///< Release envelope
354  AkActionOnEventType_Last ///< End of enum, invalid value.
355 };
356 typedef AkUInt8 AkActionOnEventType_t;
357 
358 /// The AkDynamicSequenceType is specified when creating a new dynamic sequence.
359 ///
360 /// In sample accurate mode, when a dynamic sequence item finishes playing and there is another item
361 /// pending in its playlist, the next sound will be stitched to the end of the ending sound. In this
362 /// mode, if there are one or more pending items in the playlist while the dynamic sequence is playing,
363 /// or if something is added to the playlist during the playback, the dynamic sequence
364 /// can remove the next item to be played from the playlist and prepare it for sample accurate playback before
365 /// the first sound is finished playing. This mechanism helps keep sounds sample accurate, but then
366 /// you might not be able to remove that next item from the playlist if required.
367 ///
368 /// If your game requires the capability of removing the next to be played item from the
369 /// playlist at any time, then you should use the DynamicSequenceType_NormalTransition option instead.
370 /// In this mode, you cannot ensure sample accuracy between sounds.
371 ///
372 /// Note that a Stop or a Break will always prevent the next to be played sound from actually being played.
373 ///
374 /// \sa
375 /// - AkCmd_DynamicSequence_Open
376 /// - AK::SoundEngine::DynamicSequence::Open
377 enum AkDynamicSequenceType
378 {
379  AkDynamicSequenceType_SampleAccurate, ///< Sample accurate mode
380  AkDynamicSequenceType_NormalTransition, ///< Normal transition mode, allows the entire playlist to be edited at all times.
381  AkDynamicSequenceType_Last ///< End of enum, invalid value.
382 };
383 typedef AkUInt8 AkDynamicSequenceType_t;
384 
385 /// Denotes operations that can be executed on a Dynamic Sequence.
386 /// \sa
387 /// - AkCmd_DynamicSequence_Op
388 enum AkDynamicSequenceOp
389 {
390  AkDynamicSequenceOp_Play, // Start playback of a stopped sequence
391  AkDynamicSequenceOp_Pause, // Pause a sequence during playback.
392  AkDynamicSequenceOp_Resume, // Resume playback of a paused sequence at the position where it was paused.
393  AkDynamicSequenceOp_Stop, // Stop playback of a sequence.
394  AkDynamicSequenceOp_Break, // Stop playback of a sequence after the current item has finished playing.
395  AkDynamicSequenceOp_Close, // Signal the end of a sequence. Playback continues but no more items can be added after Close. The Dynamic Sequence will play until finished and then deallocate itself.
396 
397  AkDynamicSequenceOp_Last
398 };
399 typedef AkUInt8 AkDynamicSequenceOp_t;
400 
401 /// Channel configuration type.
402 enum AkChannelConfigType
403 {
404  AK_ChannelConfigType_Anonymous = 0x0, ///< Channel mask == 0 and channels are anonymous.
405  AK_ChannelConfigType_Standard = 0x1, ///< Channels must be identified with standard defines in AkSpeakerConfigs.
406  AK_ChannelConfigType_Ambisonic = 0x2, ///< Ambisonics. Channel mask == 0 and channels follow standard ambisonic order.
407  AK_ChannelConfigType_Objects = 0x3, ///< Object-based configurations.
408  AK_ChannelConfigType_Last, ///< End of enum, invalid value.
409 
410  AK_ChannelConfigType_UseDeviceMain = 0xE, ///< Special setting for bus objects to use the audio device main configuration.
411  AK_ChannelConfigType_UseDevicePassthrough = 0xF ///< Special setting for bus objects to use the audio device passthrough configuration.
412 };
AttenuationCurveID_Spread
@ AttenuationCurveID_Spread
The distance-driven Spread curve.
Definition: AkEnums.h:157
AkPanningRule
AkPanningRule
Headphone / speakers panning rules
Definition: AkEnums.h:243
AK_InvalidBankType
@ AK_InvalidBankType
Invalid bank type. The bank type was either supplied through a function call (e.g....
Definition: AkEnums.h:100
AK_NoMetering
@ AK_NoMetering
No metering.
Definition: AkEnums.h:266
AK_InvalidSwitchType
@ AK_InvalidSwitchType
Invalid switch type (used with the switch container)
Definition: AkEnums.h:66
AkDeviceState_Unknown
@ AkDeviceState_Unknown
The audio device state is unknown or invalid.
Definition: AkEnums.h:126
Ak3DSpatializationMode_t
AkUInt8 Ak3DSpatializationMode_t
Definition: AkEnums.h:259
AkPanningRule_Headphones
@ AkPanningRule_Headphones
Left and right positioned 180 degrees apart.
Definition: AkEnums.h:245
AkConnectionType
AkConnectionType
Nature of the connection binding an input to a bus.
Definition: AkEnums.h:139
AkActionOnEventType_t
AkUInt8 AkActionOnEventType_t
Definition: AkEnums.h:356
AkDynamicSequenceType
AkDynamicSequenceType
Definition: AkEnums.h:378
AttenuationCurveID_VolumeAuxUserDef
@ AttenuationCurveID_VolumeAuxUserDef
The distance-driven user-defined auxiliary send curve.
Definition: AkEnums.h:153
AkListenerOp_Add
@ AkListenerOp_Add
Add listeners
Definition: AkEnums.h:338
AkListenerOp_t
AkUInt8 AkListenerOp_t
Definition: AkEnums.h:341
ConnectionType_Direct
@ ConnectionType_Direct
Direct (main, dry) connection.
Definition: AkEnums.h:140
AK_DirectSpeakerAssignment
@ AK_DirectSpeakerAssignment
No panning: route to matching channels between input and output.
Definition: AkEnums.h:223
AK_EnableBusMeter_3DMeter
@ AK_EnableBusMeter_3DMeter
Enable computation of data necessary to render a 3D visualization of volume distribution over the sur...
Definition: AkEnums.h:272
AK_PathNodeAlreadyInList
@ AK_PathNodeAlreadyInList
This path is already there.
Definition: AkEnums.h:56
AK_ChannelConfigType_Standard
@ AK_ChannelConfigType_Standard
Channels must be identified with standard defines in AkSpeakerConfigs.
Definition: AkEnums.h:405
AK_BankAlreadyLoaded
@ AK_BankAlreadyLoaded
The bank load failed because the bank is already loaded.
Definition: AkEnums.h:71
AkPluginTypeSource
@ AkPluginTypeSource
Source plug-in: creates sound by synthesis method (no input, just output).
Definition: AkEnums.h:284
AkListenerOp
AkListenerOp
Definition: AkEnums.h:336
AK_InvalidFile
@ AK_InvalidFile
The provided file is the wrong format or unexpected values causes the file to be invalid.
Definition: AkEnums.h:39
AK_ProcessNeeded
@ AK_ProcessNeeded
A routine needs to be executed on some CPU.
Definition: AkEnums.h:73
AK_DeviceNotFound
@ AK_DeviceNotFound
The specified device ID does not match with any of the output devices that the sound engine is curren...
Definition: AkEnums.h:94
AK_Busy
@ AK_Busy
The system is busy and could not process the request.
Definition: AkEnums.h:78
AkSetPositionFlags_t
AkUInt8 AkSetPositionFlags_t
Definition: AkEnums.h:332
AK_ChannelConfigType_UseDevicePassthrough
@ AK_ChannelConfigType_UseDevicePassthrough
Special setting for bus objects to use the audio device passthrough configuration.
Definition: AkEnums.h:411
AkNodeType_Last
@ AkNodeType_Last
End of enum, invalid value.
Definition: AkEnums.h:302
AkCurveInterpolation_Constant
@ AkCurveInterpolation_Constant
Constant ( not valid for fading values )
Definition: AkEnums.h:198
AkPluginTypeNone
@ AkPluginTypeNone
Unknown/invalid plug-in type.
Definition: AkEnums.h:282
AkMeteringFlags
AkMeteringFlags
Metering flags. Used for specifying bus metering, through AK::SoundEngine::RegisterBusVolumeCallback(...
Definition: AkEnums.h:265
AK_AudioFileHeaderTooLarge
@ AK_AudioFileHeaderTooLarge
The file header is too large.
Definition: AkEnums.h:40
AkActionOnEventType_Stop
@ AkActionOnEventType_Stop
Stop
Definition: AkEnums.h:349
AkCurveInterpolation_Log3
@ AkCurveInterpolation_Log3
Log3
Definition: AkEnums.h:188
AK_DataReady
@ AK_DataReady
The provider has available data.
Definition: AkEnums.h:60
AttenuationCurveID_TransmissionLPF
@ AttenuationCurveID_TransmissionLPF
The transmission-driven low-pass filter curve.
Definition: AkEnums.h:172
AkDynamicSequenceOp_Stop
@ AkDynamicSequenceOp_Stop
Definition: AkEnums.h:393
AkActionOnEventType_ReleaseEnvelope
@ AkActionOnEventType_ReleaseEnvelope
Release envelope
Definition: AkEnums.h:353
AkNodeType_t
AkUInt8 AkNodeType_t
Definition: AkEnums.h:304
AK_DataNeeded
@ AK_DataNeeded
The consumer needs more.
Definition: AkEnums.h:58
AkCurveInterpolation_t
AkUInt8 AkCurveInterpolation_t
Definition: AkEnums.h:206
AK_OpenSLError
@ AK_OpenSLError
OpenSL returned an error. Check error log for more details.
Definition: AkEnums.h:88
AK_DLLPathNotFound
@ AK_DLLPathNotFound
Plugin DLL search path could not be found.
Definition: AkEnums.h:86
AK_RejectedByFilter
@ AK_RejectedByFilter
A play request was rejected due to the MIDI filter parameters.
Definition: AkEnums.h:83
AkDynamicSequenceOp_Last
@ AkDynamicSequenceOp_Last
Definition: AkEnums.h:397
AkDynamicSequenceOp_Resume
@ AkDynamicSequenceOp_Resume
Definition: AkEnums.h:392
AK_FileNotFound
@ AK_FileNotFound
File not found.
Definition: AkEnums.h:69
AkPluginType_Last
@ AkPluginType_Last
End of enum, invalid value.
Definition: AkEnums.h:293
AK_PathNotFound
@ AK_PathNotFound
This path is not known.
Definition: AkEnums.h:52
AK_DeviceNotCompatible
@ AK_DeviceNotCompatible
Incompatible Audio device.
Definition: AkEnums.h:91
AkBankTypeEnum
AkBankTypeEnum
Bank types
Definition: AkEnums.h:211
AkPanningRule_t
AkUInt8 AkPanningRule_t
Definition: AkEnums.h:248
AttenuationCurveID_OcclusionVolume
@ AttenuationCurveID_OcclusionVolume
The occlusion-driven volume curve.
Definition: AkEnums.h:163
Ak3DPositionType_t
AkUInt8 Ak3DPositionType_t
Definition: AkEnums.h:239
AkCurveInterpolation
AkCurveInterpolation
Curve interpolation types
Definition: AkEnums.h:185
AkDynamicSequenceType_Last
@ AkDynamicSequenceType_Last
End of enum, invalid value.
Definition: AkEnums.h:381
AkSpeakerPanningType
AkSpeakerPanningType
Speaker panning type: type of panning logic when object is not 3D spatialized (i.e....
Definition: AkEnums.h:222
AkDeviceState_Disabled
@ AkDeviceState_Disabled
The audio device is disabled.
Definition: AkEnums.h:128
AkCurveInterpolation_Last
@ AkCurveInterpolation_Last
End of enum, invalid value.
Definition: AkEnums.h:200
AkGroupType_t
AkUInt8 AkGroupType_t
Definition: AkEnums.h:122
AkMultiPositionType_t
AkUInt8 AkMultiPositionType_t
Definition: AkEnums.h:322
AttenuationCurveID_LowPassFilter
@ AttenuationCurveID_LowPassFilter
The distance-driven low-pass filter (pre send) curve.
Definition: AkEnums.h:154
AK_EnableBusMeter_RMS
@ AK_EnableBusMeter_RMS
Enable computation of RMS metering.
Definition: AkEnums.h:269
AK_TooManyConcurrentOperations
@ AK_TooManyConcurrentOperations
When using StdStream, file operations can be blocking or not. When not blocking, operations need to b...
Definition: AkEnums.h:105
AkDynamicSequenceOp_Play
@ AkDynamicSequenceOp_Play
Definition: AkEnums.h:390
AkDynamicSequenceOp_Close
@ AkDynamicSequenceOp_Close
Definition: AkEnums.h:395
AttenuationCurveID_VolumeAuxGameDef
@ AttenuationCurveID_VolumeAuxGameDef
The distance-driven game-defined auxiliary send curve.
Definition: AkEnums.h:152
ConnectionType_GameDefSend
@ ConnectionType_GameDefSend
Connection by a game-defined send.
Definition: AkEnums.h:141
AttenuationCurveID_OcclusionHSF
@ AttenuationCurveID_OcclusionHSF
The occlusion-driven high shelf filter curve.
Definition: AkEnums.h:166
AkUInt8
uint8_t AkUInt8
Unsigned 8-bit integer
Definition: AkNumeralTypes.h:34
AK_FormatNotReady
@ AK_FormatNotReady
Source format not known yet.
Definition: AkEnums.h:67
AkPluginTypeGlobalExtension
@ AkPluginTypeGlobalExtension
Global Extension plug-in: (e.g. Spatial Audio, Interactive Music)
Definition: AkEnums.h:290
AkBankTypeEnum_t
AkUInt8 AkBankTypeEnum_t
Definition: AkEnums.h:217
AkPluginTypeMask
@ AkPluginTypeMask
Plug-in type mask is 4 bits.
Definition: AkEnums.h:294
AK_MemManagerNotInitialized
@ AK_MemManagerNotInitialized
The memory manager should have been initialized at this point.
Definition: AkEnums.h:75
AttenuationCurveID_DiffractionHSF
@ AttenuationCurveID_DiffractionHSF
The diffraction-driven high shelf filter curve.
Definition: AkEnums.h:170
AK_PathNoVertices
@ AK_PathNoVertices
Stuff in vertices before trying to start it
Definition: AkEnums.h:53
AkActionOnEventType_Break
@ AkActionOnEventType_Break
Break
Definition: AkEnums.h:352
AK_SpatializationMode_PositionAndOrientation
@ AK_SpatializationMode_PositionAndOrientation
Spatialization based on both emitter position and emitter orientation.
Definition: AkEnums.h:256
AKRESULT_Last
@ AKRESULT_Last
End of enum, invalid value.
Definition: AkEnums.h:111
AkMultiPositionType_Last
@ AkMultiPositionType_Last
End of enum, invalid value.
Definition: AkEnums.h:320
AK_SpatializationMode_Last
@ AK_SpatializationMode_Last
End of enum, invalid value.
Definition: AkEnums.h:257
AK_InvalidFloatValue
@ AK_InvalidFloatValue
One parameter has a invalid float value such as NaN, INF or FLT_MAX.
Definition: AkEnums.h:96
AkBankType_Bus
@ AkBankType_Bus
Bank generated for one bus or aux bus.
Definition: AkEnums.h:214
Ak3DPositionType
Ak3DPositionType
3D position type: defines what acts as the emitter position for computing spatialization against the ...
Definition: AkEnums.h:233
AK_PathNotRunning
@ AK_PathNotRunning
Only a running path can be paused.
Definition: AkEnums.h:54
AK_PartialSuccess
@ AK_PartialSuccess
The operation succeeded partially.
Definition: AkEnums.h:36
AK_DLLCannotLoad
@ AK_DLLCannotLoad
Plugin DLL could not be loaded, either because it is not found or one dependency is missing.
Definition: AkEnums.h:85
AkPanningRule_Speakers
@ AkPanningRule_Speakers
Left and right positioned 60 degrees apart (by default - see AK::SoundEngine::GetSpeakerAngles()).
Definition: AkEnums.h:244
AK_InvalidStateGroup
@ AK_InvalidStateGroup
The StateGroup is not a valid channel.
Definition: AkEnums.h:46
Ak3DSpatializationMode
Ak3DSpatializationMode
3D spatialization mode.
Definition: AkEnums.h:253
ConnectionType_UserDefSend
@ ConnectionType_UserDefSend
Connection by a user-defined send.
Definition: AkEnums.h:142
AkActionOnEventType_Last
@ AkActionOnEventType_Last
End of enum, invalid value.
Definition: AkEnums.h:354
ConnectionType_Last
@ ConnectionType_Last
End of enum, invalid value.
Definition: AkEnums.h:144
AkListenerOp_Set
@ AkListenerOp_Set
Set the list of listeners
Definition: AkEnums.h:337
AkPluginTypeMetadata
@ AkPluginTypeMetadata
Metadata plug-in: applies object-based processing to audio data
Definition: AkEnums.h:291
AttenuationCurveID_VolumeDry
@ AttenuationCurveID_VolumeDry
The distance-driven dry volume curve.
Definition: AkEnums.h:151
AK_PathNotPaused
@ AK_PathNotPaused
Only a paused path can be resumed.
Definition: AkEnums.h:55
AK_ResourceInUse
@ AK_ResourceInUse
Resource is in use and cannot be released.
Definition: AkEnums.h:99
AK_NoMoreData
@ AK_NoMoreData
No more data is available from the source.
Definition: AkEnums.h:45
AkAudioDeviceState_t
AkUInt8 AkAudioDeviceState_t
Definition: AkEnums.h:135
AK_SSEInstructionsNotSupported
@ AK_SSEInstructionsNotSupported
The machine does not support SSE instructions (required on PC).
Definition: AkEnums.h:77
AK_WrongBankVersion
@ AK_WrongBankVersion
The bank version is not compatible with the current bank reader.
Definition: AkEnums.h:68
AKCODECID_BANK
#define AKCODECID_BANK
Bank encoding
Definition: AkConstants.h:115
AK_ChannelConfigType_Objects
@ AK_ChannelConfigType_Objects
Object-based configurations.
Definition: AkEnums.h:407
AK_InitBankNotLoaded
@ AK_InitBankNotLoaded
The Init bank was not loaded yet, the sound engine isn't completely ready yet.
Definition: AkEnums.h:93
AKCODECID_BANK_EVENT
#define AKCODECID_BANK_EVENT
Bank encoding for event banks. These banks are contained in the /event sub-folder.
Definition: AkConstants.h:137
AkPanningRule_Last
@ AkPanningRule_Last
End of enum, invalid value.
Definition: AkEnums.h:246
AK_ChildAlreadyHasAParent
@ AK_ChildAlreadyHasAParent
The child already has a parent.
Definition: AkEnums.h:47
AkMeteringFlags_t
AkUInt8 AkMeteringFlags_t
Definition: AkEnums.h:275
AkPluginTypeSink
@ AkPluginTypeSink
Sink plug-in: implement custom sound engine end point.
Definition: AkEnums.h:289
AkDynamicSequenceType_t
AkUInt8 AkDynamicSequenceType_t
Definition: AkEnums.h:383
AkDeviceState_NotPresent
@ AkDeviceState_NotPresent
The audio device is not present because the audio adapter that connects to the endpoint device has be...
Definition: AkEnums.h:129
AttenuationCurveID_ObstructionLPF
@ AttenuationCurveID_ObstructionLPF
The obstruction-driven low-pass filter curve.
Definition: AkEnums.h:160
AkCurveInterpolation_Exp3
@ AkCurveInterpolation_Exp3
Exp3
Definition: AkEnums.h:196
AkDynamicSequenceType_SampleAccurate
@ AkDynamicSequenceType_SampleAccurate
Sample accurate mode
Definition: AkEnums.h:379
AK_InvalidID
@ AK_InvalidID
The ID is invalid.
Definition: AkEnums.h:42
AK_FileFormatMismatch
@ AK_FileFormatMismatch
Media file format unexpected
Definition: AkEnums.h:97
AkListenerOp_Remove
@ AkListenerOp_Remove
Remove listeners
Definition: AkEnums.h:339
AttenuationCurveID_OcclusionLPF
@ AttenuationCurveID_OcclusionLPF
The occlusion-driven low-pass filter curve.
Definition: AkEnums.h:164
AkGroupType
AkGroupType
Game sync group type
Definition: AkEnums.h:117
AkCurveInterpolation_InvSCurve
@ AkCurveInterpolation_InvSCurve
Inversed S Curve
Definition: AkEnums.h:191
AK_InsufficientMemory
@ AK_InsufficientMemory
Memory error.
Definition: AkEnums.h:62
AkMultiPositionType_MultiDirections
@ AkMultiPositionType_MultiDirections
Simulate one sound coming from multiple directions. Useful for repositionning sounds based on wall op...
Definition: AkEnums.h:318
AK_Cancelled
@ AK_Cancelled
The requested action was cancelled (not an error).
Definition: AkEnums.h:63
AK_PluginMediaNotAvailable
@ AK_PluginMediaNotAvailable
Plugin media is not available for effect.
Definition: AkEnums.h:80
AkCurveInterpolation_Log1
@ AkCurveInterpolation_Log1
Log1
Definition: AkEnums.h:190
AkMultiPositionType
AkMultiPositionType
Definition: AkEnums.h:315
AK_RenderedFX
@ AK_RenderedFX
The effect on the node is rendered.
Definition: AkEnums.h:72
AkSpeakerPanningType_t
AkUInt8 AkSpeakerPanningType_t
Definition: AkEnums.h:228
AkDynamicSequenceOp_Break
@ AkDynamicSequenceOp_Break
Definition: AkEnums.h:394
AkBankType_User
@ AkBankType_User
User-defined bank.
Definition: AkEnums.h:212
AK_SteeringPanner
@ AK_SteeringPanner
Steering panner.
Definition: AkEnums.h:225
AkPluginTypeCodec
@ AkPluginTypeCodec
Compressor/decompressor plug-in (allows support for custom audio file types).
Definition: AkEnums.h:283
AkDeviceState_Unplugged
@ AkDeviceState_Unplugged
The audio device is unplugged.
Definition: AkEnums.h:130
AK_ProcessDone
@ AK_ProcessDone
The executed routine has finished its execution.
Definition: AkEnums.h:74
AK_SpatializationMode_PositionOnly
@ AK_SpatializationMode_PositionOnly
Spatialization based on emitter position only.
Definition: AkEnums.h:255
ConnectionType_ReflectionsSend
@ ConnectionType_ReflectionsSend
Connection by a early reflections send.
Definition: AkEnums.h:143
AkGroupType_Switch
@ AkGroupType_Switch
Type switch
Definition: AkEnums.h:119
AK_InvalidFileSize
@ AK_InvalidFileSize
The file requested was found and opened but is either 0 bytes long or not the expected size....
Definition: AkEnums.h:106
AkAttenuationCurveType
AkAttenuationCurveType
Curve types of the Attenuation Editor.
Definition: AkEnums.h:150
AkDeviceState_Active
@ AkDeviceState_Active
The audio device is active That is, the audio adapter that connects to the endpoint device is present...
Definition: AkEnums.h:127
AttenuationCurveID_HighPassFilter
@ AttenuationCurveID_HighPassFilter
The distance-driven high-pass filter (pre send) curve.
Definition: AkEnums.h:155
AkDeviceState_Last
@ AkDeviceState_Last
End of enum, invalid value.
Definition: AkEnums.h:131
AkPluginType
AkPluginType
Definition: AkEnums.h:281
AK_ElementAlreadyInList
@ AK_ElementAlreadyInList
The item could not be added because it was already in the list.
Definition: AkEnums.h:51
AK_PlayingIDNotFound
@ AK_PlayingIDNotFound
Calling a function with a playing ID that is not known.
Definition: AkEnums.h:95
AK_EnableBusMeter_Peak
@ AK_EnableBusMeter_Peak
Enable computation of peak metering.
Definition: AkEnums.h:267
AttenuationCurveID_OcclusionHPF
@ AttenuationCurveID_OcclusionHPF
The occlusion-driven high-pass filter curve.
Definition: AkEnums.h:165
AKCODECID_BANK_BUS
#define AKCODECID_BANK_BUS
Bank encoding for bus banks. These banks are contained in the /bus sub-folder.
Definition: AkConstants.h:138
AK_ChannelConfigType_UseDeviceMain
@ AK_ChannelConfigType_UseDeviceMain
Special setting for bus objects to use the audio device main configuration.
Definition: AkEnums.h:410
AK_DuplicateUniqueID
@ AK_DuplicateUniqueID
Two Wwise objects share the same ID.
Definition: AkEnums.h:92
AK_Fail
@ AK_Fail
The operation failed.
Definition: AkEnums.h:35
AK_UnknownFileError
@ AK_UnknownFileError
Rare file error occured, as opposed to AK_FileNotFound or AK_FilePermissionError. This lumps all unre...
Definition: AkEnums.h:104
AkConnectionType_t
AkUInt8 AkConnectionType_t
Definition: AkEnums.h:146
AkCurveInterpolation_SineRecip
@ AkCurveInterpolation_SineRecip
Reciprocal of sine curve
Definition: AkEnums.h:195
AkDynamicSequenceOp_Pause
@ AkDynamicSequenceOp_Pause
Definition: AkEnums.h:391
AK_CommandTooLarge
@ AK_CommandTooLarge
SDK command is too large to fit in the command queue.
Definition: AkEnums.h:82
AkPluginTypeEffect
@ AkPluginTypeEffect
Effect plug-in: applies processing to audio data.
Definition: AkEnums.h:285
AkChannelConfigType
AkChannelConfigType
Channel configuration type.
Definition: AkEnums.h:403
AttenuationCurveID_ObstructionVolume
@ AttenuationCurveID_ObstructionVolume
The obstruction-driven volume curve.
Definition: AkEnums.h:159
AK_InvalidLanguage
@ AK_InvalidLanguage
The language is invalid (applies to the Low-Level I/O).
Definition: AkEnums.h:48
AK_PathNodeNotInList
@ AK_PathNodeNotInList
This path is not there.
Definition: AkEnums.h:57
AK_InvalidCustomPlatformName
@ AK_InvalidCustomPlatformName
Detecting incompatibility between Custom platform of banks and custom platform of connected applicati...
Definition: AkEnums.h:84
AttenuationCurveID_Focus
@ AttenuationCurveID_Focus
The distance-driven Focus curve.
Definition: AkEnums.h:158
AK_EnableBusMeter_TruePeak
@ AK_EnableBusMeter_TruePeak
Enable computation of true peak metering (most CPU and memory intensive).
Definition: AkEnums.h:268
AK_EnableBusMeter_KPower
@ AK_EnableBusMeter_KPower
Enable computation of K-weighted power metering (used as a basis for computing loudness,...
Definition: AkEnums.h:271
AK_InvalidInstanceID
@ AK_InvalidInstanceID
The InstanceID is invalid.
Definition: AkEnums.h:44
AKRESULT
AKRESULT
Definition: AkEnums.h:32
AkSetPositionFlags
AkSetPositionFlags
Flags to independently set the position of the emitter or listener component on a game object.
Definition: AkEnums.h:326
AK_ChannelConfigType_Ambisonic
@ AK_ChannelConfigType_Ambisonic
Ambisonics. Channel mask == 0 and channels follow standard ambisonic order.
Definition: AkEnums.h:406
AttenuationCurveID_None
@ AttenuationCurveID_None
Symbol for "None".
Definition: AkEnums.h:179
AK_DeviceNotReady
@ AK_DeviceNotReady
Specified ID doesn't match a valid hardware device: either the device doesn't exist or is disabled.
Definition: AkEnums.h:70
AkBankType_Last
@ AkBankType_Last
End of enum, invalid value.
Definition: AkEnums.h:215
AK_MaxReached
@ AK_MaxReached
The maximum was reached.
Definition: AkEnums.h:41
AttenuationCurveID_HighShelf
@ AttenuationCurveID_HighShelf
The distance-driven high shelf filter curve.
Definition: AkEnums.h:156
AkAudioDeviceState
AkAudioDeviceState
Definition: AkEnums.h:125
AK_AlreadyConnected
@ AK_AlreadyConnected
The stream is already connected to another node.
Definition: AkEnums.h:38
AK_IDNotFound
@ AK_IDNotFound
The ID was not found.
Definition: AkEnums.h:43
AkCurveInterpolation_Linear
@ AkCurveInterpolation_Linear
Linear (Default)
Definition: AkEnums.h:192
AkNodeType
AkNodeType
Definition: AkEnums.h:299
AK_NoDistinctListener
@ AK_NoDistinctListener
No distinct listener provided for AddOutput
Definition: AkEnums.h:98
AK_NoDataReady
@ AK_NoDataReady
The provider does not have available data.
Definition: AkEnums.h:61
AttenuationCurveID_TransmissionHPF
@ AttenuationCurveID_TransmissionHPF
The transmission-driven high-pass filter curve.
Definition: AkEnums.h:173
AK_UnknownBankID
@ AK_UnknownBankID
Trying to load a bank using an ID which is not defined.
Definition: AkEnums.h:64
AkCurveInterpolation_Exp1
@ AkCurveInterpolation_Exp1
Exp1
Definition: AkEnums.h:194
AkGroupType_State
@ AkGroupType_State
Type state
Definition: AkEnums.h:120
AK_ChannelConfigType_Last
@ AK_ChannelConfigType_Last
End of enum, invalid value.
Definition: AkEnums.h:408
AttenuationCurveID_ObstructionHPF
@ AttenuationCurveID_ObstructionHPF
The obstruction-driven high-pass filter curve.
Definition: AkEnums.h:161
AkCurveInterpolation_SCurve
@ AkCurveInterpolation_SCurve
S Curve
Definition: AkEnums.h:193
AK_InvalidParameter
@ AK_InvalidParameter
Something is not within bounds, check the documentation of the function returning this code.
Definition: AkEnums.h:50
AkSetPositionFlags_Default
@ AkSetPositionFlags_Default
Default: set both emitter and listener component positions.
Definition: AkEnums.h:330
AkUInt32
uint32_t AkUInt32
Unsigned 32-bit integer
Definition: AkNumeralTypes.h:35
AkPluginTypeMixer
@ AkPluginTypeMixer
Mixer plug-in: mix voices at the bus level.
Definition: AkEnums.h:288
AK_ChannelConfigType_Anonymous
@ AK_ChannelConfigType_Anonymous
Channel mask == 0 and channels are anonymous.
Definition: AkEnums.h:404
AttenuationCurveID_Project
@ AttenuationCurveID_Project
Symbol for "Use Project".
Definition: AkEnums.h:178
AkSetPositionFlags_Emitter
@ AkSetPositionFlags_Emitter
Only set the emitter component position.
Definition: AkEnums.h:327
AkNodeType_Bus
@ AkNodeType_Bus
Definition: AkEnums.h:301
AK_MustBeVirtualized
@ AK_MustBeVirtualized
Sound was Not Allowed to play.
Definition: AkEnums.h:81
AK_3DPositionType_ListenerWithAutomation
@ AK_3DPositionType_ListenerWithAutomation
3D spatialization is computed from the listener game object position, translated by user-defined auto...
Definition: AkEnums.h:236
AK_BankReadError
@ AK_BankReadError
Error while reading a bank.
Definition: AkEnums.h:65
AkActionOnEventType_Resume
@ AkActionOnEventType_Resume
Resume
Definition: AkEnums.h:351
AkCurveInterpolation_LastFadeCurve
@ AkCurveInterpolation_LastFadeCurve
Update this value to reflect last curve available for fades
Definition: AkEnums.h:197
AK_3DPositionType_Emitter
@ AK_3DPositionType_Emitter
3D spatialization is computed directly from the emitter game object position.
Definition: AkEnums.h:234
AkDynamicSequenceOp
AkDynamicSequenceOp
Definition: AkEnums.h:389
AkMultiPositionType_MultiSources
@ AkMultiPositionType_MultiSources
Simulate multiple sources in one sound playing, adding volumes. For instance, all the torches on your...
Definition: AkEnums.h:317
AK_InvalidState
@ AK_InvalidState
This method should not be called when the object is in its current state.
Definition: AkEnums.h:109
AK_PluginNotRegistered
@ AK_PluginNotRegistered
Plugin is not registered. Make sure to implement a AK::PluginRegistration class for it and use AK_STA...
Definition: AkEnums.h:89
AkAttenuationCurveType_t
AkUInt8 AkAttenuationCurveType_t
Definition: AkEnums.h:181
AK_CannotAddItselfAsAChild
@ AK_CannotAddItselfAsAChild
It is not possible to add itself as its own child.
Definition: AkEnums.h:49
AK_EnableBusMeter_Last
@ AK_EnableBusMeter_Last
End of enum, invalid value.
Definition: AkEnums.h:273
AK_NotImplemented
@ AK_NotImplemented
This feature is not implemented.
Definition: AkEnums.h:33
AK_FilePermissionError
@ AK_FilePermissionError
The file access permissions prevent opening a file.
Definition: AkEnums.h:103
AK_Success
@ AK_Success
The operation was successful.
Definition: AkEnums.h:34
AkMultiPositionType_SingleSource
@ AkMultiPositionType_SingleSource
Used for normal sounds, not expected to pass to AK::SoundEngine::SetMultiplePosition() (if done,...
Definition: AkEnums.h:316
AttenuationCurveID_DiffractionVolume
@ AttenuationCurveID_DiffractionVolume
The diffraction-driven volume curve.
Definition: AkEnums.h:167
AttenuationCurveID_TransmissionVolume
@ AttenuationCurveID_TransmissionVolume
The transmission-driven volume curve.
Definition: AkEnums.h:171
AttenuationCurveID_DiffractionHPF
@ AttenuationCurveID_DiffractionHPF
The diffraction-driven high-pass filter curve.
Definition: AkEnums.h:169
AkSpeakerPanning_Last
@ AkSpeakerPanning_Last
End of enum, invalid value.
Definition: AkEnums.h:226
AK_FilePathTooLong
@ AK_FilePathTooLong
The combination of base path and file name exceeds maximum buffer lengths.
Definition: AkEnums.h:108
AkSetPositionFlags_Listener
@ AkSetPositionFlags_Listener
Only set the listener component position.
Definition: AkEnums.h:328
AK_NoDataNeeded
@ AK_NoDataNeeded
The consumer does not need more.
Definition: AkEnums.h:59
AkNodeType_Default
@ AkNodeType_Default
Definition: AkEnums.h:300
AK_Deferred
@ AK_Deferred
Returned by functions to indicate to the caller the that the operation is done asynchronously....
Definition: AkEnums.h:107
AKRESULT_t
AkUInt32 AKRESULT_t
Definition: AkEnums.h:113
AK_NotCompatible
@ AK_NotCompatible
Incompatible formats
Definition: AkEnums.h:37
AK_3DPositionType_Last
@ AK_3DPositionType_Last
End of enum, invalid value.
Definition: AkEnums.h:237
AkDynamicSequenceOp_t
AkUInt8 AkDynamicSequenceOp_t
Definition: AkEnums.h:399
AkDeviceState_All
@ AkDeviceState_All
Includes audio devices in all states.
Definition: AkEnums.h:133
AK_StreamMgrNotInitialized
@ AK_StreamMgrNotInitialized
The stream manager should have been initialized at this point.
Definition: AkEnums.h:76
AK_UnsupportedChannelConfig
@ AK_UnsupportedChannelConfig
Channel configuration is not supported in the current execution context.
Definition: AkEnums.h:79
AkBankType_Event
@ AkBankType_Event
Bank generated for one event.
Definition: AkEnums.h:213
AK_SpatializationMode_None
@ AK_SpatializationMode_None
No spatialization
Definition: AkEnums.h:254
AkDynamicSequenceType_NormalTransition
@ AkDynamicSequenceType_NormalTransition
Normal transition mode, allows the entire playlist to be edited at all times.
Definition: AkEnums.h:380
AkActionOnEventType
AkActionOnEventType
Definition: AkEnums.h:348
AK_NoJavaVM
@ AK_NoJavaVM
No Java VM provided in AkInitSettings.
Definition: AkEnums.h:87
AkCurveInterpolation_Sine
@ AkCurveInterpolation_Sine
Sine
Definition: AkEnums.h:189
AK_NotInitialized
@ AK_NotInitialized
The component being used is not initialized. Most likely AK::SoundEngine::Init() was not called yet,...
Definition: AkEnums.h:102
AttenuationCurveID_TransmissionHSF
@ AttenuationCurveID_TransmissionHSF
The transmission-driven high shelf filter curve.
Definition: AkEnums.h:174
AK_AlreadyInitialized
@ AK_AlreadyInitialized
Init() was called but that element was already initialized.
Definition: AkEnums.h:101
AttenuationCurveID_ObstructionHSF
@ AttenuationCurveID_ObstructionHSF
The obstruction-driven high shelf filter curve.
Definition: AkEnums.h:162
AttenuationCurveID_DiffractionLPF
@ AttenuationCurveID_DiffractionLPF
The diffraction-driven low-pass filter curve.
Definition: AkEnums.h:168
AkPluginType_t
AkUInt8 AkPluginType_t
Definition: AkEnums.h:296
AK_DataAlignmentError
@ AK_DataAlignmentError
A pointer to audio data was not aligned to the platform's required alignment (check AkTypes....
Definition: AkEnums.h:90
AkActionOnEventType_Pause
@ AkActionOnEventType_Pause
Pause
Definition: AkEnums.h:350
AK_BalanceFadeHeight
@ AK_BalanceFadeHeight
Balance-Fade-Height: Traditional "box" or "car"-like panner.
Definition: AkEnums.h:224
AttenuationCurveID_MaxCount
@ AttenuationCurveID_MaxCount
The maximum number of curve types.
Definition: AkEnums.h:176
AK_3DPositionType_EmitterWithAutomation
@ AK_3DPositionType_EmitterWithAutomation
3D spatialization is computed from the emitter game object position, translated by user-defined autom...
Definition: AkEnums.h:235

このページはお役に立ちましたか？

サポートは必要ですか？

ご質問や問題、ご不明点はございますか？お気軽にお問い合わせください。

サポートページをご確認ください

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。

プロジェクトを登録していただくことで、ご利用開始のサポートをいたします。

Wwiseからはじめよう