Version
menu_open
link
Wwise SDK 2021.1.14
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: v2021.1.14 Build: 6590
25  Copyright (c) 2006-2023 Audiokinetic Inc.
26 *******************************************************************************/
27 
28 #ifndef _AKMONITORERROR_H
29 #define _AKMONITORERROR_H
30 
33 
34 struct AkStreamMgrSettings;
35 struct AkDeviceSettings;
36 
37 namespace AK
38 {
39  // Error monitoring.
40 
41  namespace Monitor
42  {
43  /// ErrorLevel
44  enum ErrorLevel
45  {
46  ErrorLevel_Message = (1<<0), // used as bitfield
47  ErrorLevel_Error = (1<<1),
48 
50  };
51  /// ErrorCode
52  enum ErrorCode
53  {
54  ErrorCode_NoError = 0, // 0-based index into AK::Monitor::s_aszErrorCodes table
60 
67 
69 
72 
73  ErrorCode_xWMACreateDecoderFailed,//Deprecated, keep in place for legacy maintenance.
74 
77 
81 
89 
96 
107 
111 
113 
119 
121 
123 
128 
130 
134 
142 
145 
148 
151 
154 
156 
160 
162 
164 
166 
169 
174 
177 
178  ErrorCode_HwVoicesSystemInitFailed, // When the hardware-accelerated subsystem fails to initialize
179  ErrorCode_HwVoicesDecodeBatchFailed, // When a grouping of hardware-accelerated voices fail to decode collectively
180  ErrorCode_HwVoiceLimitReached, // Cannot create any more hardware-accelerated voices
181  ErrorCode_HwVoiceInitFailed, // A hardware-accelerated voice fails to be created, but not because the max number of voices was reached
182 
184 
186 
188 
192 
194 
196 
199 
201 
202  // ALWAYS ADD NEW CODES AT THE END !!!!!!!
203  // Otherwise it may break comm compatibility in a patch
204 
205  Num_ErrorCodes // THIS STAYS AT END OF ENUM
206  };
207 
208  static_assert(Num_ErrorCodes == 108,
209  "Please document your new ErrorCode "
210  "in 'Documentation/Help/source_en/reference/common_errors_capture_log.xml', "
211  "then you can increment this value."
212  );
213 
214  /// Function prototype of local output function pointer.
216  ErrorCode in_eErrorCode, ///< Error code number value
217  const AkOSChar* in_pszError, ///< Message or error string to be displayed
218  ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
219  AkPlayingID in_playingID, ///< Related Playing ID if applicable, AK_INVALID_PLAYING_ID otherwise
220  AkGameObjectID in_gameObjID ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
221  );
222 
223  extern const AkOSChar* s_aszErrorCodes[ Num_ErrorCodes ];
224 
225  /// Post a monitoring message or error code. This will be displayed in the Wwise capture
226  /// log.
227  /// \return AK_Success if successful, AK_Fail if there was a problem posting the message.
228  /// In optimized mode, this function returns AK_NotCompatible.
229  /// \remark This function is provided as a tracking tool only. It does nothing if it is
230  /// called in the optimized/release configuration and return AK_NotCompatible.
232  ErrorCode in_eError, ///< Message or error code to be displayed
233  ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
234  AkPlayingID in_playingID = AK_INVALID_PLAYING_ID, ///< Related Playing ID if applicable
235  AkGameObjectID in_gameObjID = AK_INVALID_GAME_OBJECT, ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
236  AkUniqueID in_audioNodeID = AK_INVALID_UNIQUE_ID, ///< Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise
237  bool in_bIsBus = false ///< true if in_audioNodeID is a bus
238  );
239 #ifdef AK_SUPPORT_WCHAR
240  /// Post a unicode monitoring message or error string. This will be displayed in the Wwise capture
241  /// log.
242  /// \return AK_Success if successful, AK_Fail if there was a problem posting the message.
243  /// In optimized mode, this function returns AK_NotCompatible.
244  /// \remark This function is provided as a tracking tool only. It does nothing if it is
245  /// called in the optimized/release configuration and return AK_NotCompatible.
247  const wchar_t* in_pszError, ///< Message or error string to be displayed
248  ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
249  AkPlayingID in_playingID = AK_INVALID_PLAYING_ID, ///< Related Playing ID if applicable
250  AkGameObjectID in_gameObjID = AK_INVALID_GAME_OBJECT, ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
251  AkUniqueID in_audioNodeID = AK_INVALID_UNIQUE_ID, ///< Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise
252  bool in_bIsBus = false ///< true if in_audioNodeID is a bus
253  );
254 #endif // #ifdef AK_SUPPORT_WCHAR
255  /// Post a monitoring message or error string. This will be displayed in the Wwise capture
256  /// log.
257  /// \return AK_Success if successful, AK_Fail if there was a problem posting the message.
258  /// In optimized mode, this function returns AK_NotCompatible.
259  /// \remark This function is provided as a tracking tool only. It does nothing if it is
260  /// called in the optimized/release configuration and return AK_NotCompatible.
262  const char* in_pszError, ///< Message or error string to be displayed
263  ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
264  AkPlayingID in_playingID = AK_INVALID_PLAYING_ID, ///< Related Playing ID if applicable
265  AkGameObjectID in_gameObjID = AK_INVALID_GAME_OBJECT, ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
266  AkUniqueID in_audioNodeID = AK_INVALID_UNIQUE_ID, ///< Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise
267  bool in_bIsBus = false ///< true if in_audioNodeID is a bus
268  );
269 
270  /// Enable/Disable local output of monitoring messages or errors. Pass 0 to disable,
271  /// or any combination of ErrorLevel_Message and ErrorLevel_Error to enable.
272  /// \return AK_Success.
273  /// In optimized/release configuration, this function returns AK_NotCompatible.
275  AkUInt32 in_uErrorLevel = ErrorLevel_All, ///< ErrorLevel(s) to enable in output. Default parameters enable all.
276  LocalOutputFunc in_pMonitorFunc = 0 ///< Handler for local output. If NULL, the standard platform debug output method is used.
277  );
278 
279  /// Get the time stamp shown in the capture log along with monitoring messages.
280  /// \return Time stamp in milliseconds.
281  /// In optimized/release configuration, this function returns 0.
283 
284  /// Add the streaming manager settings to the profiler capture.
286  const AkStreamMgrSettings& in_streamMgrSettings
287  );
288 
289  /// Add device settings to the list of active streaming devices.
290  /// The list of streaming devices and their settings will be
291  /// sent to the profiler capture when remote connecting from Wwise.
292  ///
293  /// \remark \c AK::Monitor::MonitorStreamMgrTerm must be called to
294  /// clean-up memory used to keep track of active streaming devices.
296  AkDeviceID in_deviceID,
297  const AkDeviceSettings& in_deviceSettings
298  );
299 
300  /// Remove streaming device entry from the list of devices
301  /// to send when remote connecting from Wwise.
303  AkDeviceID in_deviceID
304  );
305 
306  /// Monitor streaming manager destruction as part of the
307  /// profiler capture.
308  ///
309  /// \remark This function must be called to clean-up memory used by
310  /// \c AK::Monitor::MonitorStreamingDeviceInit and \c AK::Monitor::MonitorStreamingDeviceTerm
311  /// to keep track of active streaming devices.
313  }
314 }
315 
316 // Macros.
317 #ifndef AK_OPTIMIZED
318  #define AK_MONITOR_ERROR( in_eErrorCode ) \
319  AK::Monitor::PostCode( in_eErrorCode, AK::Monitor::ErrorLevel_Error )
320 
321  #define AK_MONITOR_STREAM_MGR_INIT( in_streamMgrSettings ) \
322  AK::Monitor::MonitorStreamMgrInit( in_streamMgrSettings )
323 
324  #define AK_MONITOR_STREAMING_DEVICE_INIT( in_deviceID, in_deviceSettings ) \
325  AK::Monitor::MonitorStreamingDeviceInit( in_deviceID, in_deviceSettings )
326 
327  #define AK_MONITOR_STREAMING_DEVICE_DESTROYED( in_deviceID ) \
328  AK::Monitor::MonitorStreamingDeviceDestroyed( in_deviceID )
329 
330  #define AK_MONITOR_STREAM_MGR_TERM( ) \
331  AK::Monitor::MonitorStreamMgrTerm()
332 #else
333  #define AK_MONITOR_ERROR( in_eErrorCode )
334  #define AK_MONITOR_STREAM_MGR_INIT( in_streamMgrSettings )
335  #define AK_MONITOR_STREAMING_DEVICE_INIT( in_deviceID, in_deviceSettings )
336  #define AK_MONITOR_STREAMING_DEVICE_DESTROYED( in_deviceID )
337  #define AK_MONITOR_STREAM_MGR_TERM( )
338 #endif
339 
340 #ifdef AK_MONITOR_IMPLEMENT_ERRORCODES
341 namespace AK
342 {
343  namespace Monitor
344  {
346  {
347  AKTEXT("No error"), // ErrorCode_NoError
348  AKTEXT("File not found"), // ErrorCode_FileNotFound,
349  AKTEXT("Cannot open file"), // ErrorCode_CannotOpenFile,
350  AKTEXT("Not enough memory in I/O pool to start stream"), // ErrorCode_CannotStartStreamNoMemory,
351  AKTEXT("Unknown I/O device error"), // ErrorCode_IODevice,
352  AKTEXT("I/O settings incompatible."), // ErrorCode_IncompatibleIOSettings
353 
354  AKTEXT("Plug-in unsupported channel configuration"), // ErrorCode_PluginUnsupportedChannelConfiguration,
355  AKTEXT("Plug-in media unavailable"), // ErrorCode_PluginMediaUnavailable,
356  AKTEXT("Plug-in initialization failure"), // ErrorCode_PluginInitialisationFailed,
357  AKTEXT("Plug-in execution failure"), // ErrorCode_PluginProcessingFailed,
358  AKTEXT("Invalid plug-in execution mode"), // ErrorCode_PluginExecutionInvalid
359  AKTEXT("Could not allocate effect"), // ErrorCode_PluginAllocationFailed
360 
361 AKTEXT("Seek table is not present, or seek table granularity is larger than the maximum decode buffer size. Conversion settings may need to be updated."), // ErrorCode_VorbisSeekTableRecommended,
362 
363 AKTEXT("Vorbis decoder failure"), // ErrorCode_VorbisDecodeError,
364 AKTEXT("AAC decoder failure"), // ErrorCode_AACDecodeError
365 
366 AKTEXT("Failed creating xWMA decoder"), // ErrorCode_xWMACreateDecoderFailed,
367 
368 AKTEXT("ATRAC9 decoding failed"), // ErrorCode_ATRAC9DecodeFailed
369 AKTEXT("ATRAC9 loop section is too small"), // ErrorCode_ATRAC9LoopSectionTooSmall
370 
371 AKTEXT("Invalid file header"), // ErrorCode_InvalidAudioFileHeader,
372 AKTEXT("File header too large (due to markers or envelope)"), // ErrorCode_AudioFileHeaderTooLarge,
373 AKTEXT("File or loop region is too small to be played properly"), // ErrorCode_FileTooSmall,
374 
375 AKTEXT("Transition not sample-accurate due to mixed channel configurations"), // ErrorCode_TransitionNotAccurateChannel,
376 AKTEXT("Transition not sample-accurate due to incompatible audio formats"), // ErrorCode_TransitionNotAccuratePluginMismatch,
377 AKTEXT("Transition not sample-accurate due to incompatible encoding parameters"), // ErrorCode_TransitionNotAccurateRejectedByPlugin
378 AKTEXT("Transition not sample-accurate due to source starvation"), // ErrorCode_TransitionNotAccurateStarvation,
379 AKTEXT("Transition not sample-accurate due to codec internal error"), // ErrorCode_TransitionNotAccurateCodecError,
380 AKTEXT("Nothing to play in Dynamic Sequence"), // ErrorCode_NothingToPlay,
381 AKTEXT("Play Failed"), // ErrorCode_PlayFailed, // Notification meaning the play asked was not done for an out of control reason
382 // For example, if The Element has a missing source file.
383 
384 AKTEXT("Stinger could not be scheduled in this segment or was dropped"), // ErrorCode_StingerCouldNotBeScheduled,
385 AKTEXT("Segment look-ahead plus pre-entry duration is longer than previous segment in sequence"), // ErrorCode_TooLongSegmentLookAhead,
386 AKTEXT("Cannot schedule music switch transition in upcoming segments: using Exit Cue"), // ErrorCode_CannotScheduleMusicSwitch,
387 AKTEXT("Cannot schedule music segments: Stopping music"), // ErrorCode_TooManySimultaneousMusicSegments,
388 AKTEXT("Music system is stopped because a music playlist is modified"), // ErrorCode_PlaylistStoppedForEditing
389 AKTEXT("Rescheduling music clips because a track was modified"), // ErrorCode_MusicClipsRescheduledAfterTrackEdit
390 
391 AKTEXT("Failed creating source"), // ErrorCode_CannotPlaySource_Create,
392 AKTEXT("Virtual source failed becoming physical"), // ErrorCode_CannotPlaySource_VirtualOff,
393 AKTEXT("Error while computing virtual source elapsed time"), // ErrorCode_CannotPlaySource_TimeSkip,
394 AKTEXT("Inconsistent source status"), // ErrorCode_CannotPlaySource_InconsistentState,
395 AKTEXT("Media was not loaded for this source"),// ErrorCode_MediaNotLoaded,
396 AKTEXT("Voice Starvation"), // ErrorCode_VoiceStarving,
397 AKTEXT("Source starvation"), // ErrorCode_StreamingSourceStarving,
398 AKTEXT("XMA decoder starvation"), // ErrorCode_XMADecoderSourceStarving,
399 AKTEXT("XMA decoding error"), // ErrorCode_XMADecodingError
400 AKTEXT("Invalid XMA data - Make sure data is allocated from APU memory and is aligned to 2K."), // ErrorCode_InvalidXMAData
401 
402 AKTEXT("Plug-in not found"), // ErrorCode_PluginNotRegistered,
403 AKTEXT("Codec plug-in not registered"), // ErrorCode_CodecNotRegistered,
404 AKTEXT("Plug-in version doesn't match sound engine version. Please ensure the plug-in is compatible with this version of Wwise"), //ErrorCode_PluginVersionMismatch
405 
406 AKTEXT("Event ID not found"), // ErrorCode_EventIDNotFound,
407 
408 AKTEXT("Invalid State Group ID"), // ErrorCode_InvalidGroupID,
409 AKTEXT("Selected Child Not Available"), // ErrorCode_SelectedChildNotAvailable,
410 AKTEXT("Selected Node Not Available"), // ErrorCode_SelectedNodeNotAvailable,
411 AKTEXT("Selected Media Not Available"),// ErrorCode_SelectedMediaNotAvailable,
412 AKTEXT("No Valid Switch"), // ErrorCode_NoValidSwitch,
413 
414 AKTEXT("Selected node not available. Make sure the structure associated to the event is loaded or that the event has been prepared"), // ErrorCode_SelectedNodeNotAvailablePlay,
415 
416 AKTEXT("Motion voice starvation"), // ErrorCode_FeedbackVoiceStarving,
417 
418 AKTEXT("Bank Load Failed"), // ErrorCode_BankLoadFailed,
419 AKTEXT("Bank Unload Failed"), // ErrorCode_BankUnloadFailed,
420 AKTEXT("Error while loading bank"), // ErrorCode_ErrorWhileLoadingBank,
421 AKTEXT("Insufficient Space to Load Bank"), // ErrorCode_InsufficientSpaceToLoadBank,
422 
423 AKTEXT("Lower engine command list is full"), // ErrorCode_LowerEngineCommandListFull,
424 
425 AKTEXT("No marker in file; seeking to specified location"), // ErrorCode_SeekNoMarker
426 AKTEXT("Cannot seek in sound that is within a continuous container with special transitions"), // ErrorCode_CannotSeekContinuous
427 AKTEXT("Seeking after end of file. Playback will stop"), // ErrorCode_SeekAfterEof
428 
429 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,
430 
431 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,
432 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,
433 AKTEXT("The requested game object is not a listener."), // ErrorCode_GameObjectIsNotListener,
434 AKTEXT("The requested game object is not an emitter."), // ErrorCode_GameObjectIsNotEmitter,
435 
436 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
437 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
438 
439 AKTEXT("External source missing from PostEvent call"), // ErrorCode_ExternalSourceNotResolved
440 AKTEXT("Source file is of different format than expected"), //ErrorCode_FileFormatMismatch
441 AKTEXT("Audio command queue is full, blocking caller. Reduce number of calls to sound engine or boost command queue memory."), // ErrorCode_CommandQueueFull
442 AKTEXT("Audio command is too large to fit in the command queue. Break the command in smaller pieces."), //ErrorCode_CommandTooLarge
443 
444 AKTEXT("Failed creating XMA decoder: no more XMA voices available"), // ErrorCode_XMACreateDecoderLimitReached
445 AKTEXT("Failed seeking in XMA source: stream buffer is smaller than XMA block size"), // ErrorCode_XMAStreamBufferTooSmall
446 
447 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
448 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
449 
450 AKTEXT("Ignoring seek after end of playlist"), // ErrorCode_SeekAfterEndOfPlaylist
451 
452 AKTEXT("Seek table required to seek in Opus sources. Please update conversion settings."), // ErrorCode_OpusRequireSeekTable,
453 AKTEXT("Opus decoder failure"), // ErrorCode_OpusDecodeError,
454 AKTEXT("Failed creating Opus decoder"), // ErrorCode_OpusCreateDecoderFailed
455 
456 AKTEXT("Source plugin not found in currently loaded banks."), //ErrorCode_SourcePluginNotFound
457 
458 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
459 
460 AKTEXT("AK::SoundEngine::AddOutput()/ReplaceOutput() - Device ShareSet not found in Init bank."), //ErrorCode_AudioDeviceShareSetNotFound
461 
462 AKTEXT("Not enough memory to start sound."), //ErrorCode_NotEnoughMemoryToStart
463 AKTEXT("Error while decoding Opus header."), //ErrorCode_UnkownOpusError
464 
465 AKTEXT("The Output Device specified by AddOutput() or Init() could not be initialized."), //ErrorCode_AudioDeviceInitFailure
466 AKTEXT("ReplaceOutput could not properly remove old output device."), // ErrorCode_AudioDeviceRemoveFailure
467 AKTEXT("Device ID to remove not found as an active device."), // ErrorCode_AudioDeviceNotFound
468 AKTEXT("Device ID not recognized by platform or is disabled."), // ErrorCode_AudioDeviceNotValid
469 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
470 AKTEXT("Duplicated media has different length in two separate banks. Stopping sound."), // ErrorCode_MediaDuplicationLength
471 
472 AKTEXT("The hardware-accelerated voice subsystem failed to initialize."), // ErrorCode_HwVoicesSystemInitFailed
473 AKTEXT("Hardware accelerated audio decoding failed."), // ErrorCode_HwVoicesDecodeBatchFailed
474 AKTEXT("Maximum number of hardware-accelerated voices reached. Voice will not play."), // ErrorCode_HwVoiceLimitReached
475 AKTEXT("Failed creating hardware-accelerated voice."), // ErrorCode_HwVoiceInitFailed
476 AKTEXT("Opus HW command failure. Sound will glitch."), // ErrorCode_OpusHWCommandFailed
477 
478 AKTEXT("Non-empty array of listeners specified for AddOutput() but uNumListeners is set to zero."), // ErrorCode_AddOutputListenerIdWithZeroListeners
479 
480 AKTEXT("3D audio object limit exceeded; object will be mixed."), // ErrorCode_3DObjectLimitExceeded
481 
482 AKTEXT("AkInitSettings::uNumSamplesPerFrame value unsupported by XAPU, hardware decoding not available. Supported size: 256, 512 and 1024."), //ErrorCode_OpusHWUnavailable
483 AKTEXT("Fatal XAPU failure, Opus sounds will glitch while it is being reset."), //ErrorCode_OpusFatalError
484 AKTEXT("Opus hardware stopped responding "), //ErrorCode_OpusHWTimeout
485 
486 AKTEXT("Another process is using Microsoft Spatial Sound objects. Some audio objects may be mixed."), //ErrorCode_SystemAudioObjectsUnavailable
487 
488 AKTEXT("AddOutput() needs unique Listeners for multi-instance outputs using the same shareset."), //ErrorCode_AddOutputNoDistinctListener
489 
490 AKTEXT("Plug-in does not support Audio Objects bus configuration."), //ErrorCode_PluginCannotRunOnObjectConfig
491 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
492 AKTEXT("Vorbis Hardware Acceleration library not found. Source will be decoded in software."), // ErrorCode_VorbisHWDecodeUnavailable
493  };
494 
495  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.");
496  }
497 
498 }
499 #endif // AK_MONITOR_IMPLEMENT_ERRORCODES
500 
501 #endif // _AKMONITORERROR_H
@ ErrorCode_CannotScheduleMusicSwitch
Definition: AkMonitorError.h:92
@ ErrorCode_FeedbackVoiceStarving
Definition: AkMonitorError.h:122
@ ErrorCode_OpusCreateDecoderFailed
Definition: AkMonitorError.h:159
ErrorCode
ErrorCode.
Definition: AkMonitorError.h:53
@ ErrorCode_3DObjectLimitExceeded
Definition: AkMonitorError.h:187
@ ErrorCode_FileTooSmall
Definition: AkMonitorError.h:80
@ ErrorCode_PluginProcessingFailed
Definition: AkMonitorError.h:64
@ Num_ErrorCodes
Definition: AkMonitorError.h:205
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:215
AkInt32 AkTimeMs
Time in ms.
Definition: AkTypes.h:66
Audiokinetic namespace.
@ ErrorCode_TooLongSegmentLookAhead
Definition: AkMonitorError.h:91
@ ErrorCode_StreamingSourceStarving
Definition: AkMonitorError.h:103
@ ErrorCode_PluginUnsupportedChannelConfiguration
Definition: AkMonitorError.h:61
@ ErrorCode_FileNotFound
Definition: AkMonitorError.h:55
V1::Notifications::Monitor Monitor
Latest version of the C++ Monitor notification interface.
Definition: Notifications.h:204
@ ErrorCode_TooManySimultaneousMusicSegments
Definition: AkMonitorError.h:93
@ ErrorCode_CannotStartStreamNoMemory
Definition: AkMonitorError.h:57
@ ErrorCode_BankLoadFailed
Definition: AkMonitorError.h:124
@ ErrorCode_SpatialAudio_ListenerAutomationNotSupported
Definition: AkMonitorError.h:175
@ ErrorCode_CannotSeekContinuous
Definition: AkMonitorError.h:132
@ ErrorCode_AACDecodeError
Definition: AkMonitorError.h:71
@ ErrorCode_ATRAC9LoopSectionTooSmall
Definition: AkMonitorError.h:76
@ ErrorCode_SeekNoMarker
Definition: AkMonitorError.h:131
@ ErrorCode_PluginVersionMismatch
Definition: AkMonitorError.h:110
@ ErrorCode_AudioFileHeaderTooLarge
Definition: AkMonitorError.h:79
AKSOUNDENGINE_API AKRESULT SetLocalOutput(AkUInt32 in_uErrorLevel=ErrorLevel_All, LocalOutputFunc in_pMonitorFunc=0)
@ ErrorCode_EventIDNotFound
Definition: AkMonitorError.h:112
@ ErrorCode_PluginInitialisationFailed
Definition: AkMonitorError.h:63
AkUInt64 AkGameObjectID
Game object ID.
Definition: AkTypes.h:70
@ ErrorCode_HwVoiceLimitReached
Definition: AkMonitorError.h:180
@ ErrorCode_PlaylistStoppedForEditing
Definition: AkMonitorError.h:94
@ ErrorCode_SelectedChildNotAvailable
Definition: AkMonitorError.h:115
@ ErrorCode_ModulatorScopeError_Inst
Definition: AkMonitorError.h:152
#define AK_EXTERNAPIFUNC(_type, _name)
@ ErrorCode_TransitionNotAccurateChannel
Definition: AkMonitorError.h:82
AKRESULT
Standard function call result.
Definition: AkTypes.h:132
@ ErrorCode_SeekAfterEof
Definition: AkMonitorError.h:133
AkUInt32 AkDeviceID
I/O device ID.
Definition: AkTypes.h:87
@ ErrorCode_IncompatibleIOSettings
Definition: AkMonitorError.h:59
@ ErrorCode_InsufficientSpaceToLoadBank
Definition: AkMonitorError.h:127
@ ErrorLevel_All
Definition: AkMonitorError.h:49
@ ErrorCode_CannotPlaySource_VirtualOff
Definition: AkMonitorError.h:98
@ ErrorCode_MediaDuplicationLength
Definition: AkMonitorError.h:176
@ ErrorCode_CannotPlaySource_Create
Definition: AkMonitorError.h:97
char AkOSChar
Generic character string.
Definition: AkTypes.h:68
@ ErrorCode_BankUnloadFailed
Definition: AkMonitorError.h:125
AKSOUNDENGINE_API void MonitorStreamingDeviceInit(AkDeviceID in_deviceID, const AkDeviceSettings &in_deviceSettings)
@ ErrorCode_NothingToPlay
Definition: AkMonitorError.h:87
@ ErrorCode_StingerCouldNotBeScheduled
Definition: AkMonitorError.h:90
const AkOSChar * s_aszErrorCodes[Num_ErrorCodes]
@ ErrorCode_XMAStreamBufferTooSmall
Definition: AkMonitorError.h:150
@ ErrorCode_ModulatorScopeError_Obj
Definition: AkMonitorError.h:153
@ ErrorCode_UnknownGameObjectEvent
Definition: AkMonitorError.h:140
@ ErrorLevel_Message
Definition: AkMonitorError.h:46
@ ErrorCode_AudioDeviceRemoveFailure
Definition: AkMonitorError.h:171
@ ErrorCode_UnknownEmitter
Definition: AkMonitorError.h:136
AKSOUNDENGINE_API void MonitorStreamMgrTerm()
@ ErrorCode_AudioDeviceShareSetNotFound
Definition: AkMonitorError.h:165
@ ErrorCode_GameObjectIsNotEmitterEvent
Definition: AkMonitorError.h:141
@ ErrorCode_ExternalSourceNotResolved
Definition: AkMonitorError.h:143
@ ErrorCode_CannotOpenFile
Definition: AkMonitorError.h:56
@ ErrorCode_TransitionNotAccuratePluginMismatch
Definition: AkMonitorError.h:83
@ ErrorCode_TransitionNotAccurateStarvation
Definition: AkMonitorError.h:85
@ ErrorCode_NoError
Definition: AkMonitorError.h:54
AkUInt32 AkUniqueID
Unique 32-bit ID.
Definition: AkTypes.h:62
@ ErrorCode_xWMACreateDecoderFailed
Definition: AkMonitorError.h:73
@ ErrorCode_TransitionNotAccurateRejectedByPlugin
Definition: AkMonitorError.h:84
@ ErrorCode_MediaNotLoaded
Definition: AkMonitorError.h:101
@ ErrorCode_VorbisSeekTableRecommended
Definition: AkMonitorError.h:68
@ ErrorCode_UnknownListener
Definition: AkMonitorError.h:137
#define AKTEXT(x)
Definition: AkTypes.h:104
@ ErrorCode_CommandQueueFull
Definition: AkMonitorError.h:146
@ ErrorCode_HwVoicesSystemInitFailed
Definition: AkMonitorError.h:178
@ ErrorCode_UnkownOpusError
Definition: AkMonitorError.h:168
@ ErrorCode_VorbisHWDecodeUnavailable
Definition: AkMonitorError.h:200
@ ErrorCode_XMADecoderSourceStarving
Definition: AkMonitorError.h:104
@ ErrorCode_NotEnoughMemoryToStart
Definition: AkMonitorError.h:167
@ ErrorCode_ErrorWhileLoadingBank
Definition: AkMonitorError.h:126
AKSOUNDENGINE_API AkTimeMs GetTimeStamp()
@ ErrorCode_AudioDeviceNotFound
Definition: AkMonitorError.h:172
@ ErrorCode_PluginMediaUnavailable
Definition: AkMonitorError.h:62
@ ErrorCode_GameObjectIsNotListener
Definition: AkMonitorError.h:138
@ ErrorCode_OpusDecodeError
Definition: AkMonitorError.h:158
@ ErrorLevel_Error
Definition: AkMonitorError.h:47
@ ErrorCode_OpusRequireSeekTable
Definition: AkMonitorError.h:157
@ ErrorCode_AudioDeviceNotValid
Definition: AkMonitorError.h:173
#define AK_CALLBACK(_type, _name)
@ ErrorCode_SpatialAudio_ReflectionBusError
Definition: AkMonitorError.h:198
@ ErrorCode_CannotPlaySource_InconsistentState
Definition: AkMonitorError.h:100
@ ErrorCode_SelectedNodeNotAvailable
Definition: AkMonitorError.h:116
static const AkUniqueID AK_INVALID_UNIQUE_ID
Invalid unique 32-bit ID.
Definition: AkTypes.h:102
@ ErrorCode_SelectedNodeNotAvailablePlay
Definition: AkMonitorError.h:120
@ ErrorCode_XMADecodingError
Definition: AkMonitorError.h:105
@ ErrorCode_OpusHWFatalError
Definition: AkMonitorError.h:190
@ ErrorCode_PluginCannotRunOnObjectConfig
Definition: AkMonitorError.h:197
@ ErrorCode_XMACreateDecoderLimitReached
Definition: AkMonitorError.h:149
static const AkPlayingID AK_INVALID_PLAYING_ID
Invalid playing ID.
Definition: AkTypes.h:104
AKSOUNDENGINE_API void MonitorStreamMgrInit(const AkStreamMgrSettings &in_streamMgrSettings)
Add the streaming manager settings to the profiler capture.
@ ErrorCode_GameObjectIsNotEmitter
Definition: AkMonitorError.h:139
@ ErrorCode_HwVoiceInitFailed
Definition: AkMonitorError.h:181
@ ErrorCode_IODevice
Definition: AkMonitorError.h:58
@ ErrorCode_InvalidGroupID
Definition: AkMonitorError.h:114
@ ErrorCode_OpusHWDecodeUnavailable
Definition: AkMonitorError.h:189
@ ErrorCode_InvalidAudioFileHeader
Definition: AkMonitorError.h:78
@ ErrorCode_CommandTooLarge
Definition: AkMonitorError.h:147
@ ErrorCode_LowerEngineCommandListFull
Definition: AkMonitorError.h:129
@ ErrorCode_CannotPlaySource_TimeSkip
Definition: AkMonitorError.h:99
@ ErrorCode_SelectedMediaNotAvailable
Definition: AkMonitorError.h:117
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
Definition: AkTypes.h:101
@ ErrorCode_VirtualVoiceLimit
Definition: AkMonitorError.h:163
@ ErrorCode_PluginExecutionInvalid
Definition: AkMonitorError.h:65
@ ErrorCode_TransitionNotAccurateCodecError
Definition: AkMonitorError.h:86
@ ErrorCode_AudioDeviceInitFailure
Definition: AkMonitorError.h:170
uint32_t AkUInt32
Unsigned 32-bit integer.
Definition: AkTypes.h:59
AKSOUNDENGINE_API void MonitorStreamingDeviceDestroyed(AkDeviceID in_deviceID)
@ ErrorCode_InvalidXMAData
Definition: AkMonitorError.h:106
@ ErrorCode_SystemAudioObjectsUnavailable
Definition: AkMonitorError.h:193
@ ErrorCode_AddOutputListenerIdWithZeroListeners
Definition: AkMonitorError.h:185
@ ErrorCode_CodecNotRegistered
Definition: AkMonitorError.h:109
@ ErrorCode_UnknownGameObject
Definition: AkMonitorError.h:135
@ ErrorCode_HwVoicesDecodeBatchFailed
Definition: AkMonitorError.h:179
@ ErrorCode_SourcePluginNotFound
Definition: AkMonitorError.h:161
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)
@ ErrorCode_VoiceStarving
Definition: AkMonitorError.h:102
@ ErrorCode_MusicClipsRescheduledAfterTrackEdit
Definition: AkMonitorError.h:95
@ ErrorCode_AddOutputNoDistinctListener
Definition: AkMonitorError.h:195
@ ErrorCode_ATRAC9DecodeFailed
Definition: AkMonitorError.h:75
@ ErrorCode_VorbisDecodeError
Definition: AkMonitorError.h:70
@ ErrorCode_OpusHWCommandFailed
Definition: AkMonitorError.h:183
@ ErrorCode_OpusHWTimeout
Definition: AkMonitorError.h:191
ErrorLevel
ErrorLevel.
Definition: AkMonitorError.h:45
@ ErrorCode_NoValidSwitch
Definition: AkMonitorError.h:118
AkUInt32 AkPlayingID
Playing ID.
Definition: AkTypes.h:65
@ ErrorCode_FileFormatMismatch
Definition: AkMonitorError.h:144
@ ErrorCode_PlayFailed
Definition: AkMonitorError.h:88
@ ErrorCode_PluginNotRegistered
Definition: AkMonitorError.h:108
@ ErrorCode_PluginAllocationFailed
Definition: AkMonitorError.h:66
@ ErrorCode_SeekAfterEndOfPlaylist
Definition: AkMonitorError.h:155
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