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 
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_IODevice,
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  ErrorCode_XMADecoderSourceStarving,
130  ErrorCode_XMADecodingError,
131  ErrorCode_InvalidXMAData,
132 
133  ErrorCode_PluginNotRegistered,
134  ErrorCode_CodecNotRegistered,
135  ErrorCode_PluginVersionMismatch,
136 
137  ErrorCode_EventIDNotFound,
138 
139  ErrorCode_InvalidGroupID,
140  ErrorCode_SelectedNodeNotAvailable,
141  ErrorCode_SelectedMediaNotAvailable,
142  ErrorCode_NoValidSwitch,
143 
144  ErrorCode_BankLoadFailed,
145  ErrorCode_ErrorWhileLoadingBank,
146  ErrorCode_InsufficientSpaceToLoadBank,
147 
148  ErrorCode_LowerEngineCommandListFull,
149 
150  ErrorCode_SeekNoMarker,
151  ErrorCode_CannotSeekContinuous,
152  ErrorCode_SeekAfterEof,
153 
154  ErrorCode_UnknownGameObject,
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
157  ErrorCode_GameObjectIsNotEmitter,
158 
159  ErrorCode_ExternalSourceNotResolved,
160  ErrorCode_FileFormatMismatch,
161 
162  ErrorCode_CommandQueueFull,
163  ErrorCode_CommandTooLarge,
164 
165  ErrorCode_XMACreateDecoderLimitReached,
166  ErrorCode_XMAStreamBufferTooSmall,
167 
168  ErrorCode_ModulatorScopeError_Inst,
169  ErrorCode_ModulatorScopeError_Obj,
170 
171  ErrorCode_SeekAfterEndOfPlaylist,
172 
173  ErrorCode_OpusRequireSeekTable,
174  ErrorCode_OpusDecodeError,
175 
176  ErrorCode_SourcePluginNotFound,
177 
178  ErrorCode_VirtualVoiceLimit,
179 
180  ErrorCode_NotEnoughMemoryToStart,
181  ErrorCode_UnknownOpusError, //Deprecated Opus error.
182 
183  ErrorCode_AudioDeviceInitFailure,
184  ErrorCode_AudioDeviceRemoveFailure,
185  ErrorCode_AudioDeviceNotFound,
186  ErrorCode_AudioDeviceNotValid,
187 
188  ErrorCode_SpatialAudio_ListenerAutomationNotSupported,
189  ErrorCode_MediaDuplicationLength,
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 
196  ErrorCode_OpusHWCommandFailed,
197 
198  ErrorCode_AddOutputListenerIdWithZeroListeners,
199 
200  ErrorCode_3DObjectLimitExceeded,
201 
202  ErrorCode_OpusHWFatalError,
203  ErrorCode_OpusHWDecodeUnavailable,
204  ErrorCode_OpusHWTimeout,
205 
206  ErrorCode_SystemAudioObjectsUnavailable,
207 
208  ErrorCode_AddOutputNoDistinctListener,
209 
210  ErrorCode_PluginCannotRunOnObjectConfig,
211  ErrorCode_SpatialAudio_ReflectionBusError,
212 
213  ErrorCode_VorbisHWDecodeUnavailable,
214  ErrorCode_ExternalSourceNoMemorySize,
215 
216  ErrorCode_MonitorQueueFull,
217  ErrorCode_MonitorMsgTooLarge,
218 
219  ErrorCode_NonCompliantDeviceMemory,
220 
221  ErrorCode_JobWorkerFuncCallMismatch,
222  ErrorCode_JobMgrOutOfMemory,
223 
224  ErrorCode_InvalidFileSize,
225  ErrorCode_PluginMsg,
226 
227 
228  ErrorCode_SinkOpenSL,
229  ErrorCode_AudioOutOfRange,
230  ErrorCode_AudioOutOfRangeOnBus,
231  ErrorCode_AudioOutOfRangeOnBusFx,
232  ErrorCode_AudioOutOfRangeRay,
233  ErrorCode_UnknownDialogueEvent,
234  ErrorCode_FailedPostingEvent,
235  ErrorCode_OutputDeviceInitializationFailed,
236  ErrorCode_UnloadBankFailed,
237 
238  ErrorCode_PluginFileNotFound,
239  ErrorCode_PluginFileIncompatible,
240  ErrorCode_PluginFileNotEnoughMemoryToStart,
241  ErrorCode_PluginFileInvalid,
242  ErrorCode_PluginFileRegisterFailed,
243 
244  ErrorCode_UnknownArgument,
245 
246  ErrorCode_DynamicSequenceAlreadyClosed,
247  ErrorCode_PendingActionDestroyed,
248  ErrorCode_CrossFadeTransitionIgnored,
249  ErrorCode_MusicRendererSeekingFailed,
250 
251  //MONITOR_ERRORMSG
252  ErrorCode_DynamicSequenceIdNotFound,
253  ErrorCode_BusNotFoundByName,
254  ErrorCode_AudioDeviceShareSetNotFound,
255  ErrorCode_AudioDeviceShareSetNotFoundByName,
256 
257  ErrorCode_SoundEngineTooManyGameObjects,
258  ErrorCode_SoundEngineTooManyPositions,
259  ErrorCode_SoundEngineCantCallOnChildBus,
260  ErrorCode_SoundEnginePlayingIdNotFound,
261  ErrorCode_SoundEngineInvalidTransform,
262  ErrorCode_SoundEngineTooManyEventPosts,
263 
264  ErrorCode_AudioSubsystemStoppedResponding,
265 
266  ErrorCode_NotEnoughMemInFunction,
267  ErrorCode_FXNotFound,
268  ErrorCode_SetMixerNotABus,
269  ErrorCode_AudioNodeNotFound,
270  ErrorCode_SetMixerFailed,
271  ErrorCode_SetBusConfigUnsupported,
272  ErrorCode_BusNotFound,
273 
274  ErrorCode_MismatchingMediaSize,
275  ErrorCode_IncompatibleBankVersion,
276  ErrorCode_UnexpectedPrepareGameSyncsCall,
277  ErrorCode_MusicEngineNotInitialized,
278  ErrorCode_LoadingBankMismatch,
279 
280  ErrorCode_MasterBusStructureNotLoaded,
281  ErrorCode_TooManyChildren,
282  ErrorCode_BankContainUneditableEffect,
283  ErrorCode_MemoryAllocationFailed,
284  ErrorCode_InvalidFloatPriority,
285  ErrorCode_SoundLoadFailedInsufficientMemory,
286  ErrorCode_NXDeviceRegistrationFailed,
287  ErrorCode_MixPluginOnObjectBus,
288 
289  ErrorCode_XboxXMAVoiceResetFailed,
290  ErrorCode_XboxACPMessage,
291  ErrorCode_XboxFrameDropped,
292  ErrorCode_XboxACPError,
293  ErrorCode_XboxXMAFatalError,
294  ErrorCode_MissingMusicNodeParent,
295  ErrorCode_HardwareOpusDecoderError,
296  ErrorCode_SetGeometryTooManyTriangleConnected,
297  ErrorCode_SetGeometryTriangleTooLarge,
298  ErrorCode_SetGeometryFailed,
299  ErrorCode_RemovingGeometrySetFailed,
300  ErrorCode_SetGeometryInstanceFailed,
301  ErrorCode_RemovingGeometryInstanceFailed,
302 
303  ErrorCode_RevertingToDefaultAudioDevice,
304  ErrorCode_RevertingToDummyAudioDevice,
305  ErrorCode_AudioThreadSuspended,
306  ErrorCode_AudioThreadResumed,
307  ErrorCode_ResetPlaylistActionIgnoredGlobalScope,
308  ErrorCode_ResetPlaylistActionIgnoredContinuous,
309  ErrorCode_PlayingTriggerRateNotSupported,
310  ErrorCode_SetGeometryTriangleIsSkipped,
311  ErrorCode_SetGeometryInstanceInvalidTransform,
312 
313  //AkSpatialAudio:AkMonitorError_WithID
314  ErrorCode_SetGameObjectRadiusSizeError,
315  ErrorCode_SetPortalNonDistinctRoom,
316  ErrorCode_SetPortalInvalidExtent,
317  ErrorCode_SpatialAudio_PortalNotFound,
318 
319  //Invalid float
320  ErrorCode_InvalidFloatInFunction,
321  ErrorCode_FLTMAXNotSupported,
322 
323 
324  ErrorCode_CannotInitializeAmbisonicChannelConfiguration,
325  ErrorCode_CannotInitializePassthrough,
326  ErrorCode_3DAudioUnsupportedSize,
327  ErrorCode_AmbisonicNotAvailable,
328 
329  ErrorCode_NoAudioDevice,
330 
331  ErrorCode_Support,
332  ErrorCode_ReplayMessage,
333  ErrorCode_GameMessage,
334  ErrorCode_TestMessage,
335  ErrorCode_TranslatorStandardTagTest,
336  ErrorCode_TranslatorWwiseTagTest,
337  ErrorCode_TranslatorStringSizeTest,
338 
339  ErrorCode_InvalidParameter,
340 
341  ErrorCode_MaxAudioObjExceeded,
342  ErrorCode_MMSNotEnabled,
343  ErrorCode_NotEnoughSystemObj,
344  ErrorCode_NotEnoughSystemObjWin,
345 
346  ErrorCode_TransitionNotAccurateSourceTooShort,
347 
348  ErrorCode_AlreadyInitialized,
349  ErrorCode_WrongNumberOfArguments,
350  ErrorCode_DataAlignement,
351  ErrorCode_PluginMsgWithShareSet,
352  ErrorCode_SoundEngineNotInit,
353  ErrorCode_NoDefaultSwitch,
354  ErrorCode_CantSetBoundSwitch,
355  ErrorCode_IODeviceInitFailed,
356  ErrorCode_SwitchListEmpty,
357  ErrorCode_NoSwitchSelected,
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.
372  AK_CALLBACK( void, LocalOutputFunc )(
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 
380  extern const MonitorErrorInfo s_aszMonitorErrorInfos[ Num_ErrorCodes ];
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.
389  AK_EXTERNAPIFUNC( AKRESULT, PostCode )(
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 
398  AK_EXTERNAPIFUNC(AKRESULT, PostCodeVarArg)(
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.
410  AK_EXTERNAPIFUNC(AKRESULT, PostCodeVaList)(
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.
424  AK_EXTERNAPIFUNC( AKRESULT, PostString )(
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.
441  AK_EXTERNAPIFUNC( AKRESULT, PostString )(
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.
454  AK_EXTERNAPIFUNC( AKRESULT, SetLocalOutput )(
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.
464  AK_EXTERNAPIFUNC( AKRESULT, AddTranslator )(
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.
473  AK_EXTERNAPIFUNC(AKRESULT, ResetTranslator)(
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.
479  AK_EXTERNAPIFUNC( AkTimeMs, GetTimeStamp )();
480 
481  /// Add the streaming manager settings to the profiler capture.
482  AK_EXTERNAPIFUNC(void, MonitorStreamMgrInit)(
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.
492  AK_EXTERNAPIFUNC(void, MonitorStreamingDeviceInit)(
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.
499  AK_EXTERNAPIFUNC(void, MonitorStreamingDeviceDestroyed)(
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.
509  AK_EXTERNAPIFUNC(void, MonitorStreamMgrTerm)();
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
538 #include <AK/Tools/Common/AkMonitorErrorImpl.h>
539 #endif // AK_MONITOR_IMPLEMENT_ERRORCODES
540 
541 #endif // _AKMONITORERROR_H
AK::Monitor::ErrorCode_TooManyChildren
@ ErrorCode_TooManyChildren
Definition: AkMonitorError.h:281
AK::Monitor::ErrorCode_CannotScheduleMusicSwitch
@ ErrorCode_CannotScheduleMusicSwitch
Definition: AkMonitorError.h:117
AK::Monitor::ErrorCode_FailedPostingEvent
@ ErrorCode_FailedPostingEvent
Definition: AkMonitorError.h:234
AK::Monitor::ErrorCode_SoundEnginePlayingIdNotFound
@ ErrorCode_SoundEnginePlayingIdNotFound
Definition: AkMonitorError.h:260
AK::Monitor::ErrorCode_AmbisonicNotAvailable
@ ErrorCode_AmbisonicNotAvailable
Definition: AkMonitorError.h:327
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:247
AK::Monitor::ErrorCode_3DObjectLimitExceeded
@ ErrorCode_3DObjectLimitExceeded
Definition: AkMonitorError.h:200
AK::Monitor::ErrorCode_SetPortalInvalidExtent
@ ErrorCode_SetPortalInvalidExtent
Definition: AkMonitorError.h:316
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_MusicEngineNotInitialized
@ ErrorCode_MusicEngineNotInitialized
Definition: AkMonitorError.h:277
AK::Monitor::ErrorCode_PluginProcessingFailed
@ ErrorCode_PluginProcessingFailed
Definition: AkMonitorError.h:92
AK::Monitor::ErrorCode_NXDeviceRegistrationFailed
@ ErrorCode_NXDeviceRegistrationFailed
Definition: AkMonitorError.h:286
AK::Monitor::ErrorCode_SetGeometryInstanceFailed
@ ErrorCode_SetGeometryInstanceFailed
Definition: AkMonitorError.h:300
AK::Monitor::Num_ErrorCodes
@ Num_ErrorCodes
Definition: AkMonitorError.h:362
AK::Monitor::ErrorCode_ResetPlaylistActionIgnoredGlobalScope
@ ErrorCode_ResetPlaylistActionIgnoredGlobalScope
Definition: AkMonitorError.h:307
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:372
AkTimeMs
AkInt32 AkTimeMs
Time in ms.
Definition: AkTypes.h:118
AK
Audiokinetic namespace.
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_NoAudioDevice
@ ErrorCode_NoAudioDevice
Definition: AkMonitorError.h:329
AK::Monitor::ErrorCode_RevertingToDefaultAudioDevice
@ ErrorCode_RevertingToDefaultAudioDevice
Definition: AkMonitorError.h:303
AK::Monitor::ErrorCode_CrossFadeTransitionIgnored
@ ErrorCode_CrossFadeTransitionIgnored
Definition: AkMonitorError.h:248
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:242
AK::Monitor::ErrorCode_TooManySimultaneousMusicSegments
@ ErrorCode_TooManySimultaneousMusicSegments
Definition: AkMonitorError.h:118
AK::Monitor::ErrorCode_BusNotFound
@ ErrorCode_BusNotFound
Definition: AkMonitorError.h:272
AK::Monitor::ErrorCode_CannotStartStreamNoMemory
@ ErrorCode_CannotStartStreamNoMemory
Definition: AkMonitorError.h:85
AK::Monitor::ErrorCode_DataAlignement
@ ErrorCode_DataAlignement
Definition: AkMonitorError.h:350
AK::Monitor::ErrorCode_BankLoadFailed
@ ErrorCode_BankLoadFailed
Definition: AkMonitorError.h:144
AK::Monitor::ErrorCode_JobMgrOutOfMemory
@ ErrorCode_JobMgrOutOfMemory
Definition: AkMonitorError.h:222
AK::Monitor::ErrorCode_SoundEngineCantCallOnChildBus
@ ErrorCode_SoundEngineCantCallOnChildBus
Definition: AkMonitorError.h:259
AK::Monitor::ErrorCode_UnknownDialogueEvent
@ ErrorCode_UnknownDialogueEvent
Definition: AkMonitorError.h:233
AK::Monitor::ErrorCode_SpatialAudio_ListenerAutomationNotSupported
@ ErrorCode_SpatialAudio_ListenerAutomationNotSupported
Definition: AkMonitorError.h:188
AK::Monitor::ErrorCode_XboxXMAFatalError
@ ErrorCode_XboxXMAFatalError
Definition: AkMonitorError.h:293
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:151
AK::Monitor::ErrorCode_InvalidFloatInFunction
@ ErrorCode_InvalidFloatInFunction
Definition: AkMonitorError.h:320
AK::Monitor::ErrorCode_ATRAC9LoopSectionTooSmall
@ ErrorCode_ATRAC9LoopSectionTooSmall
Definition: AkMonitorError.h:101
AK::Monitor::ErrorCode_TranslatorWwiseTagTest
@ ErrorCode_TranslatorWwiseTagTest
Definition: AkMonitorError.h:336
AK::Monitor::ErrorCode_SoundLoadFailedInsufficientMemory
@ ErrorCode_SoundLoadFailedInsufficientMemory
Definition: AkMonitorError.h:285
AK::Monitor::ErrorCode_SeekNoMarker
@ ErrorCode_SeekNoMarker
Definition: AkMonitorError.h:150
AK::Monitor::AddTranslator
AKSOUNDENGINE_API AKRESULT AddTranslator(AkErrorMessageTranslator *translator, bool overridePreviousTranslators=false)
AK::Monitor::ErrorCode_HardwareOpusDecoderError
@ ErrorCode_HardwareOpusDecoderError
Definition: AkMonitorError.h:295
AK::Monitor::ErrorCode_PluginVersionMismatch
@ ErrorCode_PluginVersionMismatch
Definition: AkMonitorError.h:135
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:181
AK::Monitor::ErrorCode_RevertingToDummyAudioDevice
@ ErrorCode_RevertingToDummyAudioDevice
Definition: AkMonitorError.h:304
AK::Monitor::ErrorCode_MasterBusStructureNotLoaded
@ ErrorCode_MasterBusStructureNotLoaded
Definition: AkMonitorError.h:280
AK::Monitor::ErrorCode_EventIDNotFound
@ ErrorCode_EventIDNotFound
Definition: AkMonitorError.h:137
AK::Monitor::ErrorCode_PluginInitialisationFailed
@ ErrorCode_PluginInitialisationFailed
Definition: AkMonitorError.h:91
AK::Monitor::ErrorCode_MonitorMsgTooLarge
@ ErrorCode_MonitorMsgTooLarge
Definition: AkMonitorError.h:217
AK::Monitor::ErrorCode_PlayingTriggerRateNotSupported
@ ErrorCode_PlayingTriggerRateNotSupported
Definition: AkMonitorError.h:309
AkGameObjectID
AkUInt64 AkGameObjectID
Game object ID.
Definition: AkTypes.h:122
AK::Monitor::ErrorCode_HwVoiceLimitReached
@ ErrorCode_HwVoiceLimitReached
Definition: AkMonitorError.h:193
AK::Monitor::ErrorCode_PlaylistStoppedForEditing
@ ErrorCode_PlaylistStoppedForEditing
Definition: AkMonitorError.h:119
AK::Monitor::ErrorCode_AudioThreadSuspended
@ ErrorCode_AudioThreadSuspended
Definition: AkMonitorError.h:305
AK::Monitor::ErrorCode_ModulatorScopeError_Inst
@ ErrorCode_ModulatorScopeError_Inst
Definition: AkMonitorError.h:168
AK::Monitor::ErrorCode_SoundEngineTooManyPositions
@ ErrorCode_SoundEngineTooManyPositions
Definition: AkMonitorError.h:258
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:311
AK::Monitor::ErrorCode_AudioSubsystemStoppedResponding
@ ErrorCode_AudioSubsystemStoppedResponding
Definition: AkMonitorError.h:264
AKRESULT
AKRESULT
Standard function call result.
Definition: AkTypes.h:193
AK::Monitor::ErrorCode_SeekAfterEof
@ ErrorCode_SeekAfterEof
Definition: AkMonitorError.h:152
AkDeviceID
AkUInt32 AkDeviceID
I/O device ID.
Definition: AkTypes.h:140
AK::Monitor::ErrorCode_IncompatibleIOSettings
@ ErrorCode_IncompatibleIOSettings
Definition: AkMonitorError.h:87
AK::Monitor::ErrorCode_InsufficientSpaceToLoadBank
@ ErrorCode_InsufficientSpaceToLoadBank
Definition: AkMonitorError.h:146
AK::Monitor::ErrorCode_AudioNodeNotFound
@ ErrorCode_AudioNodeNotFound
Definition: AkMonitorError.h:269
AK::Monitor::ErrorLevel_All
@ ErrorLevel_All
Definition: AkMonitorError.h:77
AK::Monitor::ErrorCode_CannotPlaySource_VirtualOff
@ ErrorCode_CannotPlaySource_VirtualOff
Definition: AkMonitorError.h:123
AK::Monitor::ErrorCode_ResetPlaylistActionIgnoredContinuous
@ ErrorCode_ResetPlaylistActionIgnoredContinuous
Definition: AkMonitorError.h:308
AK::Monitor::ErrorCode_MediaDuplicationLength
@ ErrorCode_MediaDuplicationLength
Definition: AkMonitorError.h:189
AK::Monitor::ErrorCode_CannotPlaySource_Create
@ ErrorCode_CannotPlaySource_Create
Definition: AkMonitorError.h:122
AK::Monitor::ErrorCode_InvalidParameter
@ ErrorCode_InvalidParameter
Definition: AkMonitorError.h:339
AkOSChar
char AkOSChar
Generic character string.
Definition: AkTypes.h:60
AK::Monitor::MonitorStreamingDeviceInit
AKSOUNDENGINE_API void MonitorStreamingDeviceInit(AkDeviceID in_deviceID, const AkDeviceSettings &in_deviceSettings)
AK::Monitor::ErrorCode_MemoryAllocationFailed
@ ErrorCode_MemoryAllocationFailed
Definition: AkMonitorError.h:283
AK::Monitor::MsgContext::in_playingID
AkPlayingID in_playingID
Related Playing ID if applicable.
Definition: AkMonitorError.h:54
AK::Monitor::ErrorCode_NothingToPlay
@ ErrorCode_NothingToPlay
Definition: AkMonitorError.h:112
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_XMAStreamBufferTooSmall
@ ErrorCode_XMAStreamBufferTooSmall
Definition: AkMonitorError.h:166
AK::Monitor::ErrorCode_ModulatorScopeError_Obj
@ ErrorCode_ModulatorScopeError_Obj
Definition: AkMonitorError.h:169
AK::Monitor::ErrorLevel_Message
@ ErrorLevel_Message
Definition: AkMonitorError.h:74
AK::Monitor::ErrorCode_SetMixerFailed
@ ErrorCode_SetMixerFailed
Definition: AkMonitorError.h:270
AK::Monitor::ErrorCode_SetGeometryTooManyTriangleConnected
@ ErrorCode_SetGeometryTooManyTriangleConnected
Definition: AkMonitorError.h:296
AK::Monitor::ErrorCode_AudioDeviceRemoveFailure
@ ErrorCode_AudioDeviceRemoveFailure
Definition: AkMonitorError.h:184
AK::Monitor::ErrorCode_MissingMusicNodeParent
@ ErrorCode_MissingMusicNodeParent
Definition: AkMonitorError.h:294
AK::Monitor::MonitorStreamMgrTerm
AKSOUNDENGINE_API void MonitorStreamMgrTerm()
AK::Monitor::ErrorCode_UnloadBankFailed
@ ErrorCode_UnloadBankFailed
Definition: AkMonitorError.h:236
AK::Monitor::ErrorCode_RemovingGeometrySetFailed
@ ErrorCode_RemovingGeometrySetFailed
Definition: AkMonitorError.h:299
AK::Monitor::ErrorCode_TransitionNotAccurateSourceTooShort
@ ErrorCode_TransitionNotAccurateSourceTooShort
Definition: AkMonitorError.h:346
AK::Monitor::ErrorCode_PluginFileInvalid
@ ErrorCode_PluginFileInvalid
Definition: AkMonitorError.h:241
AK::Monitor::ErrorCode_TranslatorStringSizeTest
@ ErrorCode_TranslatorStringSizeTest
Definition: AkMonitorError.h:337
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:254
AK::Monitor::ErrorCode_InvalidFileSize
@ ErrorCode_InvalidFileSize
Definition: AkMonitorError.h:224
AK::Monitor::ErrorCode_NonCompliantDeviceMemory
@ ErrorCode_NonCompliantDeviceMemory
Definition: AkMonitorError.h:219
AK::Monitor::ErrorCode_ExternalSourceNotResolved
@ ErrorCode_ExternalSourceNotResolved
Definition: AkMonitorError.h:159
AK::Monitor::ErrorCode_PluginMsg
@ ErrorCode_PluginMsg
Definition: AkMonitorError.h:225
AK::Monitor::ErrorCode_CannotOpenFile
@ ErrorCode_CannotOpenFile
Definition: AkMonitorError.h:84
AK::Monitor::ErrorCode_TransitionNotAccuratePluginMismatch
@ ErrorCode_TransitionNotAccuratePluginMismatch
Definition: AkMonitorError.h:108
AK::Monitor::ErrorCode_DynamicSequenceIdNotFound
@ ErrorCode_DynamicSequenceIdNotFound
Definition: AkMonitorError.h:252
AK::Monitor::ErrorCode_TranslatorStandardTagTest
@ ErrorCode_TranslatorStandardTagTest
Definition: AkMonitorError.h:335
AK::Monitor::ErrorCode_TransitionNotAccurateStarvation
@ ErrorCode_TransitionNotAccurateStarvation
Definition: AkMonitorError.h:110
AK::Monitor::ErrorCode_PluginMsgWithShareSet
@ ErrorCode_PluginMsgWithShareSet
Definition: AkMonitorError.h:351
AK::Monitor::ErrorCode_MusicRendererSeekingFailed
@ ErrorCode_MusicRendererSeekingFailed
Definition: AkMonitorError.h:249
AK::Monitor::ErrorCode_InvalidFloatPriority
@ ErrorCode_InvalidFloatPriority
Definition: AkMonitorError.h:284
AK::Monitor::ErrorCode_NoError
@ ErrorCode_NoError
Definition: AkMonitorError.h:82
AkUniqueID
AkUInt32 AkUniqueID
Unique 32-bit ID.
Definition: AkTypes.h:114
AK::Monitor::ErrorCode_SoundEngineNotInit
@ ErrorCode_SoundEngineNotInit
Definition: AkMonitorError.h:352
AK::Monitor::ErrorCode_SetGeometryTriangleTooLarge
@ ErrorCode_SetGeometryTriangleTooLarge
Definition: AkMonitorError.h:297
AK::Monitor::ErrorCode_UnknownArgument
@ ErrorCode_UnknownArgument
Definition: AkMonitorError.h:244
AK::Monitor::ErrorCode_SetBusConfigUnsupported
@ ErrorCode_SetBusConfigUnsupported
Definition: AkMonitorError.h:271
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:231
AK::Monitor::ErrorCode_DeadGameObject
@ ErrorCode_DeadGameObject
Definition: AkMonitorError.h:156
AK::Monitor::ErrorCode_MixPluginOnObjectBus
@ ErrorCode_MixPluginOnObjectBus
Definition: AkMonitorError.h:287
AK::Monitor::ErrorCode_AlreadyInitialized
@ ErrorCode_AlreadyInitialized
Definition: AkMonitorError.h:348
AK::Monitor::ErrorCode_SetGeometryFailed
@ ErrorCode_SetGeometryFailed
Definition: AkMonitorError.h:298
AK::Monitor::ErrorCode_VorbisSeekTableRecommended
@ ErrorCode_VorbisSeekTableRecommended
Definition: AkMonitorError.h:96
AK::Monitor::ErrorCode_NotEnoughSystemObjWin
@ ErrorCode_NotEnoughSystemObjWin
Definition: AkMonitorError.h:344
AK::Monitor::ErrorCode_NotEnoughMemInFunction
@ ErrorCode_NotEnoughMemInFunction
Definition: AkMonitorError.h:266
AK::Monitor::MonitorErrorInfo::m_message
const AkOSChar * m_message
Definition: AkMonitorError.h:68
AK::Monitor::PostCodeVarArg
AKSOUNDENGINE_API AKRESULT PostCodeVarArg(ErrorCode in_eError, ErrorLevel in_eErrorLevel, MsgContext msgContext,...)
AK::Monitor::ErrorCode_CommandQueueFull
@ ErrorCode_CommandQueueFull
Definition: AkMonitorError.h:162
AK::Monitor::ErrorCode_HwVoicesSystemInitFailed
@ ErrorCode_HwVoicesSystemInitFailed
Definition: AkMonitorError.h:191
AK::Monitor::ErrorCode_VorbisHWDecodeUnavailable
@ ErrorCode_VorbisHWDecodeUnavailable
Definition: AkMonitorError.h:213
AK::Monitor::ErrorCode_XMADecoderSourceStarving
@ ErrorCode_XMADecoderSourceStarving
Definition: AkMonitorError.h:129
AK::Monitor::ErrorCode_NotEnoughMemoryToStart
@ ErrorCode_NotEnoughMemoryToStart
Definition: AkMonitorError.h:180
AK::Monitor::ErrorCode_ErrorWhileLoadingBank
@ ErrorCode_ErrorWhileLoadingBank
Definition: AkMonitorError.h:145
AK::Monitor::ErrorCode_MMSNotEnabled
@ ErrorCode_MMSNotEnabled
Definition: AkMonitorError.h:342
AK::Monitor::ErrorCode_RemovingGeometryInstanceFailed
@ ErrorCode_RemovingGeometryInstanceFailed
Definition: AkMonitorError.h:301
AK::Monitor::GetTimeStamp
AKSOUNDENGINE_API AkTimeMs GetTimeStamp()
AK::Monitor::ErrorCode_AudioDeviceNotFound
@ ErrorCode_AudioDeviceNotFound
Definition: AkMonitorError.h:185
AK::Monitor::ErrorCode_PluginMediaUnavailable
@ ErrorCode_PluginMediaUnavailable
Definition: AkMonitorError.h:90
AK::Monitor::ErrorCode_WrongNumberOfArguments
@ ErrorCode_WrongNumberOfArguments
Definition: AkMonitorError.h:349
AK::Monitor::ErrorCode_SinkOpenSL
@ ErrorCode_SinkOpenSL
Definition: AkMonitorError.h:228
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_SetMixerNotABus
@ ErrorCode_SetMixerNotABus
Definition: AkMonitorError.h:268
AK::Monitor::ErrorCode_SoundEngineInvalidTransform
@ ErrorCode_SoundEngineInvalidTransform
Definition: AkMonitorError.h:261
AK::Monitor::s_aszMonitorErrorInfos
const MonitorErrorInfo s_aszMonitorErrorInfos[Num_ErrorCodes]
Definition: AkMonitorErrorImpl.h:37
AK::Monitor::ErrorCode_XboxACPMessage
@ ErrorCode_XboxACPMessage
Definition: AkMonitorError.h:290
AK::Monitor::ErrorCode_OpusDecodeError
@ ErrorCode_OpusDecodeError
Definition: AkMonitorError.h:174
AK::Monitor::ErrorCode_SetPortalNonDistinctRoom
@ ErrorCode_SetPortalNonDistinctRoom
Definition: AkMonitorError.h:315
AK::Monitor::ErrorCode_CantSetBoundSwitch
@ ErrorCode_CantSetBoundSwitch
Definition: AkMonitorError.h:354
AK::Monitor::ErrorLevel_Error
@ ErrorLevel_Error
Definition: AkMonitorError.h:75
AK::Monitor::ErrorCode_PluginFileNotFound
@ ErrorCode_PluginFileNotFound
Definition: AkMonitorError.h:238
AK::Monitor::ErrorCode_OpusRequireSeekTable
@ ErrorCode_OpusRequireSeekTable
Definition: AkMonitorError.h:173
AK::Monitor::ErrorCode_AudioDeviceNotValid
@ ErrorCode_AudioDeviceNotValid
Definition: AkMonitorError.h:186
AK::Monitor::ErrorCode_IODeviceInitFailed
@ ErrorCode_IODeviceInitFailed
Definition: AkMonitorError.h:355
AK::Monitor::ErrorCode_ReplayMessage
@ ErrorCode_ReplayMessage
Definition: AkMonitorError.h:332
AK_CALLBACK
#define AK_CALLBACK(_type, _name)
Definition: AkSoundEngineExport.h:87
AK::Monitor::ErrorCode_OutputDeviceInitializationFailed
@ ErrorCode_OutputDeviceInitializationFailed
Definition: AkMonitorError.h:235
AK::Monitor::ErrorCode_SpatialAudio_ReflectionBusError
@ ErrorCode_SpatialAudio_ReflectionBusError
Definition: AkMonitorError.h:211
AK::Monitor::ErrorCode_CannotPlaySource_InconsistentState
@ ErrorCode_CannotPlaySource_InconsistentState
Definition: AkMonitorError.h:125
AK::Monitor::ErrorCode_SelectedNodeNotAvailable
@ ErrorCode_SelectedNodeNotAvailable
Definition: AkMonitorError.h:140
AK::Monitor::ErrorCode_SetGameObjectRadiusSizeError
@ ErrorCode_SetGameObjectRadiusSizeError
Definition: AkMonitorError.h:314
AK::Monitor::ErrorCode_SetGeometryTriangleIsSkipped
@ ErrorCode_SetGeometryTriangleIsSkipped
Definition: AkMonitorError.h:310
AK_INVALID_UNIQUE_ID
static const AkUniqueID AK_INVALID_UNIQUE_ID
Invalid unique 32-bit ID.
Definition: AkTypes.h:157
AK::Monitor::ErrorCode_XMADecodingError
@ ErrorCode_XMADecodingError
Definition: AkMonitorError.h:130
AK::Monitor::ErrorCode_TestMessage
@ ErrorCode_TestMessage
Definition: AkMonitorError.h:334
AK::Monitor::ErrorCode_OpusHWFatalError
@ ErrorCode_OpusHWFatalError
Definition: AkMonitorError.h:202
AK::Monitor::ErrorCode_PluginCannotRunOnObjectConfig
@ ErrorCode_PluginCannotRunOnObjectConfig
Definition: AkMonitorError.h:210
AK::Monitor::ErrorCode_CannotInitializeAmbisonicChannelConfiguration
@ ErrorCode_CannotInitializeAmbisonicChannelConfiguration
Definition: AkMonitorError.h:324
AK::Monitor::ErrorCode_XboxFrameDropped
@ ErrorCode_XboxFrameDropped
Definition: AkMonitorError.h:291
AK::Monitor::ErrorCode_XMACreateDecoderLimitReached
@ ErrorCode_XMACreateDecoderLimitReached
Definition: AkMonitorError.h:165
AK_INVALID_PLAYING_ID
static const AkPlayingID AK_INVALID_PLAYING_ID
Invalid playing ID.
Definition: AkTypes.h:159
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:157
AK::Monitor::ErrorCode_HwVoiceInitFailed
@ ErrorCode_HwVoiceInitFailed
Definition: AkMonitorError.h:194
AK::Monitor::ErrorCode_IODevice
@ ErrorCode_IODevice
Definition: AkMonitorError.h:86
AK::Monitor::ErrorCode_InvalidGroupID
@ ErrorCode_InvalidGroupID
Definition: AkMonitorError.h:139
AK::Monitor::ErrorCode_XboxXMAVoiceResetFailed
@ ErrorCode_XboxXMAVoiceResetFailed
Definition: AkMonitorError.h:289
AK::Monitor::ErrorCode_OpusHWDecodeUnavailable
@ ErrorCode_OpusHWDecodeUnavailable
Definition: AkMonitorError.h:203
AK::Monitor::ErrorCode_InvalidAudioFileHeader
@ ErrorCode_InvalidAudioFileHeader
Definition: AkMonitorError.h:103
AK::Monitor::ErrorCode_CommandTooLarge
@ ErrorCode_CommandTooLarge
Definition: AkMonitorError.h:163
AK::Monitor::ErrorCode_JobWorkerFuncCallMismatch
@ ErrorCode_JobWorkerFuncCallMismatch
Definition: AkMonitorError.h:221
AK::Monitor::ErrorCode_LowerEngineCommandListFull
@ ErrorCode_LowerEngineCommandListFull
Definition: AkMonitorError.h:148
AK::Monitor::ErrorCode_AudioOutOfRangeRay
@ ErrorCode_AudioOutOfRangeRay
Definition: AkMonitorError.h:232
AK::Monitor::ErrorCode_DynamicSequenceAlreadyClosed
@ ErrorCode_DynamicSequenceAlreadyClosed
Definition: AkMonitorError.h:246
AK::Monitor::ErrorCode_GameMessage
@ ErrorCode_GameMessage
Definition: AkMonitorError.h:333
AK::Monitor::ErrorCode_LoopTooSmall
@ ErrorCode_LoopTooSmall
Definition: AkMonitorError.h:105
AK::Monitor::ErrorCode_CannotPlaySource_TimeSkip
@ ErrorCode_CannotPlaySource_TimeSkip
Definition: AkMonitorError.h:124
AK::Monitor::ErrorCode_SelectedMediaNotAvailable
@ ErrorCode_SelectedMediaNotAvailable
Definition: AkMonitorError.h:141
AK::Monitor::ErrorCode_PluginFileIncompatible
@ ErrorCode_PluginFileIncompatible
Definition: AkMonitorError.h:239
AK::Monitor::ErrorCode_Support
@ ErrorCode_Support
Definition: AkMonitorError.h:331
AK::Monitor::ErrorCode_NotEnoughSystemObj
@ ErrorCode_NotEnoughSystemObj
Definition: AkMonitorError.h:343
AK_INVALID_GAME_OBJECT
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
Definition: AkTypes.h:156
AK::Monitor::ErrorCode_FXNotFound
@ ErrorCode_FXNotFound
Definition: AkMonitorError.h:267
AK::Monitor::ErrorCode_VirtualVoiceLimit
@ ErrorCode_VirtualVoiceLimit
Definition: AkMonitorError.h:178
AK::Monitor::ErrorCode_PluginExecutionInvalid
@ ErrorCode_PluginExecutionInvalid
Definition: AkMonitorError.h:93
AK::Monitor::ErrorCode_SoundEngineTooManyEventPosts
@ ErrorCode_SoundEngineTooManyEventPosts
Definition: AkMonitorError.h:262
AK::Monitor::ErrorCode_TransitionNotAccurateCodecError
@ ErrorCode_TransitionNotAccurateCodecError
Definition: AkMonitorError.h:111
AK::Monitor::ErrorCode_AudioDeviceInitFailure
@ ErrorCode_AudioDeviceInitFailure
Definition: AkMonitorError.h:183
AK::Monitor::ErrorCode_AudioOutOfRangeOnBus
@ ErrorCode_AudioOutOfRangeOnBus
Definition: AkMonitorError.h:230
AkUInt32
uint32_t AkUInt32
Unsigned 32-bit integer.
Definition: AkNumeralTypes.h:38
AK::Monitor::MonitorStreamingDeviceDestroyed
AKSOUNDENGINE_API void MonitorStreamingDeviceDestroyed(AkDeviceID in_deviceID)
AK::Monitor::ErrorCode_BankContainUneditableEffect
@ ErrorCode_BankContainUneditableEffect
Definition: AkMonitorError.h:282
AK::Monitor::ErrorCode_InvalidXMAData
@ ErrorCode_InvalidXMAData
Definition: AkMonitorError.h:131
AK::Monitor::ResetTranslator
AKSOUNDENGINE_API AKRESULT ResetTranslator()
AK::Monitor::ErrorCode_LoadingBankMismatch
@ ErrorCode_LoadingBankMismatch
Definition: AkMonitorError.h:278
AK::Monitor::ErrorCode_SystemAudioObjectsUnavailable
@ ErrorCode_SystemAudioObjectsUnavailable
Definition: AkMonitorError.h:206
AK::Monitor::ErrorCode_UnexpectedPrepareGameSyncsCall
@ ErrorCode_UnexpectedPrepareGameSyncsCall
Definition: AkMonitorError.h:276
AK::Monitor::ErrorCode_AddOutputListenerIdWithZeroListeners
@ ErrorCode_AddOutputListenerIdWithZeroListeners
Definition: AkMonitorError.h:198
AK::Monitor::ErrorCode_CodecNotRegistered
@ ErrorCode_CodecNotRegistered
Definition: AkMonitorError.h:134
AK::Monitor::ErrorCode_UnknownGameObject
@ ErrorCode_UnknownGameObject
Definition: AkMonitorError.h:154
AK::Monitor::ErrorCode_HwVoicesDecodeBatchFailed
@ ErrorCode_HwVoicesDecodeBatchFailed
Definition: AkMonitorError.h:192
AK::Monitor::ErrorCode_AudioOutOfRange
@ ErrorCode_AudioOutOfRange
Definition: AkMonitorError.h:229
AK::Monitor::MonitorErrorInfo::m_name
const AkOSChar * m_name
Definition: AkMonitorError.h:67
AK::Monitor::ErrorCode_SoundEngineTooManyGameObjects
@ ErrorCode_SoundEngineTooManyGameObjects
Definition: AkMonitorError.h:257
AK::Monitor::ErrorCode_SourcePluginNotFound
@ ErrorCode_SourcePluginNotFound
Definition: AkMonitorError.h:176
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:341
AK::Monitor::ErrorCode_FLTMAXNotSupported
@ ErrorCode_FLTMAXNotSupported
Definition: AkMonitorError.h:321
AK::Monitor::ErrorCode_VoiceStarving
@ ErrorCode_VoiceStarving
Definition: AkMonitorError.h:127
AK::Monitor::ErrorCode_MismatchingMediaSize
@ ErrorCode_MismatchingMediaSize
Definition: AkMonitorError.h:274
AK::Monitor::ErrorCode_MusicClipsRescheduledAfterTrackEdit
@ ErrorCode_MusicClipsRescheduledAfterTrackEdit
Definition: AkMonitorError.h:120
AK::Monitor::ErrorCode_AddOutputNoDistinctListener
@ ErrorCode_AddOutputNoDistinctListener
Definition: AkMonitorError.h:208
AK::Monitor::ErrorCode_AudioDeviceShareSetNotFoundByName
@ ErrorCode_AudioDeviceShareSetNotFoundByName
Definition: AkMonitorError.h:255
AK::Monitor::ErrorCode_ATRAC9DecodeFailed
@ ErrorCode_ATRAC9DecodeFailed
Definition: AkMonitorError.h:100
AK::Monitor::ErrorCode_3DAudioUnsupportedSize
@ ErrorCode_3DAudioUnsupportedSize
Definition: AkMonitorError.h:326
AK::Monitor::ErrorCode_VorbisDecodeError
@ ErrorCode_VorbisDecodeError
Definition: AkMonitorError.h:98
AK::Monitor::ErrorCode_NoSwitchSelected
@ ErrorCode_NoSwitchSelected
Definition: AkMonitorError.h:357
AK::Monitor::ErrorCode_OpusHWCommandFailed
@ ErrorCode_OpusHWCommandFailed
Definition: AkMonitorError.h:196
AK::Monitor::ErrorCode_OpusHWTimeout
@ ErrorCode_OpusHWTimeout
Definition: AkMonitorError.h:204
AK::Monitor::ErrorLevel
ErrorLevel
ErrorLevel.
Definition: AkMonitorError.h:73
AK::Monitor::ErrorCode_NoValidSwitch
@ ErrorCode_NoValidSwitch
Definition: AkMonitorError.h:142
AK::Monitor::ErrorCode_BusNotFoundByName
@ ErrorCode_BusNotFoundByName
Definition: AkMonitorError.h:253
AK::Monitor::ErrorCode_MonitorQueueFull
@ ErrorCode_MonitorQueueFull
Definition: AkMonitorError.h:216
AK::Monitor::ErrorCode_PluginFileNotEnoughMemoryToStart
@ ErrorCode_PluginFileNotEnoughMemoryToStart
Definition: AkMonitorError.h:240
AK::Monitor::ErrorCode_NoDefaultSwitch
@ ErrorCode_NoDefaultSwitch
Definition: AkMonitorError.h:353
AkPlayingID
AkUInt32 AkPlayingID
Playing ID.
Definition: AkTypes.h:117
AK::Monitor::ErrorCode_FileFormatMismatch
@ ErrorCode_FileFormatMismatch
Definition: AkMonitorError.h:160
AK::Monitor::ErrorCode_PlayFailed
@ ErrorCode_PlayFailed
Definition: AkMonitorError.h:113
AK::Monitor::ErrorCode_PluginNotRegistered
@ ErrorCode_PluginNotRegistered
Definition: AkMonitorError.h:133
AK::Monitor::ErrorCode_ExternalSourceNoMemorySize
@ ErrorCode_ExternalSourceNoMemorySize
Definition: AkMonitorError.h:214
AK::Monitor::ErrorCode_AudioThreadResumed
@ ErrorCode_AudioThreadResumed
Definition: AkMonitorError.h:306
AK::Monitor::ErrorCode_IncompatibleBankVersion
@ ErrorCode_IncompatibleBankVersion
Definition: AkMonitorError.h:275
AK::Monitor::ErrorCode_PluginAllocationFailed
@ ErrorCode_PluginAllocationFailed
Definition: AkMonitorError.h:94
AK::Monitor::ErrorCode_SwitchListEmpty
@ ErrorCode_SwitchListEmpty
Definition: AkMonitorError.h:356
AK::Monitor::ErrorCode_XboxACPError
@ ErrorCode_XboxACPError
Definition: AkMonitorError.h:292
AK::Monitor::ErrorCode_GameObjectNeverRegistered
@ ErrorCode_GameObjectNeverRegistered
Definition: AkMonitorError.h:155
AK::Monitor::ErrorCode_SpatialAudio_PortalNotFound
@ ErrorCode_SpatialAudio_PortalNotFound
Definition: AkMonitorError.h:317
AK::Monitor::ErrorCode_SeekAfterEndOfPlaylist
@ ErrorCode_SeekAfterEndOfPlaylist
Definition: AkMonitorError.h:171
AK::Monitor::ErrorCode_CannotInitializePassthrough
@ ErrorCode_CannotInitializePassthrough
Definition: AkMonitorError.h:325
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