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