Version
menu_open
Wwise SDK 2019.2.15
AkMonitorError.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 #ifndef _AKMONITORERROR_H
29 #define _AKMONITORERROR_H
30 
31 #include <AK/SoundEngine/Common/AkSoundEngineExport.h>
32 #include <AK/SoundEngine/Common/AkTypes.h>
33 
34 namespace AK
35 {
36  // Error monitoring.
37 
38  namespace Monitor
39  {
40  /// ErrorLevel
41  enum ErrorLevel
42  {
43  ErrorLevel_Message = (1<<0), // used as bitfield
44  ErrorLevel_Error = (1<<1),
45 
46  ErrorLevel_All = ErrorLevel_Message | ErrorLevel_Error
47  };
48  /// ErrorCode
49  enum ErrorCode
50  {
51  ErrorCode_NoError = 0, // 0-based index into AK::Monitor::s_aszErrorCodes table
52  ErrorCode_FileNotFound,
53  ErrorCode_CannotOpenFile,
54  ErrorCode_CannotStartStreamNoMemory,
55  ErrorCode_IODevice,
56  ErrorCode_IncompatibleIOSettings,
57 
58  ErrorCode_PluginUnsupportedChannelConfiguration,
59  ErrorCode_PluginMediaUnavailable,
60  ErrorCode_PluginInitialisationFailed,
61  ErrorCode_PluginProcessingFailed,
62  ErrorCode_PluginExecutionInvalid,
63  ErrorCode_PluginAllocationFailed,
64 
65  ErrorCode_VorbisSeekTableRecommended,
66 
67  ErrorCode_VorbisDecodeError,
68  ErrorCode_AACDecodeError,
69 
70  ErrorCode_xWMACreateDecoderFailed,//Deprecated, keep in place for legacy maintenance.
71 
72  ErrorCode_ATRAC9DecodeFailed,
73  ErrorCode_ATRAC9LoopSectionTooSmall,
74 
75  ErrorCode_InvalidAudioFileHeader,
76  ErrorCode_AudioFileHeaderTooLarge,
77  ErrorCode_FileTooSmall,
78 
79  ErrorCode_TransitionNotAccurateChannel,
80  ErrorCode_TransitionNotAccuratePluginMismatch,
81  ErrorCode_TransitionNotAccurateRejectedByPlugin,
82  ErrorCode_TransitionNotAccurateStarvation,
83  ErrorCode_NothingToPlay,
84  ErrorCode_PlayFailed,
85 
86  ErrorCode_StingerCouldNotBeScheduled,
87  ErrorCode_TooLongSegmentLookAhead,
88  ErrorCode_CannotScheduleMusicSwitch,
89  ErrorCode_TooManySimultaneousMusicSegments,
90  ErrorCode_PlaylistStoppedForEditing,
91  ErrorCode_MusicClipsRescheduledAfterTrackEdit,
92 
93  ErrorCode_CannotPlaySource_Create,
94  ErrorCode_CannotPlaySource_VirtualOff,
95  ErrorCode_CannotPlaySource_TimeSkip,
96  ErrorCode_CannotPlaySource_InconsistentState,
97  ErrorCode_MediaNotLoaded,
98  ErrorCode_VoiceStarving,
99  ErrorCode_StreamingSourceStarving,
100  ErrorCode_XMADecoderSourceStarving,
101  ErrorCode_XMADecodingError,
102  ErrorCode_InvalidXMAData,
103 
104  ErrorCode_PluginNotRegistered,
105  ErrorCode_CodecNotRegistered,
106  ErrorCode_PluginVersionMismatch,
107 
108  ErrorCode_EventIDNotFound,
109 
110  ErrorCode_InvalidGroupID,
111  ErrorCode_SelectedChildNotAvailable,
112  ErrorCode_SelectedNodeNotAvailable,
113  ErrorCode_SelectedMediaNotAvailable,
114  ErrorCode_NoValidSwitch,
115 
116  ErrorCode_SelectedNodeNotAvailablePlay,
117 
118  ErrorCode_FeedbackVoiceStarving,
119 
120  ErrorCode_BankLoadFailed,
121  ErrorCode_BankUnloadFailed,
122  ErrorCode_ErrorWhileLoadingBank,
123  ErrorCode_InsufficientSpaceToLoadBank,
124 
125  ErrorCode_LowerEngineCommandListFull,
126 
127  ErrorCode_SeekNoMarker,
128  ErrorCode_CannotSeekContinuous,
129  ErrorCode_SeekAfterEof,
130 
131  ErrorCode_UnknownGameObject,
132  ErrorCode_UnknownEmitter, //Deprecated
133  ErrorCode_UnknownListener,
134  ErrorCode_GameObjectIsNotListener,
135  ErrorCode_GameObjectIsNotEmitter,
136  ErrorCode_UnknownGameObjectEvent, //Deprecated
137  ErrorCode_GameObjectIsNotEmitterEvent,
138 
139  ErrorCode_ExternalSourceNotResolved,
140  ErrorCode_FileFormatMismatch,
141 
142  ErrorCode_CommandQueueFull,
143  ErrorCode_CommandTooLarge,
144 
145  ErrorCode_XMACreateDecoderLimitReached,
146  ErrorCode_XMAStreamBufferTooSmall,
147 
148  ErrorCode_ModulatorScopeError_Inst,
149  ErrorCode_ModulatorScopeError_Obj,
150 
151  ErrorCode_SeekAfterEndOfPlaylist,
152 
153  ErrorCode_OpusRequireSeekTable,
154  ErrorCode_OpusDecodeError,
155  ErrorCode_OpusCreateDecoderFailed,
156 
157  ErrorCode_SourcePluginNotFound,
158 
159  ErrorCode_VirtualVoiceLimit,
160 
161  ErrorCode_AudioDeviceShareSetNotFound,
162 
163  ErrorCode_NotEnoughMemoryToStart,
164  ErrorCode_UnkownOpusError,
165 
166  ErrorCode_AudioDeviceInitFailure,
167  ErrorCode_AudioDeviceRemoveFailure,
168  ErrorCode_AudioDeviceNotFound,
169  ErrorCode_AudioDeviceNotValid,
170 
171  ErrorCode_SpatialAudio_ListenerAutomationNotSupported,
172  ErrorCode_MediaDuplicationLength,
173 
174  ErrorCode_HwVoicesSystemInitFailed, // When the hardware-accelerated subsystem fails to initialize
175  ErrorCode_HwVoicesDecodeBatchFailed, // When a grouping of hardware-accelerated voices fail to decode collectively
176  ErrorCode_HwVoiceLimitReached, // Cannot create any more hardware-accelerated voices
177  ErrorCode_HwVoiceInitFailed, // A hardware-accelerated voice fails to be created, but not because the max number of voices was reached
178 
179  ErrorCode_SpatialAudio_ReflectionBusError,
180 
181  // ALWAYS ADD NEW CODES AT THE END !!!!!!!
182  // Otherwise it may break comm compatibility in a patch
183 
184  Num_ErrorCodes // THIS STAYS AT END OF ENUM
185  };
186 
187  static_assert(Num_ErrorCodes == 97,
188  "Please document your new ErrorCode "
189  "in 'Documentation/Help/source_en/reference/common_errors_capture_log.xml', "
190  "then you can increment this value."
191  );
192 
193  /// Function prototype of local output function pointer.
194  AK_CALLBACK( void, LocalOutputFunc )(
195  ErrorCode in_eErrorCode, ///< Error code number value
196  const AkOSChar* in_pszError, ///< Message or error string to be displayed
197  ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
198  AkPlayingID in_playingID, ///< Related Playing ID if applicable, AK_INVALID_PLAYING_ID otherwise
199  AkGameObjectID in_gameObjID ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
200  );
201 
202  extern const AkOSChar* s_aszErrorCodes[ Num_ErrorCodes ];
203 
204  /// Post a monitoring message or error code. This will be displayed in the Wwise capture
205  /// log.
206  /// \return AK_Success if successful, AK_Fail if there was a problem posting the message.
207  /// In optimized mode, this function returns AK_NotCompatible.
208  /// \remark This function is provided as a tracking tool only. It does nothing if it is
209  /// called in the optimized/release configuration and return AK_NotCompatible.
210  AK_EXTERNAPIFUNC( AKRESULT, PostCode )(
211  ErrorCode in_eError, ///< Message or error code to be displayed
212  ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
213  AkPlayingID in_playingID = AK_INVALID_PLAYING_ID, ///< Related Playing ID if applicable
214  AkGameObjectID in_gameObjID = AK_INVALID_GAME_OBJECT, ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
215  AkUniqueID in_audioNodeID = AK_INVALID_UNIQUE_ID, ///< Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise
216  bool in_bIsBus = false ///< true if in_audioNodeID is a bus
217  );
218 #ifdef AK_SUPPORT_WCHAR
219  /// Post a unicode monitoring message or error string. This will be displayed in the Wwise capture
220  /// log.
221  /// \return AK_Success if successful, AK_Fail if there was a problem posting the message.
222  /// In optimized mode, this function returns AK_NotCompatible.
223  /// \remark This function is provided as a tracking tool only. It does nothing if it is
224  /// called in the optimized/release configuration and return AK_NotCompatible.
225  AK_EXTERNAPIFUNC( AKRESULT, PostString )(
226  const wchar_t* in_pszError, ///< Message or error string to be displayed
227  ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
228  AkPlayingID in_playingID = AK_INVALID_PLAYING_ID, ///< Related Playing ID if applicable
229  AkGameObjectID in_gameObjID = AK_INVALID_GAME_OBJECT, ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
230  AkUniqueID in_audioNodeID = AK_INVALID_UNIQUE_ID, ///< Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise
231  bool in_bIsBus = false ///< true if in_audioNodeID is a bus
232  );
233 #endif // #ifdef AK_SUPPORT_WCHAR
234  /// Post a monitoring message or error string. This will be displayed in the Wwise capture
235  /// log.
236  /// \return AK_Success if successful, AK_Fail if there was a problem posting the message.
237  /// In optimized mode, this function returns AK_NotCompatible.
238  /// \remark This function is provided as a tracking tool only. It does nothing if it is
239  /// called in the optimized/release configuration and return AK_NotCompatible.
240  AK_EXTERNAPIFUNC( AKRESULT, PostString )(
241  const char* in_pszError, ///< Message or error string to be displayed
242  ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
243  AkPlayingID in_playingID = AK_INVALID_PLAYING_ID, ///< Related Playing ID if applicable
244  AkGameObjectID in_gameObjID = AK_INVALID_GAME_OBJECT, ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
245  AkUniqueID in_audioNodeID = AK_INVALID_UNIQUE_ID, ///< Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise
246  bool in_bIsBus = false ///< true if in_audioNodeID is a bus
247  );
248 
249  /// Enable/Disable local output of monitoring messages or errors. Pass 0 to disable,
250  /// or any combination of ErrorLevel_Message and ErrorLevel_Error to enable.
251  /// \return AK_Success.
252  /// In optimized/release configuration, this function returns AK_NotCompatible.
253  AK_EXTERNAPIFUNC( AKRESULT, SetLocalOutput )(
254  AkUInt32 in_uErrorLevel = ErrorLevel_All, ///< ErrorLevel(s) to enable in output. Default parameters enable all.
255  LocalOutputFunc in_pMonitorFunc = 0 ///< Handler for local output. If NULL, the standard platform debug output method is used.
256  );
257 
258  /// Get the time stamp shown in the capture log along with monitoring messages.
259  /// \return Time stamp in milliseconds.
260  /// In optimized/release configuration, this function returns 0.
261  AK_EXTERNAPIFUNC( AkTimeMs, GetTimeStamp )();
262  }
263 }
264 
265 // Macros.
266 #ifndef AK_OPTIMIZED
267  #define AK_MONITOR_ERROR( in_eErrorCode )\
268  AK::Monitor::PostCode( in_eErrorCode, AK::Monitor::ErrorLevel_Error )
269 #else
270  #define AK_MONITOR_ERROR( in_eErrorCode )
271 #endif
272 
273 #ifdef AK_MONITOR_IMPLEMENT_ERRORCODES
274 namespace AK
275 {
276  namespace Monitor
277  {
278  const AkOSChar* s_aszErrorCodes[ Num_ErrorCodes ] =
279  {
280  AKTEXT("No error"), // ErrorCode_NoError
281  AKTEXT("File not found"), // ErrorCode_FileNotFound,
282  AKTEXT("Cannot open file"), // ErrorCode_CannotOpenFile,
283  AKTEXT("Not enough memory in I/O pool to start stream"), // ErrorCode_CannotStartStreamNoMemory,
284  AKTEXT("Unknown I/O device error"), // ErrorCode_IODevice,
285  AKTEXT("I/O settings incompatible."), // ErrorCode_IncompatibleIOSettings
286 
287  AKTEXT("Plug-in unsupported channel configuration"), // ErrorCode_PluginUnsupportedChannelConfiguration,
288  AKTEXT("Plug-in media unavailable"), // ErrorCode_PluginMediaUnavailable,
289  AKTEXT("Plug-in initialization failure"), // ErrorCode_PluginInitialisationFailed,
290  AKTEXT("Plug-in execution failure"), // ErrorCode_PluginProcessingFailed,
291  AKTEXT("Invalid plug-in execution mode"), // ErrorCode_PluginExecutionInvalid
292  AKTEXT("Could not allocate effect"), // ErrorCode_PluginAllocationFailed
293 
294 AKTEXT("Seek table recommended to seek in Vorbis sources. Please update conversion settings."), // ErrorCode_VorbisSeekTableRecommended,
295 
296 AKTEXT("Vorbis decoder failure"), // ErrorCode_VorbisDecodeError,
297 AKTEXT("AAC decoder failure"), // ErrorCode_AACDecodeError
298 
299 AKTEXT("Failed creating xWMA decoder"), // ErrorCode_xWMACreateDecoderFailed,
300 
301 AKTEXT("ATRAC9 decoding failed"), // ErrorCode_ATRAC9DecodeFailed
302 AKTEXT("ATRAC9 loop section is too small"), // ErrorCode_ATRAC9LoopSectionTooSmall
303 
304 AKTEXT("Invalid file header"), // ErrorCode_InvalidAudioFileHeader,
305 AKTEXT("File header too large (due to markers or envelope)"), // ErrorCode_AudioFileHeaderTooLarge,
306 AKTEXT("File or loop region is too small to be played properly"), // ErrorCode_FileTooSmall,
307 
308 AKTEXT("Transition not sample-accurate due to mixed channel configurations"), // ErrorCode_TransitionNotAccurateChannel,
309 AKTEXT("Transition not sample-accurate due to incompatible audio formats"), // ErrorCode_TransitionNotAccuratePluginMismatch,
310 AKTEXT("Transition not sample-accurate due to incompatible encoding parameters"), // ErrorCode_TransitionNotAccurateRejectedByPlugin
311 AKTEXT("Transition not sample-accurate due to source starvation"), // ErrorCode_TransitionNotAccurateStarvation,
312 AKTEXT("Nothing to play in Dynamic Sequence"), // ErrorCode_NothingToPlay,
313 AKTEXT("Play Failed"), // ErrorCode_PlayFailed, // Notification meaning the play asked was not done for an out of control reason
314 // For example, if The Element has a missing source file.
315 
316 AKTEXT("Stinger could not be scheduled in this segment or was dropped"), // ErrorCode_StingerCouldNotBeScheduled,
317 AKTEXT("Segment look-ahead plus pre-entry duration is longer than previous segment in sequence"), // ErrorCode_TooLongSegmentLookAhead,
318 AKTEXT("Cannot schedule music switch transition in upcoming segments: using Exit Cue"), // ErrorCode_CannotScheduleMusicSwitch,
319 AKTEXT("Cannot schedule music segments: Stopping music"), // ErrorCode_TooManySimultaneousMusicSegments,
320 AKTEXT("Music system is stopped because a music playlist is modified"), // ErrorCode_PlaylistStoppedForEditing
321 AKTEXT("Rescheduling music clips because a track was modified"), // ErrorCode_MusicClipsRescheduledAfterTrackEdit
322 
323 AKTEXT("Failed creating source"), // ErrorCode_CannotPlaySource_Create,
324 AKTEXT("Virtual source failed becoming physical"), // ErrorCode_CannotPlaySource_VirtualOff,
325 AKTEXT("Error while computing virtual source elapsed time"), // ErrorCode_CannotPlaySource_TimeSkip,
326 AKTEXT("Inconsistent source status"), // ErrorCode_CannotPlaySource_InconsistentState,
327 AKTEXT("Media was not loaded for this source"),// ErrorCode_MediaNotLoaded,
328 AKTEXT("Voice Starvation"), // ErrorCode_VoiceStarving,
329 AKTEXT("Source starvation"), // ErrorCode_StreamingSourceStarving,
330 AKTEXT("XMA decoder starvation"), // ErrorCode_XMADecoderSourceStarving,
331 AKTEXT("XMA decoding error"), // ErrorCode_XMADecodingError
332 AKTEXT("Invalid XMA data - Make sure data is allocated from APU memory and is aligned to 2K."), // ErrorCode_InvalidXMAData
333 
334 AKTEXT("Plug-in not found"), // ErrorCode_PluginNotRegistered,
335 AKTEXT("Codec plug-in not registered"), // ErrorCode_CodecNotRegistered,
336 AKTEXT("Plug-in version doesn't match sound engine version. Please ensure the plug-in is compatible with this version of Wwise"), //ErrorCode_PluginVersionMismatch
337 
338 AKTEXT("Event ID not found"), // ErrorCode_EventIDNotFound,
339 
340 AKTEXT("Invalid State Group ID"), // ErrorCode_InvalidGroupID,
341 AKTEXT("Selected Child Not Available"), // ErrorCode_SelectedChildNotAvailable,
342 AKTEXT("Selected Node Not Available"), // ErrorCode_SelectedNodeNotAvailable,
343 AKTEXT("Selected Media Not Available"),// ErrorCode_SelectedMediaNotAvailable,
344 AKTEXT("No Valid Switch"), // ErrorCode_NoValidSwitch,
345 
346 AKTEXT("Selected node not available. Make sure the structure associated to the event is loaded or that the event has been prepared"), // ErrorCode_SelectedNodeNotAvailablePlay,
347 
348 AKTEXT("Motion voice starvation"), // ErrorCode_FeedbackVoiceStarving,
349 
350 AKTEXT("Bank Load Failed"), // ErrorCode_BankLoadFailed,
351 AKTEXT("Bank Unload Failed"), // ErrorCode_BankUnloadFailed,
352 AKTEXT("Error while loading bank"), // ErrorCode_ErrorWhileLoadingBank,
353 AKTEXT("Insufficient Space to Load Bank"), // ErrorCode_InsufficientSpaceToLoadBank,
354 
355 AKTEXT("Lower engine command list is full"), // ErrorCode_LowerEngineCommandListFull,
356 
357 AKTEXT("No marker in file; seeking to specified location"), // ErrorCode_SeekNoMarker
358 AKTEXT("Cannot seek in sound that is within a continuous container with special transitions"), // ErrorCode_CannotSeekContinuous
359 AKTEXT("Seeking after end of file. Playback will stop"), // ErrorCode_SeekAfterEof
360 
361 AKTEXT("Unknown game object ID. Make sure the game object is registered before using it and do not use it once it was unregistered."), // ErrorCode_UnknownGameObject,
362 
363 AKTEXT("Unknown emitter game object ID. Make sure the game object is registered before using it and do not use it once it was unregistered."), // ErrorCode_UnknownEmitter,
364 AKTEXT("Unknown listener game object ID. Make sure the game object is registered before using it and do not use it once it was unregistered."), // ErrorCode_UnknownListener,
365 AKTEXT("The requested game object is not a listener."), // ErrorCode_GameObjectIsNotListener,
366 AKTEXT("The requested game object is not an emitter."), // ErrorCode_GameObjectIsNotEmitter,
367 
368 AKTEXT("Unknown emitter game object ID on event. Make sure the game object is registered before using it and do not use it once it was unregistered."), // ErrorCode_UnknownGameObjectEvent
369 AKTEXT("The requested game object for an event was not registered as an emitter. Make sure the game object is registered as an emitter before using it to post an event."), // ErrorCode_GameObjectIsNotEmitterEvent
370 
371 AKTEXT("External source missing from PostEvent call"), // ErrorCode_ExternalSourceNotResolved
372 AKTEXT("Source file is of different format than expected"), //ErrorCode_FileFormatMismatch
373 AKTEXT("Audio command queue is full, blocking caller. Reduce number of calls to sound engine or boost command queue memory."), // ErrorCode_CommandQueueFull
374 AKTEXT("Audio command is too large to fit in the command queue. Break the command in smaller pieces."), //ErrorCode_CommandTooLarge
375 
376 AKTEXT("Failed creating XMA decoder: no more XMA voices available"), // ErrorCode_XMACreateDecoderLimitReached
377 AKTEXT("Failed seeking in XMA source: stream buffer is smaller than XMA block size"), // ErrorCode_XMAStreamBufferTooSmall
378 
379 AKTEXT("Triggered a note-scoped or playing-instance-scoped modulator in a global context (such as a bus or bus effect). Modulator will have global scope."), // ErrorCode_ModulatorScopeError_Inst
380 AKTEXT("Triggered a game-object-scoped modulator in a global context (such as a bus or bus effect). Modulator will have global scope."), // ErrorCode_ModulatorScopeError_Obj
381 
382 AKTEXT("Ignoring seek after end of playlist"), // ErrorCode_SeekAfterEndOfPlaylist
383 
384 AKTEXT("Seek table required to seek in Opus sources. Please update conversion settings."), // ErrorCode_OpusRequireSeekTable,
385 AKTEXT("Opus decoder failure"), // ErrorCode_OpusDecodeError,
386 AKTEXT("Failed creating Opus decoder"), // ErrorCode_OpusCreateDecoderFailed
387 
388 AKTEXT("Source plugin not found in currently loaded banks."), //ErrorCode_SourcePluginNotFound
389 
390 AKTEXT("Number of Resume and/or Play-From-Beginning virtual voices has reached warning limit (see Project Settings > Log tab). There may be some infinite, leaked voices.") , // ErrorCode_VirtualVoiceLimit
391 
392 AKTEXT("AK::SoundEngine::AddOutput()/ReplaceOutput() - Device ShareSet not found in Init bank."), //ErrorCode_AudioDeviceShareSetNotFound
393 
394 AKTEXT("Not enough memory to start sound."), //ErrorCode_NotEnoughMemoryToStart
395 AKTEXT("Error while decoding Opus header."), //ErrorCode_UnkownOpusError
396 
397 AKTEXT("The Output Device specified by AddOutput() or Init() could not be initialized."), //ErrorCode_AudioDeviceInitFailure
398 AKTEXT("ReplaceOutput could not properly remove old output device."), // ErrorCode_AudioDeviceRemoveFailure
399 AKTEXT("Device ID to remove not found as an active device."), // ErrorCode_AudioDeviceNotFound
400 AKTEXT("Device ID not recognized by platform or is disabled."), // ErrorCode_AudioDeviceNotValid
401 AKTEXT("Early reflections are not supported on sounds using 3D Position: Listener with Automation. The assigned early reflections bus will be ignored."), // ErrorCode_SpatialAudio_ListenerAutomationNotSupported
402 AKTEXT("Duplicated media has different length in two separate banks. Stopping sound."), // ErrorCode_MediaDuplicationLength
403 
404 AKTEXT("The hardware-accelerated voice subsystem failed to initialize."), // ErrorCode_HwVoicesSystemInitFailed
405 AKTEXT("Hardware accelerated audio decoding failed."), // ErrorCode_HwVoicesDecodeBatchFailed
406 AKTEXT("Maximum number of hardware-accelerated voices reached. Voice will not play."), // ErrorCode_HwVoiceLimitReached
407 AKTEXT("Failed creating hardware-accelerated voice."), // ErrorCode_HwVoiceInitFailed
408 AKTEXT("The playing sound is assigned the same early reflection bus in the Authoring Tool that has been set via AK::SpatialAudio::SetImageSource. Use a unique bus to avoid image source conflicts."), //ErrorCode_SpatialAudio_ReflectionBusError
409  };
410 
411  static_assert((sizeof(s_aszErrorCodes) / sizeof(s_aszErrorCodes[0])) == AK::Monitor::Num_ErrorCodes, "ARRAYSIZE(AK::Monitor::s_aszErrorCodes) is not matching AK::Monitor::Num_ErrorCodes, make sure they are maintained at the same time.");
412  }
413 
414 }
415 #endif // AK_MONITOR_IMPLEMENT_ERRORCODES
416 
417 #endif // _AKMONITORERROR_H
AK::Monitor::ErrorCode_CannotScheduleMusicSwitch
@ ErrorCode_CannotScheduleMusicSwitch
Definition: AkMonitorError.h:88
AK::Monitor::ErrorCode_FeedbackVoiceStarving
@ ErrorCode_FeedbackVoiceStarving
Definition: AkMonitorError.h:118
AK::Monitor::ErrorCode_OpusCreateDecoderFailed
@ ErrorCode_OpusCreateDecoderFailed
Definition: AkMonitorError.h:155
AK::Monitor::ErrorCode
ErrorCode
ErrorCode.
Definition: AkMonitorError.h:50
AK::Monitor::ErrorCode_FileTooSmall
@ ErrorCode_FileTooSmall
Definition: AkMonitorError.h:77
AK::Monitor::ErrorCode_PluginProcessingFailed
@ ErrorCode_PluginProcessingFailed
Definition: AkMonitorError.h:61
AK::Monitor::Num_ErrorCodes
@ Num_ErrorCodes
Definition: AkMonitorError.h:184
AK::Monitor::LocalOutputFunc
void(* LocalOutputFunc)(ErrorCode in_eErrorCode, const AkOSChar *in_pszError, ErrorLevel in_eErrorLevel, AkPlayingID in_playingID, AkGameObjectID in_gameObjID)
Function prototype of local output function pointer.
Definition: AkMonitorError.h:194
AkTimeMs
AkInt32 AkTimeMs
Time in ms.
Definition: AkTypes.h:61
AK
Audiokinetic namespace.
Definition: AkWwiseSDKVersion.cs:32
AK::Monitor::ErrorCode_TooLongSegmentLookAhead
@ ErrorCode_TooLongSegmentLookAhead
Definition: AkMonitorError.h:87
AK::Monitor::ErrorCode_StreamingSourceStarving
@ ErrorCode_StreamingSourceStarving
Definition: AkMonitorError.h:99
AK::Monitor::ErrorCode_PluginUnsupportedChannelConfiguration
@ ErrorCode_PluginUnsupportedChannelConfiguration
Definition: AkMonitorError.h:58
AK::Monitor::ErrorCode_FileNotFound
@ ErrorCode_FileNotFound
Definition: AkMonitorError.h:52
AK::Monitor::ErrorCode_TooManySimultaneousMusicSegments
@ ErrorCode_TooManySimultaneousMusicSegments
Definition: AkMonitorError.h:89
AK::Monitor::ErrorCode_CannotStartStreamNoMemory
@ ErrorCode_CannotStartStreamNoMemory
Definition: AkMonitorError.h:54
AK::Monitor::ErrorCode_BankLoadFailed
@ ErrorCode_BankLoadFailed
Definition: AkMonitorError.h:120
AK::Monitor::ErrorCode_SpatialAudio_ListenerAutomationNotSupported
@ ErrorCode_SpatialAudio_ListenerAutomationNotSupported
Definition: AkMonitorError.h:171
AK::Monitor::ErrorCode_CannotSeekContinuous
@ ErrorCode_CannotSeekContinuous
Definition: AkMonitorError.h:128
AK::Monitor::ErrorCode_AACDecodeError
@ ErrorCode_AACDecodeError
Definition: AkMonitorError.h:68
AK::Monitor::ErrorCode_ATRAC9LoopSectionTooSmall
@ ErrorCode_ATRAC9LoopSectionTooSmall
Definition: AkMonitorError.h:73
AK::Monitor::ErrorCode_SeekNoMarker
@ ErrorCode_SeekNoMarker
Definition: AkMonitorError.h:127
AK::Monitor::ErrorCode_PluginVersionMismatch
@ ErrorCode_PluginVersionMismatch
Definition: AkMonitorError.h:106
AK::Monitor::ErrorCode_AudioFileHeaderTooLarge
@ ErrorCode_AudioFileHeaderTooLarge
Definition: AkMonitorError.h:76
AK::Monitor::SetLocalOutput
AKSOUNDENGINE_API AKRESULT SetLocalOutput(AkUInt32 in_uErrorLevel=ErrorLevel_All, LocalOutputFunc in_pMonitorFunc=0)
AK::Monitor::ErrorCode_EventIDNotFound
@ ErrorCode_EventIDNotFound
Definition: AkMonitorError.h:108
AK::Monitor::ErrorCode_PluginInitialisationFailed
@ ErrorCode_PluginInitialisationFailed
Definition: AkMonitorError.h:60
AkGameObjectID
AkUInt64 AkGameObjectID
Game object ID.
Definition: AkTypes.h:65
AK::Monitor::ErrorCode_HwVoiceLimitReached
@ ErrorCode_HwVoiceLimitReached
Definition: AkMonitorError.h:176
AK::Monitor::ErrorCode_PlaylistStoppedForEditing
@ ErrorCode_PlaylistStoppedForEditing
Definition: AkMonitorError.h:90
AK::Monitor::ErrorCode_SelectedChildNotAvailable
@ ErrorCode_SelectedChildNotAvailable
Definition: AkMonitorError.h:111
AK::Monitor::ErrorCode_ModulatorScopeError_Inst
@ ErrorCode_ModulatorScopeError_Inst
Definition: AkMonitorError.h:148
AK_EXTERNAPIFUNC
#define AK_EXTERNAPIFUNC(_type, _name)
Definition: AkSoundEngineExport.h:78
AK::Monitor::ErrorCode_TransitionNotAccurateChannel
@ ErrorCode_TransitionNotAccurateChannel
Definition: AkMonitorError.h:79
AKRESULT
AKRESULT
Standard function call result.
Definition: AkTypes.h:122
AK::Monitor::ErrorCode_SeekAfterEof
@ ErrorCode_SeekAfterEof
Definition: AkMonitorError.h:129
AK::Monitor::ErrorCode_IncompatibleIOSettings
@ ErrorCode_IncompatibleIOSettings
Definition: AkMonitorError.h:56
AK::Monitor::ErrorCode_InsufficientSpaceToLoadBank
@ ErrorCode_InsufficientSpaceToLoadBank
Definition: AkMonitorError.h:123
AK::Monitor::ErrorLevel_All
@ ErrorLevel_All
Definition: AkMonitorError.h:46
AK::Monitor::ErrorCode_CannotPlaySource_VirtualOff
@ ErrorCode_CannotPlaySource_VirtualOff
Definition: AkMonitorError.h:94
AK::Monitor::ErrorCode_MediaDuplicationLength
@ ErrorCode_MediaDuplicationLength
Definition: AkMonitorError.h:172
AK::Monitor::ErrorCode_CannotPlaySource_Create
@ ErrorCode_CannotPlaySource_Create
Definition: AkMonitorError.h:93
AK::Monitor::ErrorCode_BankUnloadFailed
@ ErrorCode_BankUnloadFailed
Definition: AkMonitorError.h:121
AkOSChar
char AkOSChar
Generic character string.
Definition: AkTypes.h:101
AK::Monitor::ErrorCode_NothingToPlay
@ ErrorCode_NothingToPlay
Definition: AkMonitorError.h:83
AK::Monitor::ErrorCode_StingerCouldNotBeScheduled
@ ErrorCode_StingerCouldNotBeScheduled
Definition: AkMonitorError.h:86
AK::Monitor::s_aszErrorCodes
const AkOSChar * s_aszErrorCodes[Num_ErrorCodes]
AK::Monitor::ErrorCode_XMAStreamBufferTooSmall
@ ErrorCode_XMAStreamBufferTooSmall
Definition: AkMonitorError.h:146
AK::Monitor::ErrorCode_ModulatorScopeError_Obj
@ ErrorCode_ModulatorScopeError_Obj
Definition: AkMonitorError.h:149
AK::Monitor::ErrorCode_UnknownGameObjectEvent
@ ErrorCode_UnknownGameObjectEvent
Definition: AkMonitorError.h:136
AK::Monitor::ErrorLevel_Message
@ ErrorLevel_Message
Definition: AkMonitorError.h:43
AK::Monitor::ErrorCode_AudioDeviceRemoveFailure
@ ErrorCode_AudioDeviceRemoveFailure
Definition: AkMonitorError.h:167
AK::Monitor::ErrorCode_UnknownEmitter
@ ErrorCode_UnknownEmitter
Definition: AkMonitorError.h:132
AK::Monitor::ErrorCode_AudioDeviceShareSetNotFound
@ ErrorCode_AudioDeviceShareSetNotFound
Definition: AkMonitorError.h:161
AK::Monitor::ErrorCode_GameObjectIsNotEmitterEvent
@ ErrorCode_GameObjectIsNotEmitterEvent
Definition: AkMonitorError.h:137
AK::Monitor::ErrorCode_ExternalSourceNotResolved
@ ErrorCode_ExternalSourceNotResolved
Definition: AkMonitorError.h:139
AK::Monitor::ErrorCode_CannotOpenFile
@ ErrorCode_CannotOpenFile
Definition: AkMonitorError.h:53
AK::Monitor::ErrorCode_TransitionNotAccuratePluginMismatch
@ ErrorCode_TransitionNotAccuratePluginMismatch
Definition: AkMonitorError.h:80
AK::Monitor::ErrorCode_TransitionNotAccurateStarvation
@ ErrorCode_TransitionNotAccurateStarvation
Definition: AkMonitorError.h:82
AK::Monitor::ErrorCode_NoError
@ ErrorCode_NoError
Definition: AkMonitorError.h:51
AkUniqueID
AkUInt32 AkUniqueID
Unique 32-bit ID.
Definition: AkTypes.h:57
AKTEXT
#define AKTEXT(x)
Definition: AkTypes.h:134
AK::Monitor::ErrorCode_xWMACreateDecoderFailed
@ ErrorCode_xWMACreateDecoderFailed
Definition: AkMonitorError.h:70
AK::Monitor::ErrorCode_TransitionNotAccurateRejectedByPlugin
@ ErrorCode_TransitionNotAccurateRejectedByPlugin
Definition: AkMonitorError.h:81
AK::Monitor::ErrorCode_MediaNotLoaded
@ ErrorCode_MediaNotLoaded
Definition: AkMonitorError.h:97
AK::Monitor::ErrorCode_VorbisSeekTableRecommended
@ ErrorCode_VorbisSeekTableRecommended
Definition: AkMonitorError.h:65
AK::Monitor::ErrorCode_UnknownListener
@ ErrorCode_UnknownListener
Definition: AkMonitorError.h:133
AK::Monitor::ErrorCode_CommandQueueFull
@ ErrorCode_CommandQueueFull
Definition: AkMonitorError.h:142
AK::Monitor::ErrorCode_HwVoicesSystemInitFailed
@ ErrorCode_HwVoicesSystemInitFailed
Definition: AkMonitorError.h:174
AK::Monitor::ErrorCode_UnkownOpusError
@ ErrorCode_UnkownOpusError
Definition: AkMonitorError.h:164
AK::Monitor::ErrorCode_XMADecoderSourceStarving
@ ErrorCode_XMADecoderSourceStarving
Definition: AkMonitorError.h:100
AK::Monitor::ErrorCode_NotEnoughMemoryToStart
@ ErrorCode_NotEnoughMemoryToStart
Definition: AkMonitorError.h:163
AK::Monitor::ErrorCode_ErrorWhileLoadingBank
@ ErrorCode_ErrorWhileLoadingBank
Definition: AkMonitorError.h:122
AK::Monitor::GetTimeStamp
AKSOUNDENGINE_API AkTimeMs GetTimeStamp()
AK::Monitor::ErrorCode_AudioDeviceNotFound
@ ErrorCode_AudioDeviceNotFound
Definition: AkMonitorError.h:168
AK::Monitor::ErrorCode_PluginMediaUnavailable
@ ErrorCode_PluginMediaUnavailable
Definition: AkMonitorError.h:59
AK::Monitor::ErrorCode_GameObjectIsNotListener
@ ErrorCode_GameObjectIsNotListener
Definition: AkMonitorError.h:134
AK::Monitor::ErrorCode_OpusDecodeError
@ ErrorCode_OpusDecodeError
Definition: AkMonitorError.h:154
AK::Monitor::ErrorLevel_Error
@ ErrorLevel_Error
Definition: AkMonitorError.h:44
AK::Monitor::ErrorCode_OpusRequireSeekTable
@ ErrorCode_OpusRequireSeekTable
Definition: AkMonitorError.h:153
AK::Monitor::ErrorCode_AudioDeviceNotValid
@ ErrorCode_AudioDeviceNotValid
Definition: AkMonitorError.h:169
AK_CALLBACK
#define AK_CALLBACK(_type, _name)
Definition: AkSoundEngineExport.h:84
AK::Monitor::ErrorCode_SpatialAudio_ReflectionBusError
@ ErrorCode_SpatialAudio_ReflectionBusError
Definition: AkMonitorError.h:179
AK::Monitor::ErrorCode_CannotPlaySource_InconsistentState
@ ErrorCode_CannotPlaySource_InconsistentState
Definition: AkMonitorError.h:96
AK::Monitor::ErrorCode_SelectedNodeNotAvailable
@ ErrorCode_SelectedNodeNotAvailable
Definition: AkMonitorError.h:112
AK_INVALID_UNIQUE_ID
static const AkUniqueID AK_INVALID_UNIQUE_ID
Invalid unique 32-bit ID.
Definition: AkTypes.h:94
AK::Monitor::ErrorCode_SelectedNodeNotAvailablePlay
@ ErrorCode_SelectedNodeNotAvailablePlay
Definition: AkMonitorError.h:116
AK::Monitor::ErrorCode_XMADecodingError
@ ErrorCode_XMADecodingError
Definition: AkMonitorError.h:101
AK::Monitor::ErrorCode_XMACreateDecoderLimitReached
@ ErrorCode_XMACreateDecoderLimitReached
Definition: AkMonitorError.h:145
AK_INVALID_PLAYING_ID
static const AkPlayingID AK_INVALID_PLAYING_ID
Invalid playing ID.
Definition: AkTypes.h:96
AK::Monitor::ErrorCode_GameObjectIsNotEmitter
@ ErrorCode_GameObjectIsNotEmitter
Definition: AkMonitorError.h:135
AK::Monitor::ErrorCode_HwVoiceInitFailed
@ ErrorCode_HwVoiceInitFailed
Definition: AkMonitorError.h:177
AK::Monitor::ErrorCode_IODevice
@ ErrorCode_IODevice
Definition: AkMonitorError.h:55
AK::Monitor::ErrorCode_InvalidGroupID
@ ErrorCode_InvalidGroupID
Definition: AkMonitorError.h:110
AK::Monitor::ErrorCode_InvalidAudioFileHeader
@ ErrorCode_InvalidAudioFileHeader
Definition: AkMonitorError.h:75
AK::Monitor::ErrorCode_CommandTooLarge
@ ErrorCode_CommandTooLarge
Definition: AkMonitorError.h:143
AK::Monitor::ErrorCode_LowerEngineCommandListFull
@ ErrorCode_LowerEngineCommandListFull
Definition: AkMonitorError.h:125
AK::Monitor::ErrorCode_CannotPlaySource_TimeSkip
@ ErrorCode_CannotPlaySource_TimeSkip
Definition: AkMonitorError.h:95
AK::Monitor::ErrorCode_SelectedMediaNotAvailable
@ ErrorCode_SelectedMediaNotAvailable
Definition: AkMonitorError.h:113
AK_INVALID_GAME_OBJECT
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
Definition: AkTypes.h:93
AK::Monitor::ErrorCode_VirtualVoiceLimit
@ ErrorCode_VirtualVoiceLimit
Definition: AkMonitorError.h:159
AK::Monitor::ErrorCode_PluginExecutionInvalid
@ ErrorCode_PluginExecutionInvalid
Definition: AkMonitorError.h:62
AK::Monitor::ErrorCode_AudioDeviceInitFailure
@ ErrorCode_AudioDeviceInitFailure
Definition: AkMonitorError.h:166
AK::Monitor::ErrorCode_InvalidXMAData
@ ErrorCode_InvalidXMAData
Definition: AkMonitorError.h:102
AK::Monitor::ErrorCode_CodecNotRegistered
@ ErrorCode_CodecNotRegistered
Definition: AkMonitorError.h:105
AK::Monitor::ErrorCode_UnknownGameObject
@ ErrorCode_UnknownGameObject
Definition: AkMonitorError.h:131
AK::Monitor::ErrorCode_HwVoicesDecodeBatchFailed
@ ErrorCode_HwVoicesDecodeBatchFailed
Definition: AkMonitorError.h:175
AK::Monitor::ErrorCode_SourcePluginNotFound
@ ErrorCode_SourcePluginNotFound
Definition: AkMonitorError.h:157
AK::Monitor::PostCode
AKSOUNDENGINE_API AKRESULT PostCode(ErrorCode in_eError, ErrorLevel in_eErrorLevel, AkPlayingID in_playingID=AK_INVALID_PLAYING_ID, AkGameObjectID in_gameObjID=AK_INVALID_GAME_OBJECT, AkUniqueID in_audioNodeID=AK_INVALID_UNIQUE_ID, bool in_bIsBus=false)
AK::Monitor::ErrorCode_VoiceStarving
@ ErrorCode_VoiceStarving
Definition: AkMonitorError.h:98
AK::Monitor::ErrorCode_MusicClipsRescheduledAfterTrackEdit
@ ErrorCode_MusicClipsRescheduledAfterTrackEdit
Definition: AkMonitorError.h:91
AK::Monitor::ErrorCode_ATRAC9DecodeFailed
@ ErrorCode_ATRAC9DecodeFailed
Definition: AkMonitorError.h:72
AK::Monitor::ErrorCode_VorbisDecodeError
@ ErrorCode_VorbisDecodeError
Definition: AkMonitorError.h:67
AkUInt32
uint32_t AkUInt32
Unsigned 32-bit integer.
Definition: AkTypes.h:85
AK::Monitor::ErrorLevel
ErrorLevel
ErrorLevel.
Definition: AkMonitorError.h:42
AK::Monitor::ErrorCode_NoValidSwitch
@ ErrorCode_NoValidSwitch
Definition: AkMonitorError.h:114
AkPlayingID
AkUInt32 AkPlayingID
Playing ID.
Definition: AkTypes.h:60
AK::Monitor::ErrorCode_FileFormatMismatch
@ ErrorCode_FileFormatMismatch
Definition: AkMonitorError.h:140
AK::Monitor::ErrorCode_PlayFailed
@ ErrorCode_PlayFailed
Definition: AkMonitorError.h:84
AK::Monitor::ErrorCode_PluginNotRegistered
@ ErrorCode_PluginNotRegistered
Definition: AkMonitorError.h:104
AK::Monitor::ErrorCode_PluginAllocationFailed
@ ErrorCode_PluginAllocationFailed
Definition: AkMonitorError.h:63
AK::Monitor::ErrorCode_SeekAfterEndOfPlaylist
@ ErrorCode_SeekAfterEndOfPlaylist
Definition: AkMonitorError.h:151
AK::Monitor::PostString
AKSOUNDENGINE_API AKRESULT PostString(const char *in_pszError, ErrorLevel in_eErrorLevel, AkPlayingID in_playingID=AK_INVALID_PLAYING_ID, AkGameObjectID in_gameObjID=AK_INVALID_GAME_OBJECT, AkUniqueID in_audioNodeID=AK_INVALID_UNIQUE_ID, bool in_bIsBus=false)

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise