Wwise SDK 2022.1.8
_ak_monitor_error_8h_source
Version
menu_open
link
AkMonitorError.h
Go to the documentation of this file.
47 MsgContext(AkPlayingID pId = AK_INVALID_PLAYING_ID, AkGameObjectID goId = AK_INVALID_GAME_OBJECT, AkUniqueID nodeId = AK_INVALID_UNIQUE_ID, bool isBus = false)
55 AkGameObjectID in_gameObjID; ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
78 };
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
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
194 ErrorCode_HwVoiceInitFailed, // A hardware-accelerated voice fails to be created, but not because the max number of voices was reached
363 };
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
383 /// log. Since this function doesn't send variable arguments, be sure that the error code you're posting doesn't contain any tag.
391 ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
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
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
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
418 /// Post a unicode monitoring message or error string. This will be displayed in the Wwise capture
426 ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
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
443 ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
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
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.
465 AkErrorMessageTranslator* translator, ///< The AkErrorMessageTranslator to add to the WwiseErrorHandler
@ ErrorCode_CannotScheduleMusicSwitch
Definition: AkMonitorError.h:117
@ ErrorCode_FailedPostingEvent
Definition: AkMonitorError.h:234
@ ErrorCode_SoundEnginePlayingIdNotFound
Definition: AkMonitorError.h:260
@ ErrorCode_AmbisonicNotAvailable
Definition: AkMonitorError.h:327
AKSOUNDENGINE_API AKRESULT PostCodeVaList(ErrorCode in_eError, ErrorLevel in_eErrorLevel, MsgContext msgContext, ::va_list args)
@ ErrorCode_PendingActionDestroyed
Definition: AkMonitorError.h:247
@ ErrorCode_3DObjectLimitExceeded
Definition: AkMonitorError.h:200
@ ErrorCode_SetPortalInvalidExtent
Definition: AkMonitorError.h:316
AkGameObjectID in_gameObjID
Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise.
Definition: AkMonitorError.h:55
@ ErrorCode_MusicEngineNotInitialized
Definition: AkMonitorError.h:277
@ ErrorCode_PluginProcessingFailed
Definition: AkMonitorError.h:92
@ ErrorCode_NXDeviceRegistrationFailed
Definition: AkMonitorError.h:286
@ ErrorCode_SetGeometryInstanceFailed
Definition: AkMonitorError.h:300
@ ErrorCode_ResetPlaylistActionIgnoredGlobalScope
Definition: AkMonitorError.h:307
void(* LocalOutputFunc)(ErrorCode in_eErrorCode, const AkOSChar *in_pszError, ErrorLevel in_eErrorLevel, AkPlayingID in_playingID, AkGameObjectID in_gameObjID)
Function prototype of local output function pointer.
Definition: AkMonitorError.h:372
@ ErrorCode_TooLongSegmentLookAhead
Definition: AkMonitorError.h:116
@ ErrorCode_StreamingSourceStarving
Definition: AkMonitorError.h:128
@ ErrorCode_PluginUnsupportedChannelConfiguration
Definition: AkMonitorError.h:89
@ ErrorCode_RevertingToDefaultAudioDevice
Definition: AkMonitorError.h:303
@ ErrorCode_CrossFadeTransitionIgnored
Definition: AkMonitorError.h:248
V1::Notifications::Monitor Monitor
Latest version of the C++ Monitor notification interface.
Definition: Notifications.h:203
@ ErrorCode_PluginFileRegisterFailed
Definition: AkMonitorError.h:242
@ ErrorCode_TooManySimultaneousMusicSegments
Definition: AkMonitorError.h:118
@ ErrorCode_CannotStartStreamNoMemory
Definition: AkMonitorError.h:85
@ ErrorCode_JobMgrOutOfMemory
Definition: AkMonitorError.h:222
@ ErrorCode_SoundEngineCantCallOnChildBus
Definition: AkMonitorError.h:259
@ ErrorCode_UnknownDialogueEvent
Definition: AkMonitorError.h:233
@ ErrorCode_SpatialAudio_ListenerAutomationNotSupported
Definition: AkMonitorError.h:188
@ ErrorCode_XboxXMAFatalError
Definition: AkMonitorError.h:293
MonitorErrorInfo(const AkOSChar *in_name=nullptr, const AkOSChar *in_message=nullptr)
Definition: AkMonitorError.h:62
@ ErrorCode_CannotSeekContinuous
Definition: AkMonitorError.h:151
@ ErrorCode_InvalidFloatInFunction
Definition: AkMonitorError.h:320
@ ErrorCode_ATRAC9LoopSectionTooSmall
Definition: AkMonitorError.h:101
Definition: AkMonitorError.h:61
@ ErrorCode_TranslatorWwiseTagTest
Definition: AkMonitorError.h:336
@ ErrorCode_SoundLoadFailedInsufficientMemory
Definition: AkMonitorError.h:285
AKSOUNDENGINE_API AKRESULT AddTranslator(AkErrorMessageTranslator *translator, bool overridePreviousTranslators=false)
@ ErrorCode_HardwareOpusDecoderError
Definition: AkMonitorError.h:295
@ ErrorCode_PluginVersionMismatch
Definition: AkMonitorError.h:135
@ ErrorCode_AudioFileHeaderTooLarge
Definition: AkMonitorError.h:104
AKSOUNDENGINE_API AKRESULT SetLocalOutput(AkUInt32 in_uErrorLevel=ErrorLevel_All, LocalOutputFunc in_pMonitorFunc=0)
@ ErrorCode_UnknownOpusError
Definition: AkMonitorError.h:181
@ ErrorCode_RevertingToDummyAudioDevice
Definition: AkMonitorError.h:304
@ ErrorCode_MasterBusStructureNotLoaded
Definition: AkMonitorError.h:280
@ ErrorCode_PluginInitialisationFailed
Definition: AkMonitorError.h:91
@ ErrorCode_MonitorMsgTooLarge
Definition: AkMonitorError.h:217
@ ErrorCode_PlayingTriggerRateNotSupported
Definition: AkMonitorError.h:309
@ ErrorCode_HwVoiceLimitReached
Definition: AkMonitorError.h:193
@ ErrorCode_PlaylistStoppedForEditing
Definition: AkMonitorError.h:119
@ ErrorCode_AudioThreadSuspended
Definition: AkMonitorError.h:305
@ ErrorCode_ModulatorScopeError_Inst
Definition: AkMonitorError.h:168
@ ErrorCode_SoundEngineTooManyPositions
Definition: AkMonitorError.h:258
@ ErrorCode_TransitionNotAccurateChannel
Definition: AkMonitorError.h:107
@ ErrorCode_SetGeometryInstanceInvalidTransform
Definition: AkMonitorError.h:311
@ ErrorCode_AudioSubsystemStoppedResponding
Definition: AkMonitorError.h:264
@ ErrorCode_IncompatibleIOSettings
Definition: AkMonitorError.h:87
@ ErrorCode_InsufficientSpaceToLoadBank
Definition: AkMonitorError.h:146
@ ErrorCode_AudioNodeNotFound
Definition: AkMonitorError.h:269
@ ErrorCode_CannotPlaySource_VirtualOff
Definition: AkMonitorError.h:123
@ ErrorCode_ResetPlaylistActionIgnoredContinuous
Definition: AkMonitorError.h:308
@ ErrorCode_MediaDuplicationLength
Definition: AkMonitorError.h:189
@ ErrorCode_CannotPlaySource_Create
Definition: AkMonitorError.h:122
@ ErrorCode_InvalidParameter
Definition: AkMonitorError.h:339
AKSOUNDENGINE_API void MonitorStreamingDeviceInit(AkDeviceID in_deviceID, const AkDeviceSettings &in_deviceSettings)
@ ErrorCode_MemoryAllocationFailed
Definition: AkMonitorError.h:283
Definition: AkStreamMgrModule.h:61
@ ErrorCode_StingerCouldNotBeScheduled
Definition: AkMonitorError.h:115
@ ErrorCode_XMAStreamBufferTooSmall
Definition: AkMonitorError.h:166
@ ErrorCode_ModulatorScopeError_Obj
Definition: AkMonitorError.h:169
@ ErrorCode_SetGeometryTooManyTriangleConnected
Definition: AkMonitorError.h:296
@ ErrorCode_AudioDeviceRemoveFailure
Definition: AkMonitorError.h:184
@ ErrorCode_MissingMusicNodeParent
Definition: AkMonitorError.h:294
AKSOUNDENGINE_API void MonitorStreamMgrTerm()
@ ErrorCode_UnloadBankFailed
Definition: AkMonitorError.h:236
@ ErrorCode_RemovingGeometrySetFailed
Definition: AkMonitorError.h:299
@ ErrorCode_TransitionNotAccurateSourceTooShort
Definition: AkMonitorError.h:346
@ ErrorCode_PluginFileInvalid
Definition: AkMonitorError.h:241
@ ErrorCode_TranslatorStringSizeTest
Definition: AkMonitorError.h:337
AkUniqueID in_soundID
Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise.
Definition: AkMonitorError.h:56
@ ErrorCode_AudioDeviceShareSetNotFound
Definition: AkMonitorError.h:254
@ ErrorCode_NonCompliantDeviceMemory
Definition: AkMonitorError.h:219
@ ErrorCode_ExternalSourceNotResolved
Definition: AkMonitorError.h:159
@ ErrorCode_TransitionNotAccuratePluginMismatch
Definition: AkMonitorError.h:108
@ ErrorCode_DynamicSequenceIdNotFound
Definition: AkMonitorError.h:252
@ ErrorCode_TranslatorStandardTagTest
Definition: AkMonitorError.h:335
@ ErrorCode_TransitionNotAccurateStarvation
Definition: AkMonitorError.h:110
@ ErrorCode_PluginMsgWithShareSet
Definition: AkMonitorError.h:351
@ ErrorCode_MusicRendererSeekingFailed
Definition: AkMonitorError.h:249
@ ErrorCode_InvalidFloatPriority
Definition: AkMonitorError.h:284
@ ErrorCode_SoundEngineNotInit
Definition: AkMonitorError.h:352
@ ErrorCode_SetGeometryTriangleTooLarge
Definition: AkMonitorError.h:297
@ ErrorCode_SetBusConfigUnsupported
Definition: AkMonitorError.h:271
@ ErrorCode_TransitionNotAccurateRejectedByPlugin
Definition: AkMonitorError.h:109
@ ErrorCode_AudioOutOfRangeOnBusFx
Definition: AkMonitorError.h:231
@ ErrorCode_MixPluginOnObjectBus
Definition: AkMonitorError.h:287
@ ErrorCode_AlreadyInitialized
Definition: AkMonitorError.h:348
@ ErrorCode_SetGeometryFailed
Definition: AkMonitorError.h:298
@ ErrorCode_VorbisSeekTableRecommended
Definition: AkMonitorError.h:96
@ ErrorCode_NotEnoughSystemObjWin
Definition: AkMonitorError.h:344
@ ErrorCode_NotEnoughMemInFunction
Definition: AkMonitorError.h:266
AKSOUNDENGINE_API AKRESULT PostCodeVarArg(ErrorCode in_eError, ErrorLevel in_eErrorLevel, MsgContext msgContext,...)
@ ErrorCode_CommandQueueFull
Definition: AkMonitorError.h:162
@ ErrorCode_HwVoicesSystemInitFailed
Definition: AkMonitorError.h:191
@ ErrorCode_VorbisHWDecodeUnavailable
Definition: AkMonitorError.h:213
@ ErrorCode_XMADecoderSourceStarving
Definition: AkMonitorError.h:129
@ ErrorCode_NotEnoughMemoryToStart
Definition: AkMonitorError.h:180
@ ErrorCode_ErrorWhileLoadingBank
Definition: AkMonitorError.h:145
@ ErrorCode_RemovingGeometryInstanceFailed
Definition: AkMonitorError.h:301
AKSOUNDENGINE_API AkTimeMs GetTimeStamp()
@ ErrorCode_AudioDeviceNotFound
Definition: AkMonitorError.h:185
@ ErrorCode_PluginMediaUnavailable
Definition: AkMonitorError.h:90
@ ErrorCode_WrongNumberOfArguments
Definition: AkMonitorError.h:349
MsgContext(AkPlayingID pId=AK_INVALID_PLAYING_ID, AkGameObjectID goId=AK_INVALID_GAME_OBJECT, AkUniqueID nodeId=AK_INVALID_UNIQUE_ID, bool isBus=false)
Definition: AkMonitorError.h:47
@ ErrorCode_SoundEngineInvalidTransform
Definition: AkMonitorError.h:261
const MonitorErrorInfo s_aszMonitorErrorInfos[Num_ErrorCodes]
Definition: AkMonitorErrorImpl.h:37
@ ErrorCode_SetPortalNonDistinctRoom
Definition: AkMonitorError.h:315
@ ErrorCode_CantSetBoundSwitch
Definition: AkMonitorError.h:354
@ ErrorCode_PluginFileNotFound
Definition: AkMonitorError.h:238
@ ErrorCode_OpusRequireSeekTable
Definition: AkMonitorError.h:173
@ ErrorCode_AudioDeviceNotValid
Definition: AkMonitorError.h:186
@ ErrorCode_IODeviceInitFailed
Definition: AkMonitorError.h:355
@ ErrorCode_OutputDeviceInitializationFailed
Definition: AkMonitorError.h:235
@ ErrorCode_SpatialAudio_ReflectionBusError
Definition: AkMonitorError.h:211
@ ErrorCode_CannotPlaySource_InconsistentState
Definition: AkMonitorError.h:125
@ ErrorCode_SelectedNodeNotAvailable
Definition: AkMonitorError.h:140
@ ErrorCode_SetGameObjectRadiusSizeError
Definition: AkMonitorError.h:314
@ ErrorCode_SetGeometryTriangleIsSkipped
Definition: AkMonitorError.h:310
@ ErrorCode_XMADecodingError
Definition: AkMonitorError.h:130
@ ErrorCode_OpusHWFatalError
Definition: AkMonitorError.h:202
@ ErrorCode_PluginCannotRunOnObjectConfig
Definition: AkMonitorError.h:210
@ ErrorCode_CannotInitializeAmbisonicChannelConfiguration
Definition: AkMonitorError.h:324
@ ErrorCode_XboxFrameDropped
Definition: AkMonitorError.h:291
@ ErrorCode_XMACreateDecoderLimitReached
Definition: AkMonitorError.h:165
AKSOUNDENGINE_API void MonitorStreamMgrInit(const AkStreamMgrSettings &in_streamMgrSettings)
Add the streaming manager settings to the profiler capture.
@ ErrorCode_GameObjectIsNotEmitter
Definition: AkMonitorError.h:157
@ ErrorCode_HwVoiceInitFailed
Definition: AkMonitorError.h:194
@ ErrorCode_XboxXMAVoiceResetFailed
Definition: AkMonitorError.h:289
@ ErrorCode_OpusHWDecodeUnavailable
Definition: AkMonitorError.h:203
@ ErrorCode_InvalidAudioFileHeader
Definition: AkMonitorError.h:103
@ ErrorCode_JobWorkerFuncCallMismatch
Definition: AkMonitorError.h:221
@ ErrorCode_LowerEngineCommandListFull
Definition: AkMonitorError.h:148
@ ErrorCode_AudioOutOfRangeRay
Definition: AkMonitorError.h:232
@ ErrorCode_DynamicSequenceAlreadyClosed
Definition: AkMonitorError.h:246
@ ErrorCode_CannotPlaySource_TimeSkip
Definition: AkMonitorError.h:124
@ ErrorCode_SelectedMediaNotAvailable
Definition: AkMonitorError.h:141
@ ErrorCode_PluginFileIncompatible
Definition: AkMonitorError.h:239
@ ErrorCode_NotEnoughSystemObj
Definition: AkMonitorError.h:343
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
Definition: AkTypes.h:162
@ ErrorCode_VirtualVoiceLimit
Definition: AkMonitorError.h:178
@ ErrorCode_PluginExecutionInvalid
Definition: AkMonitorError.h:93
@ ErrorCode_SoundEngineTooManyEventPosts
Definition: AkMonitorError.h:262
@ ErrorCode_TransitionNotAccurateCodecError
Definition: AkMonitorError.h:111
@ ErrorCode_AudioDeviceInitFailure
Definition: AkMonitorError.h:183
@ ErrorCode_AudioOutOfRangeOnBus
Definition: AkMonitorError.h:230
AKSOUNDENGINE_API void MonitorStreamingDeviceDestroyed(AkDeviceID in_deviceID)
@ ErrorCode_BankContainUneditableEffect
Definition: AkMonitorError.h:282
AKSOUNDENGINE_API AKRESULT ResetTranslator()
@ ErrorCode_LoadingBankMismatch
Definition: AkMonitorError.h:278
@ ErrorCode_SystemAudioObjectsUnavailable
Definition: AkMonitorError.h:206
@ ErrorCode_UnexpectedPrepareGameSyncsCall
Definition: AkMonitorError.h:276
@ ErrorCode_AddOutputListenerIdWithZeroListeners
Definition: AkMonitorError.h:198
@ ErrorCode_CodecNotRegistered
Definition: AkMonitorError.h:134
@ ErrorCode_UnknownGameObject
Definition: AkMonitorError.h:154
@ ErrorCode_HwVoicesDecodeBatchFailed
Definition: AkMonitorError.h:192
@ ErrorCode_SoundEngineTooManyGameObjects
Definition: AkMonitorError.h:257
@ ErrorCode_SourcePluginNotFound
Definition: AkMonitorError.h:176
AKSOUNDENGINE_API AKRESULT PostCode(ErrorCode in_eError, ErrorLevel in_eErrorLevel, AkPlayingID in_playingID=AK_INVALID_PLAYING_ID, AkGameObjectID in_gameObjID=AK_INVALID_GAME_OBJECT, AkUniqueID in_audioNodeID=AK_INVALID_UNIQUE_ID, bool in_bIsBus=false)
@ ErrorCode_MaxAudioObjExceeded
Definition: AkMonitorError.h:341
@ ErrorCode_FLTMAXNotSupported
Definition: AkMonitorError.h:321
@ ErrorCode_MismatchingMediaSize
Definition: AkMonitorError.h:274
Definition: AkMonitorError.h:46
@ ErrorCode_MusicClipsRescheduledAfterTrackEdit
Definition: AkMonitorError.h:120
@ ErrorCode_AddOutputNoDistinctListener
Definition: AkMonitorError.h:208
@ ErrorCode_AudioDeviceShareSetNotFoundByName
Definition: AkMonitorError.h:255
@ ErrorCode_ATRAC9DecodeFailed
Definition: AkMonitorError.h:100
@ ErrorCode_3DAudioUnsupportedSize
Definition: AkMonitorError.h:326
Definition: AkStreamMgrModule.h:52
@ ErrorCode_VorbisDecodeError
Definition: AkMonitorError.h:98
@ ErrorCode_NoSwitchSelected
Definition: AkMonitorError.h:357
@ ErrorCode_OpusHWCommandFailed
Definition: AkMonitorError.h:196
@ ErrorCode_BusNotFoundByName
Definition: AkMonitorError.h:253
@ ErrorCode_MonitorQueueFull
Definition: AkMonitorError.h:216
@ ErrorCode_PluginFileNotEnoughMemoryToStart
Definition: AkMonitorError.h:240
@ ErrorCode_FileFormatMismatch
Definition: AkMonitorError.h:160
@ ErrorCode_PluginNotRegistered
Definition: AkMonitorError.h:133
@ ErrorCode_ExternalSourceNoMemorySize
Definition: AkMonitorError.h:214
@ ErrorCode_AudioThreadResumed
Definition: AkMonitorError.h:306
@ ErrorCode_IncompatibleBankVersion
Definition: AkMonitorError.h:275
@ ErrorCode_PluginAllocationFailed
Definition: AkMonitorError.h:94
@ ErrorCode_GameObjectNeverRegistered
Definition: AkMonitorError.h:155
@ ErrorCode_SpatialAudio_PortalNotFound
Definition: AkMonitorError.h:317
@ ErrorCode_SeekAfterEndOfPlaylist
Definition: AkMonitorError.h:171
@ ErrorCode_CannotInitializePassthrough
Definition: AkMonitorError.h:325
AKSOUNDENGINE_API AKRESULT PostString(const char *in_pszError, ErrorLevel in_eErrorLevel, AkPlayingID in_playingID=AK_INVALID_PLAYING_ID, AkGameObjectID in_gameObjID=AK_INVALID_GAME_OBJECT, AkUniqueID in_audioNodeID=AK_INVALID_UNIQUE_ID, bool in_bIsBus=false)
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell 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