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