Go to the documentation of this file.
28Â
#ifndef _AKMONITORERROR_H
29Â
#define _AKMONITORERROR_H
209Â
"Please document your new ErrorCode "
210Â
"in 'Documentation/Help/source_en/reference/common_errors_capture_log.xml', "
211Â
"then you can increment this value."
237Â
bool in_bIsBus =
false
239Â
#ifdef AK_SUPPORT_WCHAR
247Â
const wchar_t* in_pszError,
252Â
bool in_bIsBus =
false
254Â
#endif // #ifdef AK_SUPPORT_WCHAR
262Â
const char* in_pszError,
267Â
bool in_bIsBus =
false
317Â
#ifndef AK_OPTIMIZED
318Â
#define AK_MONITOR_ERROR( in_eErrorCode ) \
319Â
AK::Monitor::PostCode( in_eErrorCode, AK::Monitor::ErrorLevel_Error )
321Â
#define AK_MONITOR_STREAM_MGR_INIT( in_streamMgrSettings ) \
322Â
AK::Monitor::MonitorStreamMgrInit( in_streamMgrSettings )
324Â
#define AK_MONITOR_STREAMING_DEVICE_INIT( in_deviceID, in_deviceSettings ) \
325Â
AK::Monitor::MonitorStreamingDeviceInit( in_deviceID, in_deviceSettings )
327Â
#define AK_MONITOR_STREAMING_DEVICE_DESTROYED( in_deviceID ) \
328Â
AK::Monitor::MonitorStreamingDeviceDestroyed( in_deviceID )
330Â
#define AK_MONITOR_STREAM_MGR_TERM( ) \
331Â
AK::Monitor::MonitorStreamMgrTerm()
333Â
#define AK_MONITOR_ERROR( in_eErrorCode )
334Â
#define AK_MONITOR_STREAM_MGR_INIT( in_streamMgrSettings )
335Â
#define AK_MONITOR_STREAMING_DEVICE_INIT( in_deviceID, in_deviceSettings )
336Â
#define AK_MONITOR_STREAMING_DEVICE_DESTROYED( in_deviceID )
337Â
#define AK_MONITOR_STREAM_MGR_TERM( )
340Â
#ifdef AK_MONITOR_IMPLEMENT_ERRORCODES
348Â
AKTEXT(
"File not found"),
349Â
AKTEXT(
"Cannot open file"),
350Â
AKTEXT(
"Not enough memory in I/O pool to start stream"),
351Â
AKTEXT(
"Unknown I/O device error"),
352Â
AKTEXT(
"I/O settings incompatible."),
354Â
AKTEXT(
"Plug-in unsupported channel configuration"),
355Â
AKTEXT(
"Plug-in media unavailable"),
356Â
AKTEXT(
"Plug-in initialization failure"),
357Â
AKTEXT(
"Plug-in execution failure"),
358Â
AKTEXT(
"Invalid plug-in execution mode"),
359Â
AKTEXT(
"Could not allocate effect"),
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."),
363Â
AKTEXT(
"Vorbis decoder failure"),
364Â
AKTEXT(
"AAC decoder failure"),
366Â
AKTEXT(
"Failed creating xWMA decoder"),
368Â
AKTEXT(
"ATRAC9 decoding failed"),
369Â
AKTEXT(
"ATRAC9 loop section is too small"),
371Â
AKTEXT(
"Invalid file header"),
372Â
AKTEXT(
"File header too large (due to markers or envelope)"),
373Â
AKTEXT(
"File or loop region is too small to be played properly"),
375Â
AKTEXT(
"Transition not sample-accurate due to mixed channel configurations"),
376Â
AKTEXT(
"Transition not sample-accurate due to incompatible audio formats"),
377Â
AKTEXT(
"Transition not sample-accurate due to incompatible encoding parameters"),
378Â
AKTEXT(
"Transition not sample-accurate due to source starvation"),
379Â
AKTEXT(
"Transition not sample-accurate due to codec internal error"),
380Â
AKTEXT(
"Nothing to play in Dynamic Sequence"),
384Â
AKTEXT(
"Stinger could not be scheduled in this segment or was dropped"),
385Â
AKTEXT(
"Segment look-ahead plus pre-entry duration is longer than previous segment in sequence"),
386Â
AKTEXT(
"Cannot schedule music switch transition in upcoming segments: using Exit Cue"),
387Â
AKTEXT(
"Cannot schedule music segments: Stopping music"),
388Â
AKTEXT(
"Music system is stopped because a music playlist is modified"),
389Â
AKTEXT(
"Rescheduling music clips because a track was modified"),
391Â
AKTEXT(
"Failed creating source"),
392Â
AKTEXT(
"Virtual source failed becoming physical"),
393Â
AKTEXT(
"Error while computing virtual source elapsed time"),
394Â
AKTEXT(
"Inconsistent source status"),
395Â
AKTEXT(
"Media was not loaded for this source"),
396Â
AKTEXT(
"Voice Starvation"),
397Â
AKTEXT(
"Source starvation"),
398Â
AKTEXT(
"XMA decoder starvation"),
399Â
AKTEXT(
"XMA decoding error"),
400Â
AKTEXT(
"Invalid XMA data - Make sure data is allocated from APU memory and is aligned to 2K."),
402Â
AKTEXT(
"Plug-in not found"),
403Â
AKTEXT(
"Codec plug-in not registered"),
404Â
AKTEXT(
"Plug-in version doesn't match sound engine version. Please ensure the plug-in is compatible with this version of Wwise"),
406Â
AKTEXT(
"Event ID not found"),
408Â
AKTEXT(
"Invalid State Group ID"),
409Â
AKTEXT(
"Selected Child Not Available"),
410Â
AKTEXT(
"Selected Node Not Available"),
411Â
AKTEXT(
"Selected Media Not Available"),
412Â
AKTEXT(
"No Valid Switch"),
414Â
AKTEXT(
"Selected node not available. Make sure the structure associated to the event is loaded or that the event has been prepared"),
416Â
AKTEXT(
"Motion voice starvation"),
418Â
AKTEXT(
"Bank Load Failed"),
419Â
AKTEXT(
"Bank Unload Failed"),
420Â
AKTEXT(
"Error while loading bank"),
421Â
AKTEXT(
"Insufficient Space to Load Bank"),
423Â
AKTEXT(
"Lower engine command list is full"),
425Â
AKTEXT(
"No marker in file; seeking to specified location"),
426Â
AKTEXT(
"Cannot seek in sound that is within a continuous container with special transitions"),
427Â
AKTEXT(
"Seeking after end of file. Playback will stop"),
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."),
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."),
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."),
433Â
AKTEXT(
"The requested game object is not a listener."),
434Â
AKTEXT(
"The requested game object is not an emitter."),
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."),
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."),
439Â
AKTEXT(
"External source missing from PostEvent call"),
440Â
AKTEXT(
"Source file is of different format than expected"),
441Â
AKTEXT(
"Audio command queue is full, blocking caller. Reduce number of calls to sound engine or boost command queue memory."),
442Â
AKTEXT(
"Audio command is too large to fit in the command queue. Break the command in smaller pieces."),
444Â
AKTEXT(
"Failed creating XMA decoder: no more XMA voices available"),
445Â
AKTEXT(
"Failed seeking in XMA source: stream buffer is smaller than XMA block size"),
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."),
448Â
AKTEXT(
"Triggered a game-object-scoped modulator in a global context (such as a bus or bus effect). Modulator will have global scope."),
450Â
AKTEXT(
"Ignoring seek after end of playlist"),
452Â
AKTEXT(
"Seek table required to seek in Opus sources. Please update conversion settings."),
453Â
AKTEXT(
"Opus decoder failure"),
454Â
AKTEXT(
"Failed creating Opus decoder"),
456Â
AKTEXT(
"Source plugin not found in currently loaded banks."),
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."),
460Â
AKTEXT(
"AK::SoundEngine::AddOutput()/ReplaceOutput() - Device ShareSet not found in Init bank."),
462Â
AKTEXT(
"Not enough memory to start sound."),
463Â
AKTEXT(
"Error while decoding Opus header."),
465Â
AKTEXT(
"The Output Device specified by AddOutput() or Init() could not be initialized."),
466Â
AKTEXT(
"ReplaceOutput could not properly remove old output device."),
467Â
AKTEXT(
"Device ID to remove not found as an active device."),
468Â
AKTEXT(
"Device ID not recognized by platform or is disabled."),
469Â
AKTEXT(
"Early reflections are not supported on sounds using 3D Position: Listener with Automation. The assigned early reflections bus will be ignored."),
470Â
AKTEXT(
"Duplicated media has different length in two separate banks. Stopping sound."),
472Â
AKTEXT(
"The hardware-accelerated voice subsystem failed to initialize."),
473Â
AKTEXT(
"Hardware accelerated audio decoding failed."),
474Â
AKTEXT(
"Maximum number of hardware-accelerated voices reached. Voice will not play."),
475Â
AKTEXT(
"Failed creating hardware-accelerated voice."),
476Â
AKTEXT(
"Opus HW command failure. Sound will glitch."),
478Â
AKTEXT(
"Non-empty array of listeners specified for AddOutput() but uNumListeners is set to zero."),
480Â
AKTEXT(
"3D audio object limit exceeded; object will be mixed."),
482Â
AKTEXT(
"AkInitSettings::uNumSamplesPerFrame value unsupported by XAPU, hardware decoding not available. Supported size: 256, 512 and 1024."),
483Â
AKTEXT(
"Fatal XAPU failure, Opus sounds will glitch while it is being reset."),
484Â
AKTEXT(
"Opus hardware stopped responding "),
486Â
AKTEXT(
"Another process is using Microsoft Spatial Sound objects. Some audio objects may be mixed."),
488Â
AKTEXT(
"AddOutput() needs unique Listeners for multi-instance outputs using the same shareset."),
490Â
AKTEXT(
"Plug-in does not support Audio Objects bus configuration."),
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."),
492Â
AKTEXT(
"Vorbis Hardware Acceleration library not found. Source will be decoded in software."),
499Â
#endif // AK_MONITOR_IMPLEMENT_ERRORCODES
501Â
#endif // _AKMONITORERROR_H
@ ErrorCode_CannotScheduleMusicSwitch
@ ErrorCode_FeedbackVoiceStarving
@ ErrorCode_OpusCreateDecoderFailed
@ ErrorCode_3DObjectLimitExceeded
@ ErrorCode_PluginProcessingFailed
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.
AkInt32 AkTimeMs
Time in ms.
@ ErrorCode_TooLongSegmentLookAhead
@ ErrorCode_StreamingSourceStarving
@ ErrorCode_PluginUnsupportedChannelConfiguration
V1::Notifications::Monitor Monitor
Latest version of the C++ Monitor notification interface.
@ ErrorCode_TooManySimultaneousMusicSegments
@ ErrorCode_CannotStartStreamNoMemory
@ ErrorCode_BankLoadFailed
@ ErrorCode_SpatialAudio_ListenerAutomationNotSupported
@ ErrorCode_CannotSeekContinuous
@ ErrorCode_AACDecodeError
@ ErrorCode_ATRAC9LoopSectionTooSmall
@ ErrorCode_PluginVersionMismatch
@ ErrorCode_AudioFileHeaderTooLarge
AKSOUNDENGINE_API AKRESULT SetLocalOutput(AkUInt32 in_uErrorLevel=ErrorLevel_All, LocalOutputFunc in_pMonitorFunc=0)
@ ErrorCode_EventIDNotFound
@ ErrorCode_PluginInitialisationFailed
AkUInt64 AkGameObjectID
Game object ID.
@ ErrorCode_HwVoiceLimitReached
@ ErrorCode_PlaylistStoppedForEditing
@ ErrorCode_SelectedChildNotAvailable
@ ErrorCode_ModulatorScopeError_Inst
#define AK_EXTERNAPIFUNC(_type, _name)
@ ErrorCode_TransitionNotAccurateChannel
AKRESULT
Standard function call result.
AkUInt32 AkDeviceID
I/O device ID.
@ ErrorCode_IncompatibleIOSettings
@ ErrorCode_InsufficientSpaceToLoadBank
@ ErrorCode_CannotPlaySource_VirtualOff
@ ErrorCode_MediaDuplicationLength
@ ErrorCode_CannotPlaySource_Create
@ ErrorCode_BankUnloadFailed
AKSOUNDENGINE_API void MonitorStreamingDeviceInit(AkDeviceID in_deviceID, const AkDeviceSettings &in_deviceSettings)
@ ErrorCode_NothingToPlay
@ ErrorCode_StingerCouldNotBeScheduled
const AkOSChar * s_aszErrorCodes[Num_ErrorCodes]
@ ErrorCode_XMAStreamBufferTooSmall
@ ErrorCode_ModulatorScopeError_Obj
@ ErrorCode_UnknownGameObjectEvent
@ ErrorCode_AudioDeviceRemoveFailure
@ ErrorCode_UnknownEmitter
AKSOUNDENGINE_API void MonitorStreamMgrTerm()
@ ErrorCode_AudioDeviceShareSetNotFound
@ ErrorCode_GameObjectIsNotEmitterEvent
@ ErrorCode_ExternalSourceNotResolved
@ ErrorCode_CannotOpenFile
@ ErrorCode_TransitionNotAccuratePluginMismatch
@ ErrorCode_TransitionNotAccurateStarvation
AkUInt32 AkUniqueID
Unique 32-bit ID.
@ ErrorCode_xWMACreateDecoderFailed
@ ErrorCode_TransitionNotAccurateRejectedByPlugin
@ ErrorCode_MediaNotLoaded
@ ErrorCode_VorbisSeekTableRecommended
@ ErrorCode_UnknownListener
@ ErrorCode_CommandQueueFull
@ ErrorCode_HwVoicesSystemInitFailed
@ ErrorCode_UnkownOpusError
@ ErrorCode_VorbisHWDecodeUnavailable
@ ErrorCode_XMADecoderSourceStarving
@ ErrorCode_NotEnoughMemoryToStart
@ ErrorCode_ErrorWhileLoadingBank
AKSOUNDENGINE_API AkTimeMs GetTimeStamp()
@ ErrorCode_AudioDeviceNotFound
@ ErrorCode_PluginMediaUnavailable
@ ErrorCode_GameObjectIsNotListener
@ ErrorCode_OpusDecodeError
@ ErrorCode_OpusRequireSeekTable
@ ErrorCode_AudioDeviceNotValid
#define AK_CALLBACK(_type, _name)
@ ErrorCode_SpatialAudio_ReflectionBusError
@ ErrorCode_CannotPlaySource_InconsistentState
@ ErrorCode_SelectedNodeNotAvailable
static const AkUniqueID AK_INVALID_UNIQUE_ID
Invalid unique 32-bit ID.
@ ErrorCode_SelectedNodeNotAvailablePlay
@ ErrorCode_XMADecodingError
@ ErrorCode_OpusHWFatalError
@ ErrorCode_PluginCannotRunOnObjectConfig
@ ErrorCode_XMACreateDecoderLimitReached
static const AkPlayingID AK_INVALID_PLAYING_ID
Invalid playing ID.
AKSOUNDENGINE_API void MonitorStreamMgrInit(const AkStreamMgrSettings &in_streamMgrSettings)
Add the streaming manager settings to the profiler capture.
@ ErrorCode_GameObjectIsNotEmitter
@ ErrorCode_HwVoiceInitFailed
@ ErrorCode_InvalidGroupID
@ ErrorCode_OpusHWDecodeUnavailable
@ ErrorCode_InvalidAudioFileHeader
@ ErrorCode_CommandTooLarge
@ ErrorCode_LowerEngineCommandListFull
@ ErrorCode_CannotPlaySource_TimeSkip
@ ErrorCode_SelectedMediaNotAvailable
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
@ ErrorCode_VirtualVoiceLimit
@ ErrorCode_PluginExecutionInvalid
@ ErrorCode_TransitionNotAccurateCodecError
@ ErrorCode_AudioDeviceInitFailure
AKSOUNDENGINE_API void MonitorStreamingDeviceDestroyed(AkDeviceID in_deviceID)
@ ErrorCode_InvalidXMAData
@ ErrorCode_SystemAudioObjectsUnavailable
@ ErrorCode_AddOutputListenerIdWithZeroListeners
@ ErrorCode_CodecNotRegistered
@ ErrorCode_UnknownGameObject
@ ErrorCode_HwVoicesDecodeBatchFailed
@ ErrorCode_SourcePluginNotFound
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_VoiceStarving
@ ErrorCode_MusicClipsRescheduledAfterTrackEdit
@ ErrorCode_AddOutputNoDistinctListener
@ ErrorCode_ATRAC9DecodeFailed
@ ErrorCode_VorbisDecodeError
@ ErrorCode_OpusHWCommandFailed
@ ErrorCode_OpusHWTimeout
@ ErrorCode_NoValidSwitch
AkUInt32 AkPlayingID
Playing ID.
@ ErrorCode_FileFormatMismatch
@ ErrorCode_PluginNotRegistered
@ ErrorCode_PluginAllocationFailed
@ ErrorCode_SeekAfterEndOfPlaylist
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)
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