Version
menu_open
link
Wwise SDK 2022.1.4
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  Copyright (c) 2023 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 #ifndef _AKMONITORERROR_H
28 #define _AKMONITORERROR_H
29 
32 #define ERROR_CODE_DEF( in_name, in_msg ){ MonitorErrorInfo(in_name, in_msg) }
33 
34 struct AkStreamMgrSettings;
35 struct AkDeviceSettings;
37 
38 namespace AK
39 {
40  // Error monitoring.
41 
42  namespace Monitor
43  {
44  // This structure contains information related to the error message
45  struct MsgContext
46  {
48  : in_playingID{ pId },
49  in_gameObjID{ goId },
50  in_soundID{ nodeId },
51  in_bIsBus{ isBus }
52  {}
53 
54  AkPlayingID in_playingID; ///< Related Playing ID if applicable
55  AkGameObjectID in_gameObjID; ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
56  AkUniqueID in_soundID; ///< Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise
57  bool in_bIsBus; ///< true if in_audioNodeID is a bus
58  };
59 
61  {
62  MonitorErrorInfo(const AkOSChar* in_name = nullptr, const AkOSChar* in_message= nullptr)
63  : m_name{ in_name },
64  m_message{in_message}
65 
66  {}
67  const AkOSChar* m_name;
69  };
70 
71  /// ErrorLevel
72  enum ErrorLevel
73  {
74  ErrorLevel_Message = (1<<0), // used as bitfield
75  ErrorLevel_Error = (1<<1),
76 
78  };
79  /// ErrorCode
80  enum ErrorCode
81  {
82  ErrorCode_NoError = 0, // 0-based index into AK::Monitor::s_aszMonitorErrorInfos table
88 
95 
97 
99 
102 
106 
114 
121 
132 
136 
138 
143 
147 
149 
153 
155  ErrorCode_GameObjectNeverRegistered, //To be used by the Capture Log to replace ErrorCode_UnknownGameObject
156  ErrorCode_DeadGameObject, //To be used by the Capture Log to replace ErrorCode_UnknownGameObject
158 
161 
164 
167 
170 
172 
175 
177 
179 
181  ErrorCode_UnknownOpusError, //Deprecated Opus error.
182 
187 
190 
191  ErrorCode_HwVoicesSystemInitFailed, // When the hardware-accelerated subsystem fails to initialize
192  ErrorCode_HwVoicesDecodeBatchFailed, // When a grouping of hardware-accelerated voices fail to decode collectively
193  ErrorCode_HwVoiceLimitReached, // Cannot create any more hardware-accelerated voices
194  ErrorCode_HwVoiceInitFailed, // A hardware-accelerated voice fails to be created, but not because the max number of voices was reached
195 
197 
199 
201 
205 
207 
209 
212 
215 
218 
220 
223 
226 
227 
237 
243 
245 
250 
251  //MONITOR_ERRORMSG
256 
263 
265 
273 
279 
288 
302 
312 
313  //AkSpatialAudio:AkMonitorError_WithID
318 
319  //Invalid float
322 
323 
328 
330 
338 
340 
345 
347 
358 
359  // ALWAYS ADD NEW CODES AT THE END !!!!!!!
360  // Otherwise it may break comm compatibility in a patch
361 
362  Num_ErrorCodes // THIS STAYS AT END OF ENUM
363  };
364 
365  static_assert(Num_ErrorCodes == 211,
366  "Please document your new ErrorCode "
367  "in 'Documentation/Help/source_en/reference/common_errors_capture_log.xml', "
368  "then you can increment this value."
369  );
370 
371  /// Function prototype of local output function pointer.
373  ErrorCode in_eErrorCode, ///< Error code number value
374  const AkOSChar* in_pszError, ///< Message or error string to be displayed
375  ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
376  AkPlayingID in_playingID, ///< Related Playing ID if applicable, AK_INVALID_PLAYING_ID otherwise
377  AkGameObjectID in_gameObjID ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
378  );
379 
381 
382  /// Post a monitoring message or error code. This will be displayed in the Wwise capture
383  /// log. Since this function doesn't send variable arguments, be sure that the error code you're posting doesn't contain any tag.
384  /// Otherwise, there'll be an undefined behavior
385  /// \return AK_Success if successful, AK_Fail if there was a problem posting the message.
386  /// In optimized mode, this function returns AK_NotCompatible.
387  /// \remark This function is provided as a tracking tool only. It does nothing if it is
388  /// called in the optimized/release configuration and return AK_NotCompatible.
390  ErrorCode in_eError, ///< Message or error code to be displayed
391  ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
392  AkPlayingID in_playingID = AK_INVALID_PLAYING_ID, ///< Related Playing ID if applicable
393  AkGameObjectID in_gameObjID = AK_INVALID_GAME_OBJECT, ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
394  AkUniqueID in_audioNodeID = AK_INVALID_UNIQUE_ID, ///< Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise
395  bool in_bIsBus = false ///< true if in_audioNodeID is a bus
396  );
397 
399  ErrorCode in_eError, ///< Error code to be displayed. This code corresponds to a predefined message, that may have parameters that can be passed in the variable arguments. Check the message format at the end of AkMonitorError.h.
400  ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
401  MsgContext msgContext, ///< The message context containing the following information : Related Playing ID if applicable, Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise, Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise and whether if in_audioNodeID is a bus
402  ... ///< The variable arguments, depending on the ErrorCode posted.
403  );
404 
405  /// Post a monitoring message. This will be displayed in the Wwise capture log.
406  /// \return AK_Success if successful, AK_Fail if there was a problem posting the message.
407  /// In optimized mode, this function returns AK_NotCompatible.
408  /// \remark This function is provided as a tracking tool only. It does nothing if it is
409  /// called in the optimized/release configuration and return AK_NotCompatible.
411  ErrorCode in_eError, ///< Error code to be displayed. This code corresponds to a predefined message, that may have parameters that can be passed in the variable arguments. Check the message format at the end of AkMonitorError.h.
412  ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
413  MsgContext msgContext, ///< The message context containing the following information : Related Playing ID if applicable, Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise, Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise and whether if in_audioNodeID is a bus
414  ::va_list args ///< The variable arguments, depending on the ErrorCode posted.
415  );
416 
417 #ifdef AK_SUPPORT_WCHAR
418  /// Post a unicode monitoring message or error string. This will be displayed in the Wwise capture
419  /// log.
420  /// \return AK_Success if successful, AK_Fail if there was a problem posting the message.
421  /// In optimized mode, this function returns AK_NotCompatible.
422  /// \remark This function is provided as a tracking tool only. It does nothing if it is
423  /// called in the optimized/release configuration and return AK_NotCompatible.
425  const wchar_t* in_pszError, ///< Message or error string to be displayed
426  ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
427  AkPlayingID in_playingID = AK_INVALID_PLAYING_ID, ///< Related Playing ID if applicable
428  AkGameObjectID in_gameObjID = AK_INVALID_GAME_OBJECT, ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
429  AkUniqueID in_audioNodeID = AK_INVALID_UNIQUE_ID, ///< Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise
430  bool in_bIsBus = false ///< true if in_audioNodeID is a bus
431  );
432 
433 #endif // #ifdef AK_SUPPORT_WCHAR
434 
435  /// Post a monitoring message or error string. This will be displayed in the Wwise capture
436  /// log.
437  /// \return AK_Success if successful, AK_Fail if there was a problem posting the message.
438  /// In optimized mode, this function returns AK_NotCompatible.
439  /// \remark This function is provided as a tracking tool only. It does nothing if it is
440  /// called in the optimized/release configuration and return AK_NotCompatible.
442  const char* in_pszError, ///< Message or error string to be displayed
443  ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
444  AkPlayingID in_playingID = AK_INVALID_PLAYING_ID, ///< Related Playing ID if applicable
445  AkGameObjectID in_gameObjID = AK_INVALID_GAME_OBJECT, ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
446  AkUniqueID in_audioNodeID = AK_INVALID_UNIQUE_ID, ///< Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise
447  bool in_bIsBus = false ///< true if in_audioNodeID is a bus
448  );
449 
450  /// Enable/Disable local output of monitoring messages or errors. Pass 0 to disable,
451  /// or any combination of ErrorLevel_Message and ErrorLevel_Error to enable.
452  /// \return AK_Success.
453  /// In optimized/release configuration, this function returns AK_NotCompatible.
455  AkUInt32 in_uErrorLevel = ErrorLevel_All, ///< ErrorLevel(s) to enable in output. Default parameters enable all.
456  LocalOutputFunc in_pMonitorFunc = 0 ///< Handler for local output. If NULL, the standard platform debug output method is used.
457  );
458 
459  /// Add a translator to the wwiseErrorHandler
460  /// The additional translators increase the chance of a monitoring messages or errors
461  /// to be succeffully translated.
462  /// \return AK_Success.
463  /// In optimized/release configuration, this function returns AK_NotCompatible.
465  AkErrorMessageTranslator* translator, ///< The AkErrorMessageTranslator to add to the WwiseErrorHandler
466  bool overridePreviousTranslators = false ///< Whether or not the newly added translator should override all the previous translators.
467  ///< In both cases, the default translator will remain
468  );
469 
470  /// Reset the wwiseErrorHandler to only using the default translator
471  /// \return AK_Success.
472  /// In optimized/release configuration, this function returns AK_NotCompatible.
474  );
475 
476  /// Get the time stamp shown in the capture log along with monitoring messages.
477  /// \return Time stamp in milliseconds.
478  /// In optimized/release configuration, this function returns 0.
480 
481  /// Add the streaming manager settings to the profiler capture.
483  const AkStreamMgrSettings& in_streamMgrSettings
484  );
485 
486  /// Add device settings to the list of active streaming devices.
487  /// The list of streaming devices and their settings will be
488  /// sent to the profiler capture when remote connecting from Wwise.
489  ///
490  /// \remark \c AK::Monitor::MonitorStreamMgrTerm must be called to
491  /// clean-up memory used to keep track of active streaming devices.
493  AkDeviceID in_deviceID,
494  const AkDeviceSettings& in_deviceSettings
495  );
496 
497  /// Remove streaming device entry from the list of devices
498  /// to send when remote connecting from Wwise.
500  AkDeviceID in_deviceID
501  );
502 
503  /// Monitor streaming manager destruction as part of the
504  /// profiler capture.
505  ///
506  /// \remark This function must be called to clean-up memory used by
507  /// \c AK::Monitor::MonitorStreamingDeviceInit and \c AK::Monitor::MonitorStreamingDeviceTerm
508  /// to keep track of active streaming devices.
510  }
511 }
512 
513 // Macros.
514 #ifndef AK_OPTIMIZED
515  #define AK_MONITOR_ERROR( in_eErrorCode ) \
516  AK::Monitor::PostCode( in_eErrorCode, AK::Monitor::ErrorLevel_Error )
517 
518  #define AK_MONITOR_STREAM_MGR_INIT( in_streamMgrSettings ) \
519  AK::Monitor::MonitorStreamMgrInit( in_streamMgrSettings )
520 
521  #define AK_MONITOR_STREAMING_DEVICE_INIT( in_deviceID, in_deviceSettings ) \
522  AK::Monitor::MonitorStreamingDeviceInit( in_deviceID, in_deviceSettings )
523 
524  #define AK_MONITOR_STREAMING_DEVICE_DESTROYED( in_deviceID ) \
525  AK::Monitor::MonitorStreamingDeviceDestroyed( in_deviceID )
526 
527  #define AK_MONITOR_STREAM_MGR_TERM( ) \
528  AK::Monitor::MonitorStreamMgrTerm()
529 #else
530  #define AK_MONITOR_ERROR( in_eErrorCode )
531  #define AK_MONITOR_STREAM_MGR_INIT( in_streamMgrSettings )
532  #define AK_MONITOR_STREAMING_DEVICE_INIT( in_deviceID, in_deviceSettings )
533  #define AK_MONITOR_STREAMING_DEVICE_DESTROYED( in_deviceID )
534  #define AK_MONITOR_STREAM_MGR_TERM( )
535 #endif
536 
537 #ifdef AK_MONITOR_IMPLEMENT_ERRORCODES
539 #endif // AK_MONITOR_IMPLEMENT_ERRORCODES
540 
541 #endif // _AKMONITORERROR_H
@ ErrorCode_TooManyChildren
Definition: AkMonitorError.h:281
@ ErrorCode_CannotScheduleMusicSwitch
Definition: AkMonitorError.h:117
@ ErrorCode_FailedPostingEvent
Definition: AkMonitorError.h:234
@ ErrorCode_SoundEnginePlayingIdNotFound
Definition: AkMonitorError.h:260
@ ErrorCode_AmbisonicNotAvailable
Definition: AkMonitorError.h:327
ErrorCode
ErrorCode.
Definition: AkMonitorError.h:81
AKSOUNDENGINE_API AKRESULT PostCodeVaList(ErrorCode in_eError, ErrorLevel in_eErrorLevel, MsgContext msgContext, ::va_list args)
@ ErrorCode_PendingActionDestroyed
Definition: AkMonitorError.h:247
@ ErrorCode_3DObjectLimitExceeded
Definition: AkMonitorError.h:200
@ ErrorCode_SetPortalInvalidExtent
Definition: AkMonitorError.h:316
AkGameObjectID in_gameObjID
Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise.
Definition: AkMonitorError.h:55
@ ErrorCode_MusicEngineNotInitialized
Definition: AkMonitorError.h:277
@ ErrorCode_PluginProcessingFailed
Definition: AkMonitorError.h:92
@ ErrorCode_NXDeviceRegistrationFailed
Definition: AkMonitorError.h:286
@ ErrorCode_SetGeometryInstanceFailed
Definition: AkMonitorError.h:300
@ Num_ErrorCodes
Definition: AkMonitorError.h:362
@ ErrorCode_ResetPlaylistActionIgnoredGlobalScope
Definition: AkMonitorError.h:307
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:372
AkInt32 AkTimeMs
Time in ms.
Definition: AkTypes.h:118
Audiokinetic namespace.
@ ErrorCode_TooLongSegmentLookAhead
Definition: AkMonitorError.h:116
@ ErrorCode_StreamingSourceStarving
Definition: AkMonitorError.h:128
@ ErrorCode_PluginUnsupportedChannelConfiguration
Definition: AkMonitorError.h:89
@ ErrorCode_NoAudioDevice
Definition: AkMonitorError.h:329
@ ErrorCode_RevertingToDefaultAudioDevice
Definition: AkMonitorError.h:303
@ ErrorCode_CrossFadeTransitionIgnored
Definition: AkMonitorError.h:248
@ ErrorCode_FileNotFound
Definition: AkMonitorError.h:83
V1::Notifications::Monitor Monitor
Latest version of the C++ Monitor notification interface.
Definition: Notifications.h:203
@ ErrorCode_PluginFileRegisterFailed
Definition: AkMonitorError.h:242
@ ErrorCode_TooManySimultaneousMusicSegments
Definition: AkMonitorError.h:118
@ ErrorCode_BusNotFound
Definition: AkMonitorError.h:272
@ ErrorCode_CannotStartStreamNoMemory
Definition: AkMonitorError.h:85
@ ErrorCode_DataAlignement
Definition: AkMonitorError.h:350
@ ErrorCode_BankLoadFailed
Definition: AkMonitorError.h:144
@ ErrorCode_JobMgrOutOfMemory
Definition: AkMonitorError.h:222
@ ErrorCode_SoundEngineCantCallOnChildBus
Definition: AkMonitorError.h:259
@ ErrorCode_UnknownDialogueEvent
Definition: AkMonitorError.h:233
@ ErrorCode_SpatialAudio_ListenerAutomationNotSupported
Definition: AkMonitorError.h:188
@ ErrorCode_XboxXMAFatalError
Definition: AkMonitorError.h:293
MonitorErrorInfo(const AkOSChar *in_name=nullptr, const AkOSChar *in_message=nullptr)
Definition: AkMonitorError.h:62
@ ErrorCode_CannotSeekContinuous
Definition: AkMonitorError.h:151
@ ErrorCode_InvalidFloatInFunction
Definition: AkMonitorError.h:320
@ ErrorCode_ATRAC9LoopSectionTooSmall
Definition: AkMonitorError.h:101
@ ErrorCode_TranslatorWwiseTagTest
Definition: AkMonitorError.h:336
@ ErrorCode_SoundLoadFailedInsufficientMemory
Definition: AkMonitorError.h:285
@ ErrorCode_SeekNoMarker
Definition: AkMonitorError.h:150
AKSOUNDENGINE_API AKRESULT AddTranslator(AkErrorMessageTranslator *translator, bool overridePreviousTranslators=false)
@ ErrorCode_HardwareOpusDecoderError
Definition: AkMonitorError.h:295
@ ErrorCode_PluginVersionMismatch
Definition: AkMonitorError.h:135
@ ErrorCode_AudioFileHeaderTooLarge
Definition: AkMonitorError.h:104
AKSOUNDENGINE_API AKRESULT SetLocalOutput(AkUInt32 in_uErrorLevel=ErrorLevel_All, LocalOutputFunc in_pMonitorFunc=0)
@ ErrorCode_UnknownOpusError
Definition: AkMonitorError.h:181
@ ErrorCode_RevertingToDummyAudioDevice
Definition: AkMonitorError.h:304
@ ErrorCode_MasterBusStructureNotLoaded
Definition: AkMonitorError.h:280
@ ErrorCode_EventIDNotFound
Definition: AkMonitorError.h:137
@ ErrorCode_PluginInitialisationFailed
Definition: AkMonitorError.h:91
@ ErrorCode_MonitorMsgTooLarge
Definition: AkMonitorError.h:217
@ ErrorCode_PlayingTriggerRateNotSupported
Definition: AkMonitorError.h:309
AkUInt64 AkGameObjectID
Game object ID.
Definition: AkTypes.h:122
@ ErrorCode_HwVoiceLimitReached
Definition: AkMonitorError.h:193
@ ErrorCode_PlaylistStoppedForEditing
Definition: AkMonitorError.h:119
@ ErrorCode_AudioThreadSuspended
Definition: AkMonitorError.h:305
@ ErrorCode_ModulatorScopeError_Inst
Definition: AkMonitorError.h:168
@ ErrorCode_SoundEngineTooManyPositions
Definition: AkMonitorError.h:258
#define AK_EXTERNAPIFUNC(_type, _name)
@ ErrorCode_TransitionNotAccurateChannel
Definition: AkMonitorError.h:107
@ ErrorCode_SetGeometryInstanceInvalidTransform
Definition: AkMonitorError.h:311
@ ErrorCode_AudioSubsystemStoppedResponding
Definition: AkMonitorError.h:264
AKRESULT
Standard function call result.
Definition: AkTypes.h:193
@ ErrorCode_SeekAfterEof
Definition: AkMonitorError.h:152
AkUInt32 AkDeviceID
I/O device ID.
Definition: AkTypes.h:140
@ ErrorCode_IncompatibleIOSettings
Definition: AkMonitorError.h:87
@ ErrorCode_InsufficientSpaceToLoadBank
Definition: AkMonitorError.h:146
@ ErrorCode_AudioNodeNotFound
Definition: AkMonitorError.h:269
@ ErrorLevel_All
Definition: AkMonitorError.h:77
@ ErrorCode_CannotPlaySource_VirtualOff
Definition: AkMonitorError.h:123
@ ErrorCode_ResetPlaylistActionIgnoredContinuous
Definition: AkMonitorError.h:308
@ ErrorCode_MediaDuplicationLength
Definition: AkMonitorError.h:189
@ ErrorCode_CannotPlaySource_Create
Definition: AkMonitorError.h:122
@ ErrorCode_InvalidParameter
Definition: AkMonitorError.h:339
char AkOSChar
Generic character string.
Definition: AkTypes.h:60
AKSOUNDENGINE_API void MonitorStreamingDeviceInit(AkDeviceID in_deviceID, const AkDeviceSettings &in_deviceSettings)
@ ErrorCode_MemoryAllocationFailed
Definition: AkMonitorError.h:283
AkPlayingID in_playingID
Related Playing ID if applicable.
Definition: AkMonitorError.h:54
@ ErrorCode_NothingToPlay
Definition: AkMonitorError.h:112
@ ErrorCode_StingerCouldNotBeScheduled
Definition: AkMonitorError.h:115
bool in_bIsBus
true if in_audioNodeID is a bus
Definition: AkMonitorError.h:57
@ ErrorCode_XMAStreamBufferTooSmall
Definition: AkMonitorError.h:166
@ ErrorCode_ModulatorScopeError_Obj
Definition: AkMonitorError.h:169
@ ErrorLevel_Message
Definition: AkMonitorError.h:74
@ ErrorCode_SetMixerFailed
Definition: AkMonitorError.h:270
@ ErrorCode_SetGeometryTooManyTriangleConnected
Definition: AkMonitorError.h:296
@ ErrorCode_AudioDeviceRemoveFailure
Definition: AkMonitorError.h:184
@ ErrorCode_MissingMusicNodeParent
Definition: AkMonitorError.h:294
AKSOUNDENGINE_API void MonitorStreamMgrTerm()
@ ErrorCode_UnloadBankFailed
Definition: AkMonitorError.h:236
@ ErrorCode_RemovingGeometrySetFailed
Definition: AkMonitorError.h:299
@ ErrorCode_TransitionNotAccurateSourceTooShort
Definition: AkMonitorError.h:346
@ ErrorCode_PluginFileInvalid
Definition: AkMonitorError.h:241
@ ErrorCode_TranslatorStringSizeTest
Definition: AkMonitorError.h:337
AkUniqueID in_soundID
Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise.
Definition: AkMonitorError.h:56
@ ErrorCode_AudioDeviceShareSetNotFound
Definition: AkMonitorError.h:254
@ ErrorCode_InvalidFileSize
Definition: AkMonitorError.h:224
@ ErrorCode_NonCompliantDeviceMemory
Definition: AkMonitorError.h:219
@ ErrorCode_ExternalSourceNotResolved
Definition: AkMonitorError.h:159
@ ErrorCode_PluginMsg
Definition: AkMonitorError.h:225
@ ErrorCode_CannotOpenFile
Definition: AkMonitorError.h:84
@ ErrorCode_TransitionNotAccuratePluginMismatch
Definition: AkMonitorError.h:108
@ ErrorCode_DynamicSequenceIdNotFound
Definition: AkMonitorError.h:252
@ ErrorCode_TranslatorStandardTagTest
Definition: AkMonitorError.h:335
@ ErrorCode_TransitionNotAccurateStarvation
Definition: AkMonitorError.h:110
@ ErrorCode_PluginMsgWithShareSet
Definition: AkMonitorError.h:351
@ ErrorCode_MusicRendererSeekingFailed
Definition: AkMonitorError.h:249
@ ErrorCode_InvalidFloatPriority
Definition: AkMonitorError.h:284
@ ErrorCode_NoError
Definition: AkMonitorError.h:82
AkUInt32 AkUniqueID
Unique 32-bit ID.
Definition: AkTypes.h:114
@ ErrorCode_SoundEngineNotInit
Definition: AkMonitorError.h:352
@ ErrorCode_SetGeometryTriangleTooLarge
Definition: AkMonitorError.h:297
@ ErrorCode_UnknownArgument
Definition: AkMonitorError.h:244
@ ErrorCode_SetBusConfigUnsupported
Definition: AkMonitorError.h:271
@ ErrorCode_TransitionNotAccurateRejectedByPlugin
Definition: AkMonitorError.h:109
@ ErrorCode_MediaNotLoaded
Definition: AkMonitorError.h:126
@ ErrorCode_AudioOutOfRangeOnBusFx
Definition: AkMonitorError.h:231
@ ErrorCode_DeadGameObject
Definition: AkMonitorError.h:156
@ ErrorCode_MixPluginOnObjectBus
Definition: AkMonitorError.h:287
@ ErrorCode_AlreadyInitialized
Definition: AkMonitorError.h:348
@ ErrorCode_SetGeometryFailed
Definition: AkMonitorError.h:298
@ ErrorCode_VorbisSeekTableRecommended
Definition: AkMonitorError.h:96
@ ErrorCode_NotEnoughSystemObjWin
Definition: AkMonitorError.h:344
@ ErrorCode_NotEnoughMemInFunction
Definition: AkMonitorError.h:266
const AkOSChar * m_message
Definition: AkMonitorError.h:68
AKSOUNDENGINE_API AKRESULT PostCodeVarArg(ErrorCode in_eError, ErrorLevel in_eErrorLevel, MsgContext msgContext,...)
@ ErrorCode_CommandQueueFull
Definition: AkMonitorError.h:162
@ ErrorCode_HwVoicesSystemInitFailed
Definition: AkMonitorError.h:191
@ ErrorCode_VorbisHWDecodeUnavailable
Definition: AkMonitorError.h:213
@ ErrorCode_XMADecoderSourceStarving
Definition: AkMonitorError.h:129
@ ErrorCode_NotEnoughMemoryToStart
Definition: AkMonitorError.h:180
@ ErrorCode_ErrorWhileLoadingBank
Definition: AkMonitorError.h:145
@ ErrorCode_MMSNotEnabled
Definition: AkMonitorError.h:342
@ ErrorCode_RemovingGeometryInstanceFailed
Definition: AkMonitorError.h:301
AKSOUNDENGINE_API AkTimeMs GetTimeStamp()
@ ErrorCode_AudioDeviceNotFound
Definition: AkMonitorError.h:185
@ ErrorCode_PluginMediaUnavailable
Definition: AkMonitorError.h:90
@ ErrorCode_WrongNumberOfArguments
Definition: AkMonitorError.h:349
@ ErrorCode_SinkOpenSL
Definition: AkMonitorError.h:228
MsgContext(AkPlayingID pId=AK_INVALID_PLAYING_ID, AkGameObjectID goId=AK_INVALID_GAME_OBJECT, AkUniqueID nodeId=AK_INVALID_UNIQUE_ID, bool isBus=false)
Definition: AkMonitorError.h:47
@ ErrorCode_SetMixerNotABus
Definition: AkMonitorError.h:268
@ ErrorCode_SoundEngineInvalidTransform
Definition: AkMonitorError.h:261
const MonitorErrorInfo s_aszMonitorErrorInfos[Num_ErrorCodes]
@ ErrorCode_XboxACPMessage
Definition: AkMonitorError.h:290
@ ErrorCode_OpusDecodeError
Definition: AkMonitorError.h:174
@ ErrorCode_SetPortalNonDistinctRoom
Definition: AkMonitorError.h:315
@ ErrorCode_CantSetBoundSwitch
Definition: AkMonitorError.h:354
@ ErrorLevel_Error
Definition: AkMonitorError.h:75
@ ErrorCode_PluginFileNotFound
Definition: AkMonitorError.h:238
@ ErrorCode_OpusRequireSeekTable
Definition: AkMonitorError.h:173
@ ErrorCode_AudioDeviceNotValid
Definition: AkMonitorError.h:186
@ ErrorCode_IODeviceInitFailed
Definition: AkMonitorError.h:355
@ ErrorCode_ReplayMessage
Definition: AkMonitorError.h:332
#define AK_CALLBACK(_type, _name)
@ ErrorCode_OutputDeviceInitializationFailed
Definition: AkMonitorError.h:235
@ ErrorCode_SpatialAudio_ReflectionBusError
Definition: AkMonitorError.h:211
@ ErrorCode_CannotPlaySource_InconsistentState
Definition: AkMonitorError.h:125
@ ErrorCode_SelectedNodeNotAvailable
Definition: AkMonitorError.h:140
@ ErrorCode_SetGameObjectRadiusSizeError
Definition: AkMonitorError.h:314
@ ErrorCode_SetGeometryTriangleIsSkipped
Definition: AkMonitorError.h:310
static const AkUniqueID AK_INVALID_UNIQUE_ID
Invalid unique 32-bit ID.
Definition: AkTypes.h:157
@ ErrorCode_XMADecodingError
Definition: AkMonitorError.h:130
@ ErrorCode_TestMessage
Definition: AkMonitorError.h:334
@ ErrorCode_OpusHWFatalError
Definition: AkMonitorError.h:202
@ ErrorCode_PluginCannotRunOnObjectConfig
Definition: AkMonitorError.h:210
@ ErrorCode_CannotInitializeAmbisonicChannelConfiguration
Definition: AkMonitorError.h:324
@ ErrorCode_XboxFrameDropped
Definition: AkMonitorError.h:291
@ ErrorCode_XMACreateDecoderLimitReached
Definition: AkMonitorError.h:165
static const AkPlayingID AK_INVALID_PLAYING_ID
Invalid playing ID.
Definition: AkTypes.h:159
AKSOUNDENGINE_API void MonitorStreamMgrInit(const AkStreamMgrSettings &in_streamMgrSettings)
Add the streaming manager settings to the profiler capture.
@ ErrorCode_GameObjectIsNotEmitter
Definition: AkMonitorError.h:157
@ ErrorCode_HwVoiceInitFailed
Definition: AkMonitorError.h:194
@ ErrorCode_IODevice
Definition: AkMonitorError.h:86
@ ErrorCode_InvalidGroupID
Definition: AkMonitorError.h:139
@ ErrorCode_XboxXMAVoiceResetFailed
Definition: AkMonitorError.h:289
@ ErrorCode_OpusHWDecodeUnavailable
Definition: AkMonitorError.h:203
@ ErrorCode_InvalidAudioFileHeader
Definition: AkMonitorError.h:103
@ ErrorCode_CommandTooLarge
Definition: AkMonitorError.h:163
@ ErrorCode_JobWorkerFuncCallMismatch
Definition: AkMonitorError.h:221
@ ErrorCode_LowerEngineCommandListFull
Definition: AkMonitorError.h:148
@ ErrorCode_AudioOutOfRangeRay
Definition: AkMonitorError.h:232
@ ErrorCode_DynamicSequenceAlreadyClosed
Definition: AkMonitorError.h:246
@ ErrorCode_GameMessage
Definition: AkMonitorError.h:333
@ ErrorCode_LoopTooSmall
Definition: AkMonitorError.h:105
@ ErrorCode_CannotPlaySource_TimeSkip
Definition: AkMonitorError.h:124
@ ErrorCode_SelectedMediaNotAvailable
Definition: AkMonitorError.h:141
@ ErrorCode_PluginFileIncompatible
Definition: AkMonitorError.h:239
@ ErrorCode_Support
Definition: AkMonitorError.h:331
@ ErrorCode_NotEnoughSystemObj
Definition: AkMonitorError.h:343
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
Definition: AkTypes.h:156
@ ErrorCode_FXNotFound
Definition: AkMonitorError.h:267
@ ErrorCode_VirtualVoiceLimit
Definition: AkMonitorError.h:178
@ ErrorCode_PluginExecutionInvalid
Definition: AkMonitorError.h:93
@ ErrorCode_SoundEngineTooManyEventPosts
Definition: AkMonitorError.h:262
@ ErrorCode_TransitionNotAccurateCodecError
Definition: AkMonitorError.h:111
@ ErrorCode_AudioDeviceInitFailure
Definition: AkMonitorError.h:183
@ ErrorCode_AudioOutOfRangeOnBus
Definition: AkMonitorError.h:230
uint32_t AkUInt32
Unsigned 32-bit integer.
Definition: AkNumeralTypes.h:38
AKSOUNDENGINE_API void MonitorStreamingDeviceDestroyed(AkDeviceID in_deviceID)
@ ErrorCode_BankContainUneditableEffect
Definition: AkMonitorError.h:282
@ ErrorCode_InvalidXMAData
Definition: AkMonitorError.h:131
AKSOUNDENGINE_API AKRESULT ResetTranslator()
@ ErrorCode_LoadingBankMismatch
Definition: AkMonitorError.h:278
@ ErrorCode_SystemAudioObjectsUnavailable
Definition: AkMonitorError.h:206
@ ErrorCode_UnexpectedPrepareGameSyncsCall
Definition: AkMonitorError.h:276
@ ErrorCode_AddOutputListenerIdWithZeroListeners
Definition: AkMonitorError.h:198
@ ErrorCode_CodecNotRegistered
Definition: AkMonitorError.h:134
@ ErrorCode_UnknownGameObject
Definition: AkMonitorError.h:154
@ ErrorCode_HwVoicesDecodeBatchFailed
Definition: AkMonitorError.h:192
@ ErrorCode_AudioOutOfRange
Definition: AkMonitorError.h:229
const AkOSChar * m_name
Definition: AkMonitorError.h:67
@ ErrorCode_SoundEngineTooManyGameObjects
Definition: AkMonitorError.h:257
@ ErrorCode_SourcePluginNotFound
Definition: AkMonitorError.h:176
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_MaxAudioObjExceeded
Definition: AkMonitorError.h:341
@ ErrorCode_FLTMAXNotSupported
Definition: AkMonitorError.h:321
@ ErrorCode_VoiceStarving
Definition: AkMonitorError.h:127
@ ErrorCode_MismatchingMediaSize
Definition: AkMonitorError.h:274
@ ErrorCode_MusicClipsRescheduledAfterTrackEdit
Definition: AkMonitorError.h:120
@ ErrorCode_AddOutputNoDistinctListener
Definition: AkMonitorError.h:208
@ ErrorCode_AudioDeviceShareSetNotFoundByName
Definition: AkMonitorError.h:255
@ ErrorCode_ATRAC9DecodeFailed
Definition: AkMonitorError.h:100
@ ErrorCode_3DAudioUnsupportedSize
Definition: AkMonitorError.h:326
@ ErrorCode_VorbisDecodeError
Definition: AkMonitorError.h:98
@ ErrorCode_NoSwitchSelected
Definition: AkMonitorError.h:357
@ ErrorCode_OpusHWCommandFailed
Definition: AkMonitorError.h:196
@ ErrorCode_OpusHWTimeout
Definition: AkMonitorError.h:204
ErrorLevel
ErrorLevel.
Definition: AkMonitorError.h:73
@ ErrorCode_NoValidSwitch
Definition: AkMonitorError.h:142
@ ErrorCode_BusNotFoundByName
Definition: AkMonitorError.h:253
@ ErrorCode_MonitorQueueFull
Definition: AkMonitorError.h:216
@ ErrorCode_PluginFileNotEnoughMemoryToStart
Definition: AkMonitorError.h:240
@ ErrorCode_NoDefaultSwitch
Definition: AkMonitorError.h:353
AkUInt32 AkPlayingID
Playing ID.
Definition: AkTypes.h:117
@ ErrorCode_FileFormatMismatch
Definition: AkMonitorError.h:160
@ ErrorCode_PlayFailed
Definition: AkMonitorError.h:113
@ ErrorCode_PluginNotRegistered
Definition: AkMonitorError.h:133
@ ErrorCode_ExternalSourceNoMemorySize
Definition: AkMonitorError.h:214
@ ErrorCode_AudioThreadResumed
Definition: AkMonitorError.h:306
@ ErrorCode_IncompatibleBankVersion
Definition: AkMonitorError.h:275
@ ErrorCode_PluginAllocationFailed
Definition: AkMonitorError.h:94
@ ErrorCode_SwitchListEmpty
Definition: AkMonitorError.h:356
@ ErrorCode_XboxACPError
Definition: AkMonitorError.h:292
@ ErrorCode_GameObjectNeverRegistered
Definition: AkMonitorError.h:155
@ ErrorCode_SpatialAudio_PortalNotFound
Definition: AkMonitorError.h:317
@ ErrorCode_SeekAfterEndOfPlaylist
Definition: AkMonitorError.h:171
@ ErrorCode_CannotInitializePassthrough
Definition: AkMonitorError.h:325
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