Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.7.8574 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Go to the documentation of this file.
27Â
#ifndef _AKMONITORERROR_H
28Â
#define _AKMONITORERROR_H
32Â
#define ERROR_CODE_DEF( in_name, in_msg ){ MonitorErrorInfo(in_name, in_msg) }
388Â
"Please document your new ErrorCode "
389Â
"in 'Documentation/Help/source_en/reference/common_errors_capture_log.xml', "
390Â
"then you can increment this value."
417Â
bool in_bIsBus =
false
439Â
#ifdef AK_SUPPORT_WCHAR
447Â
const wchar_t* in_pszError,
452Â
bool in_bIsBus =
false
455Â
#endif // #ifdef AK_SUPPORT_WCHAR
464Â
const char* in_pszError,
469Â
bool in_bIsBus =
false
488Â
bool overridePreviousTranslators =
false
536Â
#ifndef AK_OPTIMIZED
537Â
#define AK_MONITOR_ERROR( in_eErrorCode ) \
538Â
AK::Monitor::PostCode( in_eErrorCode, AK::Monitor::ErrorLevel_Error )
540Â
#define AK_MONITOR_STREAM_MGR_INIT( in_streamMgrSettings ) \
541Â
AK::Monitor::MonitorStreamMgrInit( in_streamMgrSettings )
543Â
#define AK_MONITOR_STREAMING_DEVICE_INIT( in_deviceID, in_deviceSettings ) \
544Â
AK::Monitor::MonitorStreamingDeviceInit( in_deviceID, in_deviceSettings )
546Â
#define AK_MONITOR_STREAMING_DEVICE_DESTROYED( in_deviceID ) \
547Â
AK::Monitor::MonitorStreamingDeviceDestroyed( in_deviceID )
549Â
#define AK_MONITOR_STREAM_MGR_TERM( ) \
550Â
AK::Monitor::MonitorStreamMgrTerm()
552Â
#define AK_MONITOR_ERROR( in_eErrorCode )
553Â
#define AK_MONITOR_STREAM_MGR_INIT( in_streamMgrSettings )
554Â
#define AK_MONITOR_STREAMING_DEVICE_INIT( in_deviceID, in_deviceSettings )
555Â
#define AK_MONITOR_STREAMING_DEVICE_DESTROYED( in_deviceID )
556Â
#define AK_MONITOR_STREAM_MGR_TERM( )
559Â
#ifdef AK_MONITOR_IMPLEMENT_ERRORCODES
561Â
#endif // AK_MONITOR_IMPLEMENT_ERRORCODES
563Â
#endif // _AKMONITORERROR_H
@ ErrorCode_TooManyChildren
@ ErrorCode_SetEffectOnRendered
@ ErrorCode_CannotScheduleMusicSwitch
@ ErrorCode_FailedPostingEvent
@ ErrorCode_SoundEnginePlayingIdNotFound
@ ErrorCode_AmbisonicNotAvailable
AKSOUNDENGINE_API AKRESULT PostCodeVaList(ErrorCode in_eError, ErrorLevel in_eErrorLevel, MsgContext msgContext, ::va_list args)
@ ErrorCode_PendingActionDestroyed
@ ErrorCode_3DObjectLimitExceeded
@ ErrorCode_GeometryNotWatertight
@ ErrorCode_SetPortalInvalidExtent
AkGameObjectID in_gameObjID
Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise.
@ ErrorCode_MusicEngineNotInitialized
@ ErrorCode_PluginProcessingFailed
@ ErrorCode_NXDeviceRegistrationFailed
@ ErrorCode_SetGeometryInstanceFailed
@ ErrorCode_ResetPlaylistActionIgnoredGlobalScope
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.
@ ErrorCode_CannotInitialize3DAudio
AkInt32 AkTimeMs
Time in ms.
@ ErrorCode_TooLongSegmentLookAhead
@ ErrorCode_StreamingSourceStarving
@ ErrorCode_PluginUnsupportedChannelConfiguration
@ ErrorCode_NoAudioDevice
@ ErrorCode_RevertingToDefaultAudioDevice
@ ErrorCode_CrossFadeTransitionIgnored
V1::Notifications::Monitor Monitor
Latest version of the C++ Monitor notification interface.
@ ErrorCode_PluginFileRegisterFailed
@ ErrorCode_TooManySimultaneousMusicSegments
@ ErrorCode_CannotStartStreamNoMemory
@ ErrorCode_DataAlignement
@ ErrorCode_BankLoadFailed
@ ErrorCode_JobMgrOutOfMemory
@ ErrorCode_SoundEngineCantCallOnChildBus
@ ErrorCode_UnknownDialogueEvent
@ ErrorCode_SpatialAudio_ListenerAutomationNotSupported
@ ErrorCode_XboxXMAFatalError
MonitorErrorInfo(const AkOSChar *in_name=nullptr, const AkOSChar *in_message=nullptr)
@ ErrorCode_CannotSeekContinuous
@ ErrorCode_InvalidFloatInFunction
@ ErrorCode_ATRAC9LoopSectionTooSmall
@ ErrorCode_TranslatorWwiseTagTest
@ ErrorCode_SoundLoadFailedInsufficientMemory
@ ErrorCode_UnknownStateGroup
AKSOUNDENGINE_API AKRESULT AddTranslator(AkErrorMessageTranslator *translator, bool overridePreviousTranslators=false)
@ ErrorCode_HardwareOpusDecoderError
@ ErrorCode_PluginVersionMismatch
@ ErrorCode_OutputAlreadyExists
@ ErrorCode_AudioFileHeaderTooLarge
AKSOUNDENGINE_API AKRESULT SetLocalOutput(AkUInt32 in_uErrorLevel=ErrorLevel_All, LocalOutputFunc in_pMonitorFunc=0)
@ ErrorCode_UnknownOpusError
@ ErrorCode_RevertingToDummyAudioDevice
@ ErrorCode_MasterBusStructureNotLoaded
@ ErrorCode_EventIDNotFound
@ ErrorCode_PluginInitialisationFailed
@ ErrorCode_MonitorMsgTooLarge
@ ErrorCode_PlayingTriggerRateNotSupported
AkUInt64 AkGameObjectID
Game object ID.
@ ErrorCode_HwVoiceLimitReached
@ ErrorCode_PlaylistStoppedForEditing
@ ErrorCode_AudioThreadSuspended
@ ErrorCode_ModulatorScopeError_Inst
@ ErrorCode_SoundEngineTooManyPositions
#define AK_EXTERNAPIFUNC(_type, _name)
@ ErrorCode_TransitionNotAccurateChannel
@ ErrorCode_SetGeometryInstanceInvalidTransform
@ ErrorCode_AudioSubsystemStoppedResponding
AKRESULT
Standard function call result.
AkUInt32 AkDeviceID
I/O device ID.
@ ErrorCode_IncompatibleIOSettings
@ ErrorCode_InsufficientSpaceToLoadBank
@ ErrorCode_AudioNodeNotFound
@ ErrorCode_CannotPlaySource_VirtualOff
@ ErrorCode_ResetPlaylistActionIgnoredContinuous
@ ErrorCode_MediaUpdatedFromWwise
@ ErrorCode_MediaDuplicationLength
@ ErrorCode_CannotPlaySource_Create
@ ErrorCode_InvalidParameter
AKSOUNDENGINE_API void MonitorStreamingDeviceInit(AkDeviceID in_deviceID, const AkDeviceSettings &in_deviceSettings)
@ ErrorCode_MemoryAllocationFailed
AkPlayingID in_playingID
Related Playing ID if applicable.
@ ErrorCode_NothingToPlay
@ ErrorCode_StingerCouldNotBeScheduled
bool in_bIsBus
true if in_audioNodeID is a bus
@ ErrorCode_XMAStreamBufferTooSmall
@ ErrorCode_ModulatorScopeError_Obj
@ ErrorCode_CannotInitializeInputCallbacks
@ ErrorCode_AudioOut2ContextCreateError
@ ErrorCode_SetMixerFailed
@ ErrorCode_SetGeometryTooManyTriangleConnected
@ ErrorCode_AudioDeviceRemoveFailure
@ ErrorCode_MissingMusicNodeParent
AKSOUNDENGINE_API void MonitorStreamMgrTerm()
@ ErrorCode_UnloadBankFailed
@ ErrorCode_RemovingGeometrySetFailed
@ ErrorCode_TransitionNotAccurateSourceTooShort
@ ErrorCode_PluginFileInvalid
@ ErrorCode_TranslatorStringSizeTest
AkUniqueID in_soundID
Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise.
@ ErrorCode_AudioDeviceShareSetNotFound
@ ErrorCode_InvalidFileSize
@ ErrorCode_NonCompliantDeviceMemory
@ ErrorCode_ExternalSourceNotResolved
@ ErrorCode_CannotOpenFile
@ ErrorCode_TransitionNotAccuratePluginMismatch
@ ErrorCode_CannotConnectAVAudioEngineSource
@ ErrorCode_DynamicSequenceIdNotFound
@ ErrorCode_TranslatorStandardTagTest
@ ErrorCode_TransitionNotAccurateStarvation
@ ErrorCode_PluginMsgWithShareSet
@ ErrorCode_MusicRendererSeekingFailed
@ ErrorCode_InvalidFloatPriority
AkUInt32 AkUniqueID
Unique 32-bit ID.
@ ErrorCode_SoundEngineNotInit
@ ErrorCode_SetGeometryTriangleTooLarge
@ ErrorCode_UnknownArgument
@ ErrorCode_SpatialAudio_SiblingPortal
@ ErrorCode_SetBusConfigUnsupported
@ ErrorCode_TransitionNotAccurateRejectedByPlugin
@ ErrorCode_MediaNotLoaded
@ ErrorCode_AudioOutOfRangeOnBusFx
@ ErrorCode_DeadGameObject
@ ErrorCode_MixPluginOnObjectBus
@ ErrorCode_AlreadyInitialized
@ ErrorCode_SetGeometryFailed
@ ErrorCode_VorbisSeekTableRecommended
@ ErrorCode_NotEnoughSystemObjWin
@ ErrorCode_NotEnoughMemInFunction
const AkOSChar * m_message
AKSOUNDENGINE_API AKRESULT PostCodeVarArg(ErrorCode in_eError, ErrorLevel in_eErrorLevel, MsgContext msgContext,...)
@ ErrorCode_CommandQueueFull
@ ErrorCode_HwVoicesSystemInitFailed
@ ErrorCode_VorbisHWDecodeUnavailable
@ ErrorCode_XMADecoderSourceStarving
@ ErrorCode_NotEnoughMemoryToStart
@ ErrorCode_ErrorWhileLoadingBank
@ ErrorCode_MMSNotEnabled
@ ErrorCode_RemovingGeometryInstanceFailed
AKSOUNDENGINE_API AkTimeMs GetTimeStamp()
@ ErrorCode_AudioDeviceNotFound
@ ErrorCode_PluginMediaUnavailable
@ ErrorCode_WrongNumberOfArguments
MsgContext(AkPlayingID pId=AK_INVALID_PLAYING_ID, AkGameObjectID goId=AK_INVALID_GAME_OBJECT, AkUniqueID nodeId=AK_INVALID_UNIQUE_ID, bool isBus=false)
@ ErrorCode_SetMixerNotABus
@ ErrorCode_SoundEngineInvalidTransform
@ ErrorCode_FeedbackOnAudioObjectsBus
const MonitorErrorInfo s_aszMonitorErrorInfos[Num_ErrorCodes]
@ ErrorCode_XboxACPMessage
@ ErrorCode_MediaErrorFromWwise
@ ErrorCode_ChannelConfigRequestDenied
@ ErrorCode_OpusDecodeError
@ ErrorCode_SetPortalNonDistinctRoom
@ ErrorCode_CantSetBoundSwitch
@ ErrorCode_PluginFileNotFound
@ ErrorCode_OpusRequireSeekTable
@ ErrorCode_AudioDeviceNotValid
@ ErrorCode_IODeviceInitFailed
@ ErrorCode_ReplayMessage
#define AK_CALLBACK(_type, _name)
@ ErrorCode_OutputDeviceInitializationFailed
@ ErrorCode_SpatialAudio_ReflectionBusError
@ ErrorCode_CannotPlaySource_InconsistentState
@ ErrorCode_SelectedNodeNotAvailable
@ ErrorCode_SetGameObjectRadiusSizeError
@ ErrorCode_SetGeometryTriangleIsSkipped
static const AkUniqueID AK_INVALID_UNIQUE_ID
Invalid unique 32-bit ID.
@ ErrorCode_XMADecodingError
@ ErrorCode_OpusHWFatalError
@ ErrorCode_MediaErrorWwiseMRUFull
@ ErrorCode_PluginCannotRunOnObjectConfig
@ ErrorCode_CannotInitializeAmbisonicChannelConfiguration
@ ErrorCode_XboxFrameDropped
@ 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_XboxXMAVoiceResetFailed
@ ErrorCode_OpusHWDecodeUnavailable
@ ErrorCode_InvalidAudioFileHeader
@ ErrorCode_CommandTooLarge
@ ErrorCode_JobWorkerFuncCallMismatch
@ ErrorCode_LowerEngineCommandListFull
@ ErrorCode_AudioOutOfRangeRay
@ ErrorCode_DynamicSequenceAlreadyClosed
@ ErrorCode_AssetSwapEnabled
@ ErrorCode_CannotPlaySource_TimeSkip
@ ErrorCode_SelectedMediaNotAvailable
@ ErrorCode_PluginFileIncompatible
@ ErrorCode_NotEnoughSystemObj
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
@ ErrorCode_VirtualVoiceLimit
@ ErrorCode_PluginExecutionInvalid
@ ErrorCode_SoundEngineTooManyEventPosts
@ ErrorCode_TransitionNotAccurateCodecError
@ ErrorCode_AudioDeviceInitFailure
@ ErrorCode_AudioOutOfRangeOnBus
uint32_t AkUInt32
Unsigned 32-bit integer.
AKSOUNDENGINE_API void MonitorStreamingDeviceDestroyed(AkDeviceID in_deviceID)
@ ErrorCode_BankContainUneditableEffect
@ ErrorCode_InvalidXMAData
AKSOUNDENGINE_API AKRESULT ResetTranslator()
@ ErrorCode_LoadingBankMismatch
@ ErrorCode_SystemAudioObjectsUnavailable
@ ErrorCode_UnexpectedPrepareGameSyncsCall
@ ErrorCode_AddOutputListenerIdWithZeroListeners
@ ErrorCode_CodecNotRegistered
@ ErrorCode_UnknownGameObject
@ ErrorCode_HwVoicesDecodeBatchFailed
@ ErrorCode_AudioOutOfRange
@ ErrorCode_SoundEngineTooManyGameObjects
@ 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_MaxAudioObjExceeded
@ ErrorCode_FLTMAXNotSupported
@ ErrorCode_VoiceStarving
@ ErrorCode_MismatchingMediaSize
@ ErrorCode_MusicClipsRescheduledAfterTrackEdit
@ ErrorCode_AddOutputNoDistinctListener
@ ErrorCode_AudioDeviceShareSetNotFoundByName
@ ErrorCode_ATRAC9DecodeFailed
@ ErrorCode_3DAudioUnsupportedSize
@ ErrorCode_VorbisDecodeError
@ ErrorCode_NoSwitchSelected
@ ErrorCode_OpusHWCommandFailed
@ ErrorCode_OpusHWTimeout
@ ErrorCode_NoValidSwitch
@ ErrorCode_FilePermissionError
@ ErrorCode_BusNotFoundByName
@ ErrorCode_MonitorQueueFull
@ ErrorCode_PluginFileNotEnoughMemoryToStart
@ ErrorCode_NoDefaultSwitch
AkUInt32 AkPlayingID
Playing ID.
@ ErrorCode_FileFormatMismatch
@ ErrorCode_PluginNotRegistered
@ ErrorCode_ExternalSourceNoMemorySize
@ ErrorCode_AudioThreadResumed
@ ErrorCode_IncompatibleBankVersion
@ ErrorCode_PluginAllocationFailed
@ ErrorCode_SwitchListEmpty
@ ErrorCode_GameObjectNeverRegistered
@ ErrorCode_SpatialAudio_PortalNotFound
@ ErrorCode_AudioOut2UserCreateError
@ ErrorCode_SeekAfterEndOfPlaylist
@ ErrorCode_CannotInitializePassthrough
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