Wwise SDK 2021.1.14
_ak_monitor_error_8h_source
Version
menu_open
link
AkMonitorError.h
Go to the documentation of this file.
50 };
178 ErrorCode_HwVoicesSystemInitFailed, // When the hardware-accelerated subsystem fails to initialize
179 ErrorCode_HwVoicesDecodeBatchFailed, // When a grouping of hardware-accelerated voices fail to decode collectively
181 ErrorCode_HwVoiceInitFailed, // A hardware-accelerated voice fails to be created, but not because the max number of voices was reached
206 };
218 ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
219 AkPlayingID in_playingID, ///< Related Playing ID if applicable, AK_INVALID_PLAYING_ID otherwise
220 AkGameObjectID in_gameObjID ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
233 ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
235 AkGameObjectID in_gameObjID = AK_INVALID_GAME_OBJECT, ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
236 AkUniqueID in_audioNodeID = AK_INVALID_UNIQUE_ID, ///< Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise
240 /// Post a unicode monitoring message or error string. This will be displayed in the Wwise capture
248 ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
250 AkGameObjectID in_gameObjID = AK_INVALID_GAME_OBJECT, ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
251 AkUniqueID in_audioNodeID = AK_INVALID_UNIQUE_ID, ///< Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise
263 ErrorLevel in_eErrorLevel, ///< Specifies whether it should be displayed as a message or an error
265 AkGameObjectID in_gameObjID = AK_INVALID_GAME_OBJECT, ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
266 AkUniqueID in_audioNodeID = AK_INVALID_UNIQUE_ID, ///< Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise
275 AkUInt32 in_uErrorLevel = ErrorLevel_All, ///< ErrorLevel(s) to enable in output. Default parameters enable all.
276 LocalOutputFunc in_pMonitorFunc = 0 ///< Handler for local output. If NULL, the standard platform debug output method is used.
350 AKTEXT("Not enough memory in I/O pool to start stream"), // ErrorCode_CannotStartStreamNoMemory,
354 AKTEXT("Plug-in unsupported channel configuration"), // ErrorCode_PluginUnsupportedChannelConfiguration,
361 AKTEXT("Seek table is not present, or seek table granularity is larger than the maximum decode buffer size. Conversion settings may need to be updated."), // ErrorCode_VorbisSeekTableRecommended,
372 AKTEXT("File header too large (due to markers or envelope)"), // ErrorCode_AudioFileHeaderTooLarge,
375 AKTEXT("Transition not sample-accurate due to mixed channel configurations"), // ErrorCode_TransitionNotAccurateChannel,
376 AKTEXT("Transition not sample-accurate due to incompatible audio formats"), // ErrorCode_TransitionNotAccuratePluginMismatch,
377 AKTEXT("Transition not sample-accurate due to incompatible encoding parameters"), // ErrorCode_TransitionNotAccurateRejectedByPlugin
378 AKTEXT("Transition not sample-accurate due to source starvation"), // ErrorCode_TransitionNotAccurateStarvation,
379 AKTEXT("Transition not sample-accurate due to codec internal error"), // ErrorCode_TransitionNotAccurateCodecError,
381 AKTEXT("Play Failed"), // ErrorCode_PlayFailed, // Notification meaning the play asked was not done for an out of control reason
384 AKTEXT("Stinger could not be scheduled in this segment or was dropped"), // ErrorCode_StingerCouldNotBeScheduled,
385 AKTEXT("Segment look-ahead plus pre-entry duration is longer than previous segment in sequence"), // ErrorCode_TooLongSegmentLookAhead,
386 AKTEXT("Cannot schedule music switch transition in upcoming segments: using Exit Cue"), // ErrorCode_CannotScheduleMusicSwitch,
387 AKTEXT("Cannot schedule music segments: Stopping music"), // ErrorCode_TooManySimultaneousMusicSegments,
388 AKTEXT("Music system is stopped because a music playlist is modified"), // ErrorCode_PlaylistStoppedForEditing
389 AKTEXT("Rescheduling music clips because a track was modified"), // ErrorCode_MusicClipsRescheduledAfterTrackEdit
393 AKTEXT("Error while computing virtual source elapsed time"), // ErrorCode_CannotPlaySource_TimeSkip,
400 AKTEXT("Invalid XMA data - Make sure data is allocated from APU memory and is aligned to 2K."), // ErrorCode_InvalidXMAData
404 AKTEXT("Plug-in version doesn't match sound engine version. Please ensure the plug-in is compatible with this version of Wwise"), //ErrorCode_PluginVersionMismatch
414 AKTEXT("Selected node not available. Make sure the structure associated to the event is loaded or that the event has been prepared"), // ErrorCode_SelectedNodeNotAvailablePlay,
426 AKTEXT("Cannot seek in sound that is within a continuous container with special transitions"), // ErrorCode_CannotSeekContinuous
429 AKTEXT("Unknown game object ID. Make sure the game object is registered before using it and do not use it once it was unregistered."), // ErrorCode_UnknownGameObject,
431 AKTEXT("Unknown emitter game object ID. Make sure the game object is registered before using it and do not use it once it was unregistered."), // ErrorCode_UnknownEmitter,
432 AKTEXT("Unknown listener game object ID. Make sure the game object is registered before using it and do not use it once it was unregistered."), // ErrorCode_UnknownListener,
436 AKTEXT("Unknown emitter game object ID on event. Make sure the game object is registered before using it and do not use it once it was unregistered."), // ErrorCode_UnknownGameObjectEvent
437 AKTEXT("The requested game object for an event was not registered as an emitter. Make sure the game object is registered as an emitter before using it to post an event."), // ErrorCode_GameObjectIsNotEmitterEvent
441 AKTEXT("Audio command queue is full, blocking caller. Reduce number of calls to sound engine or boost command queue memory."), // ErrorCode_CommandQueueFull
442 AKTEXT("Audio command is too large to fit in the command queue. Break the command in smaller pieces."), //ErrorCode_CommandTooLarge
444 AKTEXT("Failed creating XMA decoder: no more XMA voices available"), // ErrorCode_XMACreateDecoderLimitReached
445 AKTEXT("Failed seeking in XMA source: stream buffer is smaller than XMA block size"), // ErrorCode_XMAStreamBufferTooSmall
447 AKTEXT("Triggered a note-scoped or playing-instance-scoped modulator in a global context (such as a bus or bus effect). Modulator will have global scope."), // ErrorCode_ModulatorScopeError_Inst
448 AKTEXT("Triggered a game-object-scoped modulator in a global context (such as a bus or bus effect). Modulator will have global scope."), // ErrorCode_ModulatorScopeError_Obj
452 AKTEXT("Seek table required to seek in Opus sources. Please update conversion settings."), // ErrorCode_OpusRequireSeekTable,
458 AKTEXT("Number of Resume and/or Play-From-Beginning virtual voices has reached warning limit (see Project Settings > Log tab). There may be some infinite, leaked voices."), // ErrorCode_VirtualVoiceLimit
460 AKTEXT("AK::SoundEngine::AddOutput()/ReplaceOutput() - Device ShareSet not found in Init bank."), //ErrorCode_AudioDeviceShareSetNotFound
465 AKTEXT("The Output Device specified by AddOutput() or Init() could not be initialized."), //ErrorCode_AudioDeviceInitFailure
466 AKTEXT("ReplaceOutput could not properly remove old output device."), // ErrorCode_AudioDeviceRemoveFailure
468 AKTEXT("Device ID not recognized by platform or is disabled."), // ErrorCode_AudioDeviceNotValid
469 AKTEXT("Early reflections are not supported on sounds using 3D Position: Listener with Automation. The assigned early reflections bus will be ignored."), // ErrorCode_SpatialAudio_ListenerAutomationNotSupported
470 AKTEXT("Duplicated media has different length in two separate banks. Stopping sound."), // ErrorCode_MediaDuplicationLength
472 AKTEXT("The hardware-accelerated voice subsystem failed to initialize."), // ErrorCode_HwVoicesSystemInitFailed
474 AKTEXT("Maximum number of hardware-accelerated voices reached. Voice will not play."), // ErrorCode_HwVoiceLimitReached
478 AKTEXT("Non-empty array of listeners specified for AddOutput() but uNumListeners is set to zero."), // ErrorCode_AddOutputListenerIdWithZeroListeners
480 AKTEXT("3D audio object limit exceeded; object will be mixed."), // ErrorCode_3DObjectLimitExceeded
482 AKTEXT("AkInitSettings::uNumSamplesPerFrame value unsupported by XAPU, hardware decoding not available. Supported size: 256, 512 and 1024."), //ErrorCode_OpusHWUnavailable
483 AKTEXT("Fatal XAPU failure, Opus sounds will glitch while it is being reset."), //ErrorCode_OpusFatalError
486 AKTEXT("Another process is using Microsoft Spatial Sound objects. Some audio objects may be mixed."), //ErrorCode_SystemAudioObjectsUnavailable
488 AKTEXT("AddOutput() needs unique Listeners for multi-instance outputs using the same shareset."), //ErrorCode_AddOutputNoDistinctListener
490 AKTEXT("Plug-in does not support Audio Objects bus configuration."), //ErrorCode_PluginCannotRunOnObjectConfig
491 AKTEXT("The playing sound is assigned the same early reflection bus in the Authoring Tool that has been set via AK::SpatialAudio::SetImageSource. Use a unique bus to avoid image source conflicts."), //ErrorCode_SpatialAudio_ReflectionBusError
492 AKTEXT("Vorbis Hardware Acceleration library not found. Source will be decoded in software."), // ErrorCode_VorbisHWDecodeUnavailable
495 static_assert((sizeof(s_aszErrorCodes) / sizeof(s_aszErrorCodes[0])) == AK::Monitor::Num_ErrorCodes, "ARRAYSIZE(AK::Monitor::s_aszErrorCodes) is not matching AK::Monitor::Num_ErrorCodes, make sure they are maintained at the same time.");
@ ErrorCode_CannotScheduleMusicSwitch
Definition: AkMonitorError.h:92
@ ErrorCode_FeedbackVoiceStarving
Definition: AkMonitorError.h:122
@ ErrorCode_OpusCreateDecoderFailed
Definition: AkMonitorError.h:159
@ ErrorCode_3DObjectLimitExceeded
Definition: AkMonitorError.h:187
@ ErrorCode_PluginProcessingFailed
Definition: AkMonitorError.h:64
void(* LocalOutputFunc)(ErrorCode in_eErrorCode, const AkOSChar *in_pszError, ErrorLevel in_eErrorLevel, AkPlayingID in_playingID, AkGameObjectID in_gameObjID)
Function prototype of local output function pointer.
Definition: AkMonitorError.h:215
@ ErrorCode_TooLongSegmentLookAhead
Definition: AkMonitorError.h:91
@ ErrorCode_StreamingSourceStarving
Definition: AkMonitorError.h:103
@ ErrorCode_PluginUnsupportedChannelConfiguration
Definition: AkMonitorError.h:61
V1::Notifications::Monitor Monitor
Latest version of the C++ Monitor notification interface.
Definition: Notifications.h:204
@ ErrorCode_TooManySimultaneousMusicSegments
Definition: AkMonitorError.h:93
@ ErrorCode_CannotStartStreamNoMemory
Definition: AkMonitorError.h:57
@ ErrorCode_SpatialAudio_ListenerAutomationNotSupported
Definition: AkMonitorError.h:175
@ ErrorCode_CannotSeekContinuous
Definition: AkMonitorError.h:132
@ ErrorCode_ATRAC9LoopSectionTooSmall
Definition: AkMonitorError.h:76
@ ErrorCode_PluginVersionMismatch
Definition: AkMonitorError.h:110
@ ErrorCode_AudioFileHeaderTooLarge
Definition: AkMonitorError.h:79
AKSOUNDENGINE_API AKRESULT SetLocalOutput(AkUInt32 in_uErrorLevel=ErrorLevel_All, LocalOutputFunc in_pMonitorFunc=0)
@ ErrorCode_PluginInitialisationFailed
Definition: AkMonitorError.h:63
@ ErrorCode_HwVoiceLimitReached
Definition: AkMonitorError.h:180
@ ErrorCode_PlaylistStoppedForEditing
Definition: AkMonitorError.h:94
@ ErrorCode_SelectedChildNotAvailable
Definition: AkMonitorError.h:115
@ ErrorCode_ModulatorScopeError_Inst
Definition: AkMonitorError.h:152
@ ErrorCode_TransitionNotAccurateChannel
Definition: AkMonitorError.h:82
@ ErrorCode_IncompatibleIOSettings
Definition: AkMonitorError.h:59
@ ErrorCode_InsufficientSpaceToLoadBank
Definition: AkMonitorError.h:127
@ ErrorCode_CannotPlaySource_VirtualOff
Definition: AkMonitorError.h:98
@ ErrorCode_MediaDuplicationLength
Definition: AkMonitorError.h:176
@ ErrorCode_CannotPlaySource_Create
Definition: AkMonitorError.h:97
@ ErrorCode_BankUnloadFailed
Definition: AkMonitorError.h:125
AKSOUNDENGINE_API void MonitorStreamingDeviceInit(AkDeviceID in_deviceID, const AkDeviceSettings &in_deviceSettings)
Definition: AkStreamMgrModule.h:62
@ ErrorCode_StingerCouldNotBeScheduled
Definition: AkMonitorError.h:90
const AkOSChar * s_aszErrorCodes[Num_ErrorCodes]
@ ErrorCode_XMAStreamBufferTooSmall
Definition: AkMonitorError.h:150
@ ErrorCode_ModulatorScopeError_Obj
Definition: AkMonitorError.h:153
@ ErrorCode_UnknownGameObjectEvent
Definition: AkMonitorError.h:140
@ ErrorCode_AudioDeviceRemoveFailure
Definition: AkMonitorError.h:171
AKSOUNDENGINE_API void MonitorStreamMgrTerm()
@ ErrorCode_AudioDeviceShareSetNotFound
Definition: AkMonitorError.h:165
@ ErrorCode_GameObjectIsNotEmitterEvent
Definition: AkMonitorError.h:141
@ ErrorCode_ExternalSourceNotResolved
Definition: AkMonitorError.h:143
@ ErrorCode_TransitionNotAccuratePluginMismatch
Definition: AkMonitorError.h:83
@ ErrorCode_TransitionNotAccurateStarvation
Definition: AkMonitorError.h:85
@ ErrorCode_xWMACreateDecoderFailed
Definition: AkMonitorError.h:73
@ ErrorCode_TransitionNotAccurateRejectedByPlugin
Definition: AkMonitorError.h:84
@ ErrorCode_VorbisSeekTableRecommended
Definition: AkMonitorError.h:68
@ ErrorCode_CommandQueueFull
Definition: AkMonitorError.h:146
@ ErrorCode_HwVoicesSystemInitFailed
Definition: AkMonitorError.h:178
@ ErrorCode_VorbisHWDecodeUnavailable
Definition: AkMonitorError.h:200
@ ErrorCode_XMADecoderSourceStarving
Definition: AkMonitorError.h:104
@ ErrorCode_NotEnoughMemoryToStart
Definition: AkMonitorError.h:167
@ ErrorCode_ErrorWhileLoadingBank
Definition: AkMonitorError.h:126
AKSOUNDENGINE_API AkTimeMs GetTimeStamp()
@ ErrorCode_AudioDeviceNotFound
Definition: AkMonitorError.h:172
@ ErrorCode_PluginMediaUnavailable
Definition: AkMonitorError.h:62
@ ErrorCode_GameObjectIsNotListener
Definition: AkMonitorError.h:138
@ ErrorCode_OpusRequireSeekTable
Definition: AkMonitorError.h:157
@ ErrorCode_AudioDeviceNotValid
Definition: AkMonitorError.h:173
@ ErrorCode_SpatialAudio_ReflectionBusError
Definition: AkMonitorError.h:198
@ ErrorCode_CannotPlaySource_InconsistentState
Definition: AkMonitorError.h:100
@ ErrorCode_SelectedNodeNotAvailable
Definition: AkMonitorError.h:116
@ ErrorCode_SelectedNodeNotAvailablePlay
Definition: AkMonitorError.h:120
@ ErrorCode_XMADecodingError
Definition: AkMonitorError.h:105
@ ErrorCode_OpusHWFatalError
Definition: AkMonitorError.h:190
@ ErrorCode_PluginCannotRunOnObjectConfig
Definition: AkMonitorError.h:197
@ ErrorCode_XMACreateDecoderLimitReached
Definition: AkMonitorError.h:149
AKSOUNDENGINE_API void MonitorStreamMgrInit(const AkStreamMgrSettings &in_streamMgrSettings)
Add the streaming manager settings to the profiler capture.
@ ErrorCode_GameObjectIsNotEmitter
Definition: AkMonitorError.h:139
@ ErrorCode_HwVoiceInitFailed
Definition: AkMonitorError.h:181
@ ErrorCode_OpusHWDecodeUnavailable
Definition: AkMonitorError.h:189
@ ErrorCode_InvalidAudioFileHeader
Definition: AkMonitorError.h:78
@ ErrorCode_LowerEngineCommandListFull
Definition: AkMonitorError.h:129
@ ErrorCode_CannotPlaySource_TimeSkip
Definition: AkMonitorError.h:99
@ ErrorCode_SelectedMediaNotAvailable
Definition: AkMonitorError.h:117
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
Definition: AkTypes.h:101
@ ErrorCode_VirtualVoiceLimit
Definition: AkMonitorError.h:163
@ ErrorCode_PluginExecutionInvalid
Definition: AkMonitorError.h:65
@ ErrorCode_TransitionNotAccurateCodecError
Definition: AkMonitorError.h:86
@ ErrorCode_AudioDeviceInitFailure
Definition: AkMonitorError.h:170
AKSOUNDENGINE_API void MonitorStreamingDeviceDestroyed(AkDeviceID in_deviceID)
@ ErrorCode_SystemAudioObjectsUnavailable
Definition: AkMonitorError.h:193
@ ErrorCode_AddOutputListenerIdWithZeroListeners
Definition: AkMonitorError.h:185
@ ErrorCode_CodecNotRegistered
Definition: AkMonitorError.h:109
@ ErrorCode_UnknownGameObject
Definition: AkMonitorError.h:135
@ ErrorCode_HwVoicesDecodeBatchFailed
Definition: AkMonitorError.h:179
@ ErrorCode_SourcePluginNotFound
Definition: AkMonitorError.h:161
AKSOUNDENGINE_API AKRESULT PostCode(ErrorCode in_eError, ErrorLevel in_eErrorLevel, AkPlayingID in_playingID=AK_INVALID_PLAYING_ID, AkGameObjectID in_gameObjID=AK_INVALID_GAME_OBJECT, AkUniqueID in_audioNodeID=AK_INVALID_UNIQUE_ID, bool in_bIsBus=false)
@ ErrorCode_MusicClipsRescheduledAfterTrackEdit
Definition: AkMonitorError.h:95
@ ErrorCode_AddOutputNoDistinctListener
Definition: AkMonitorError.h:195
@ ErrorCode_ATRAC9DecodeFailed
Definition: AkMonitorError.h:75
Definition: AkStreamMgrModule.h:53
@ ErrorCode_VorbisDecodeError
Definition: AkMonitorError.h:70
@ ErrorCode_OpusHWCommandFailed
Definition: AkMonitorError.h:183
@ ErrorCode_FileFormatMismatch
Definition: AkMonitorError.h:144
@ ErrorCode_PluginNotRegistered
Definition: AkMonitorError.h:108
@ ErrorCode_PluginAllocationFailed
Definition: AkMonitorError.h:66
@ ErrorCode_SeekAfterEndOfPlaylist
Definition: AkMonitorError.h:155
AKSOUNDENGINE_API AKRESULT PostString(const char *in_pszError, ErrorLevel in_eErrorLevel, AkPlayingID in_playingID=AK_INVALID_PLAYING_ID, AkGameObjectID in_gameObjID=AK_INVALID_GAME_OBJECT, AkUniqueID in_audioNodeID=AK_INVALID_UNIQUE_ID, bool in_bIsBus=false)
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support 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