Version

    Other Documentation

menu_open
Wwise SDK 2022.1.8
Classes | Namespaces | Macros | Typedefs | Enumerations | Functions | Variables
AkMonitorError.h File Reference
#include <AK/SoundEngine/Common/AkSoundEngineExport.h>
#include <AK/SoundEngine/Common/AkTypes.h>

Go to the source code of this file.

Classes

struct   AK::Monitor::MsgContext
 
struct   AK::Monitor::MonitorErrorInfo
 

Namespaces

namespace   AK
  Audiokinetic namespace.
 
  AK::Monitor
 

Macros

#define  ERROR_CODE_DEF(in_name, in_msg)   { MonitorErrorInfo(in_name, in_msg) }
 
#define  AK_MONITOR_ERROR(in_eErrorCode)    AK::Monitor::PostCode( in_eErrorCode, AK::Monitor::ErrorLevel_Error )
 
#define  AK_MONITOR_STREAM_MGR_INIT(in_streamMgrSettings)    AK::Monitor::MonitorStreamMgrInit( in_streamMgrSettings )
 
#define  AK_MONITOR_STREAMING_DEVICE_INIT(in_deviceID, in_deviceSettings)    AK::Monitor::MonitorStreamingDeviceInit( in_deviceID, in_deviceSettings )
 
#define  AK_MONITOR_STREAMING_DEVICE_DESTROYED(in_deviceID)    AK::Monitor::MonitorStreamingDeviceDestroyed( in_deviceID )
 
#define  AK_MONITOR_STREAM_MGR_TERM()    AK::Monitor::MonitorStreamMgrTerm()
 

Typedefs

typedef void(*  AK::Monitor::LocalOutputFunc) (ErrorCode in_eErrorCode, const AkOSChar *in_pszError, ErrorLevel in_eErrorLevel, AkPlayingID in_playingID, AkGameObjectID in_gameObjID)
  Function prototype of local output function pointer. More...
 

Enumerations

enum   AK::Monitor::ErrorLevel { AK::Monitor::ErrorLevel_Message = (1<<0), AK::Monitor::ErrorLevel_Error = (1<<1), AK::Monitor::ErrorLevel_All = ErrorLevel_Message | ErrorLevel_Error }
  ErrorLevel. More...
 
enum   AK::Monitor::ErrorCode {
  AK::Monitor::ErrorCode_NoError = 0, AK::Monitor::ErrorCode_FileNotFound, AK::Monitor::ErrorCode_CannotOpenFile, AK::Monitor::ErrorCode_CannotStartStreamNoMemory,
  AK::Monitor::ErrorCode_IODevice, AK::Monitor::ErrorCode_IncompatibleIOSettings, AK::Monitor::ErrorCode_PluginUnsupportedChannelConfiguration, AK::Monitor::ErrorCode_PluginMediaUnavailable,
  AK::Monitor::ErrorCode_PluginInitialisationFailed, AK::Monitor::ErrorCode_PluginProcessingFailed, AK::Monitor::ErrorCode_PluginExecutionInvalid, AK::Monitor::ErrorCode_PluginAllocationFailed,
  AK::Monitor::ErrorCode_VorbisSeekTableRecommended, AK::Monitor::ErrorCode_VorbisDecodeError, AK::Monitor::ErrorCode_ATRAC9DecodeFailed, AK::Monitor::ErrorCode_ATRAC9LoopSectionTooSmall,
  AK::Monitor::ErrorCode_InvalidAudioFileHeader, AK::Monitor::ErrorCode_AudioFileHeaderTooLarge, AK::Monitor::ErrorCode_LoopTooSmall, AK::Monitor::ErrorCode_TransitionNotAccurateChannel,
  AK::Monitor::ErrorCode_TransitionNotAccuratePluginMismatch, AK::Monitor::ErrorCode_TransitionNotAccurateRejectedByPlugin, AK::Monitor::ErrorCode_TransitionNotAccurateStarvation, AK::Monitor::ErrorCode_TransitionNotAccurateCodecError,
  AK::Monitor::ErrorCode_NothingToPlay, AK::Monitor::ErrorCode_PlayFailed, AK::Monitor::ErrorCode_StingerCouldNotBeScheduled, AK::Monitor::ErrorCode_TooLongSegmentLookAhead,
  AK::Monitor::ErrorCode_CannotScheduleMusicSwitch, AK::Monitor::ErrorCode_TooManySimultaneousMusicSegments, AK::Monitor::ErrorCode_PlaylistStoppedForEditing, AK::Monitor::ErrorCode_MusicClipsRescheduledAfterTrackEdit,
  AK::Monitor::ErrorCode_CannotPlaySource_Create, AK::Monitor::ErrorCode_CannotPlaySource_VirtualOff, AK::Monitor::ErrorCode_CannotPlaySource_TimeSkip, AK::Monitor::ErrorCode_CannotPlaySource_InconsistentState,
  AK::Monitor::ErrorCode_MediaNotLoaded, AK::Monitor::ErrorCode_VoiceStarving, AK::Monitor::ErrorCode_StreamingSourceStarving, AK::Monitor::ErrorCode_XMADecoderSourceStarving,
  AK::Monitor::ErrorCode_XMADecodingError, AK::Monitor::ErrorCode_InvalidXMAData, AK::Monitor::ErrorCode_PluginNotRegistered, AK::Monitor::ErrorCode_CodecNotRegistered,
  AK::Monitor::ErrorCode_PluginVersionMismatch, AK::Monitor::ErrorCode_EventIDNotFound, AK::Monitor::ErrorCode_InvalidGroupID, AK::Monitor::ErrorCode_SelectedNodeNotAvailable,
  AK::Monitor::ErrorCode_SelectedMediaNotAvailable, AK::Monitor::ErrorCode_NoValidSwitch, AK::Monitor::ErrorCode_BankLoadFailed, AK::Monitor::ErrorCode_ErrorWhileLoadingBank,
  AK::Monitor::ErrorCode_InsufficientSpaceToLoadBank, AK::Monitor::ErrorCode_LowerEngineCommandListFull, AK::Monitor::ErrorCode_SeekNoMarker, AK::Monitor::ErrorCode_CannotSeekContinuous,
  AK::Monitor::ErrorCode_SeekAfterEof, AK::Monitor::ErrorCode_UnknownGameObject, AK::Monitor::ErrorCode_GameObjectNeverRegistered, AK::Monitor::ErrorCode_DeadGameObject,
  AK::Monitor::ErrorCode_GameObjectIsNotEmitter, AK::Monitor::ErrorCode_ExternalSourceNotResolved, AK::Monitor::ErrorCode_FileFormatMismatch, AK::Monitor::ErrorCode_CommandQueueFull,
  AK::Monitor::ErrorCode_CommandTooLarge, AK::Monitor::ErrorCode_XMACreateDecoderLimitReached, AK::Monitor::ErrorCode_XMAStreamBufferTooSmall, AK::Monitor::ErrorCode_ModulatorScopeError_Inst,
  AK::Monitor::ErrorCode_ModulatorScopeError_Obj, AK::Monitor::ErrorCode_SeekAfterEndOfPlaylist, AK::Monitor::ErrorCode_OpusRequireSeekTable, AK::Monitor::ErrorCode_OpusDecodeError,
  AK::Monitor::ErrorCode_SourcePluginNotFound, AK::Monitor::ErrorCode_VirtualVoiceLimit, AK::Monitor::ErrorCode_NotEnoughMemoryToStart, AK::Monitor::ErrorCode_UnknownOpusError,
  AK::Monitor::ErrorCode_AudioDeviceInitFailure, AK::Monitor::ErrorCode_AudioDeviceRemoveFailure, AK::Monitor::ErrorCode_AudioDeviceNotFound, AK::Monitor::ErrorCode_AudioDeviceNotValid,
  AK::Monitor::ErrorCode_SpatialAudio_ListenerAutomationNotSupported, AK::Monitor::ErrorCode_MediaDuplicationLength, AK::Monitor::ErrorCode_HwVoicesSystemInitFailed, AK::Monitor::ErrorCode_HwVoicesDecodeBatchFailed,
  AK::Monitor::ErrorCode_HwVoiceLimitReached, AK::Monitor::ErrorCode_HwVoiceInitFailed, AK::Monitor::ErrorCode_OpusHWCommandFailed, AK::Monitor::ErrorCode_AddOutputListenerIdWithZeroListeners,
  AK::Monitor::ErrorCode_3DObjectLimitExceeded, AK::Monitor::ErrorCode_OpusHWFatalError, AK::Monitor::ErrorCode_OpusHWDecodeUnavailable, AK::Monitor::ErrorCode_OpusHWTimeout,
  AK::Monitor::ErrorCode_SystemAudioObjectsUnavailable, AK::Monitor::ErrorCode_AddOutputNoDistinctListener, AK::Monitor::ErrorCode_PluginCannotRunOnObjectConfig, AK::Monitor::ErrorCode_SpatialAudio_ReflectionBusError,
  AK::Monitor::ErrorCode_VorbisHWDecodeUnavailable, AK::Monitor::ErrorCode_ExternalSourceNoMemorySize, AK::Monitor::ErrorCode_MonitorQueueFull, AK::Monitor::ErrorCode_MonitorMsgTooLarge,
  AK::Monitor::ErrorCode_NonCompliantDeviceMemory, AK::Monitor::ErrorCode_JobWorkerFuncCallMismatch, AK::Monitor::ErrorCode_JobMgrOutOfMemory, AK::Monitor::ErrorCode_InvalidFileSize,
  AK::Monitor::ErrorCode_PluginMsg, AK::Monitor::ErrorCode_SinkOpenSL, AK::Monitor::ErrorCode_AudioOutOfRange, AK::Monitor::ErrorCode_AudioOutOfRangeOnBus,
  AK::Monitor::ErrorCode_AudioOutOfRangeOnBusFx, AK::Monitor::ErrorCode_AudioOutOfRangeRay, AK::Monitor::ErrorCode_UnknownDialogueEvent, AK::Monitor::ErrorCode_FailedPostingEvent,
  AK::Monitor::ErrorCode_OutputDeviceInitializationFailed, AK::Monitor::ErrorCode_UnloadBankFailed, AK::Monitor::ErrorCode_PluginFileNotFound, AK::Monitor::ErrorCode_PluginFileIncompatible,
  AK::Monitor::ErrorCode_PluginFileNotEnoughMemoryToStart, AK::Monitor::ErrorCode_PluginFileInvalid, AK::Monitor::ErrorCode_PluginFileRegisterFailed, AK::Monitor::ErrorCode_UnknownArgument,
  AK::Monitor::ErrorCode_DynamicSequenceAlreadyClosed, AK::Monitor::ErrorCode_PendingActionDestroyed, AK::Monitor::ErrorCode_CrossFadeTransitionIgnored, AK::Monitor::ErrorCode_MusicRendererSeekingFailed,
  AK::Monitor::ErrorCode_DynamicSequenceIdNotFound, AK::Monitor::ErrorCode_BusNotFoundByName, AK::Monitor::ErrorCode_AudioDeviceShareSetNotFound, AK::Monitor::ErrorCode_AudioDeviceShareSetNotFoundByName,
  AK::Monitor::ErrorCode_SoundEngineTooManyGameObjects, AK::Monitor::ErrorCode_SoundEngineTooManyPositions, AK::Monitor::ErrorCode_SoundEngineCantCallOnChildBus, AK::Monitor::ErrorCode_SoundEnginePlayingIdNotFound,
  AK::Monitor::ErrorCode_SoundEngineInvalidTransform, AK::Monitor::ErrorCode_SoundEngineTooManyEventPosts, AK::Monitor::ErrorCode_AudioSubsystemStoppedResponding, AK::Monitor::ErrorCode_NotEnoughMemInFunction,
  AK::Monitor::ErrorCode_FXNotFound, AK::Monitor::ErrorCode_SetMixerNotABus, AK::Monitor::ErrorCode_AudioNodeNotFound, AK::Monitor::ErrorCode_SetMixerFailed,
  AK::Monitor::ErrorCode_SetBusConfigUnsupported, AK::Monitor::ErrorCode_BusNotFound, AK::Monitor::ErrorCode_MismatchingMediaSize, AK::Monitor::ErrorCode_IncompatibleBankVersion,
  AK::Monitor::ErrorCode_UnexpectedPrepareGameSyncsCall, AK::Monitor::ErrorCode_MusicEngineNotInitialized, AK::Monitor::ErrorCode_LoadingBankMismatch, AK::Monitor::ErrorCode_MasterBusStructureNotLoaded,
  AK::Monitor::ErrorCode_TooManyChildren, AK::Monitor::ErrorCode_BankContainUneditableEffect, AK::Monitor::ErrorCode_MemoryAllocationFailed, AK::Monitor::ErrorCode_InvalidFloatPriority,
  AK::Monitor::ErrorCode_SoundLoadFailedInsufficientMemory, AK::Monitor::ErrorCode_NXDeviceRegistrationFailed, AK::Monitor::ErrorCode_MixPluginOnObjectBus, AK::Monitor::ErrorCode_XboxXMAVoiceResetFailed,
  AK::Monitor::ErrorCode_XboxACPMessage, AK::Monitor::ErrorCode_XboxFrameDropped, AK::Monitor::ErrorCode_XboxACPError, AK::Monitor::ErrorCode_XboxXMAFatalError,
  AK::Monitor::ErrorCode_MissingMusicNodeParent, AK::Monitor::ErrorCode_HardwareOpusDecoderError, AK::Monitor::ErrorCode_SetGeometryTooManyTriangleConnected, AK::Monitor::ErrorCode_SetGeometryTriangleTooLarge,
  AK::Monitor::ErrorCode_SetGeometryFailed, AK::Monitor::ErrorCode_RemovingGeometrySetFailed, AK::Monitor::ErrorCode_SetGeometryInstanceFailed, AK::Monitor::ErrorCode_RemovingGeometryInstanceFailed,
  AK::Monitor::ErrorCode_RevertingToDefaultAudioDevice, AK::Monitor::ErrorCode_RevertingToDummyAudioDevice, AK::Monitor::ErrorCode_AudioThreadSuspended, AK::Monitor::ErrorCode_AudioThreadResumed,
  AK::Monitor::ErrorCode_ResetPlaylistActionIgnoredGlobalScope, AK::Monitor::ErrorCode_ResetPlaylistActionIgnoredContinuous, AK::Monitor::ErrorCode_PlayingTriggerRateNotSupported, AK::Monitor::ErrorCode_SetGeometryTriangleIsSkipped,
  AK::Monitor::ErrorCode_SetGeometryInstanceInvalidTransform, AK::Monitor::ErrorCode_SetGameObjectRadiusSizeError, AK::Monitor::ErrorCode_SetPortalNonDistinctRoom, AK::Monitor::ErrorCode_SetPortalInvalidExtent,
  AK::Monitor::ErrorCode_SpatialAudio_PortalNotFound, AK::Monitor::ErrorCode_InvalidFloatInFunction, AK::Monitor::ErrorCode_FLTMAXNotSupported, AK::Monitor::ErrorCode_CannotInitializeAmbisonicChannelConfiguration,
  AK::Monitor::ErrorCode_CannotInitializePassthrough, AK::Monitor::ErrorCode_3DAudioUnsupportedSize, AK::Monitor::ErrorCode_AmbisonicNotAvailable, AK::Monitor::ErrorCode_NoAudioDevice,
  AK::Monitor::ErrorCode_Support, AK::Monitor::ErrorCode_ReplayMessage, AK::Monitor::ErrorCode_GameMessage, AK::Monitor::ErrorCode_TestMessage,
  AK::Monitor::ErrorCode_TranslatorStandardTagTest, AK::Monitor::ErrorCode_TranslatorWwiseTagTest, AK::Monitor::ErrorCode_TranslatorStringSizeTest, AK::Monitor::ErrorCode_InvalidParameter,
  AK::Monitor::ErrorCode_MaxAudioObjExceeded, AK::Monitor::ErrorCode_MMSNotEnabled, AK::Monitor::ErrorCode_NotEnoughSystemObj, AK::Monitor::ErrorCode_NotEnoughSystemObjWin,
  AK::Monitor::ErrorCode_TransitionNotAccurateSourceTooShort, AK::Monitor::ErrorCode_AlreadyInitialized, AK::Monitor::ErrorCode_WrongNumberOfArguments, AK::Monitor::ErrorCode_DataAlignement,
  AK::Monitor::ErrorCode_PluginMsgWithShareSet, AK::Monitor::ErrorCode_SoundEngineNotInit, AK::Monitor::ErrorCode_NoDefaultSwitch, AK::Monitor::ErrorCode_CantSetBoundSwitch,
  AK::Monitor::ErrorCode_IODeviceInitFailed, AK::Monitor::ErrorCode_SwitchListEmpty, AK::Monitor::ErrorCode_NoSwitchSelected, AK::Monitor::Num_ErrorCodes
}
  ErrorCode. More...
 

Functions

AKSOUNDENGINE_API AKRESULT  AK::Monitor::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)
 
AKSOUNDENGINE_API AKRESULT  AK::Monitor::PostCodeVarArg (ErrorCode in_eError, ErrorLevel in_eErrorLevel, MsgContext msgContext,...)
 
AKSOUNDENGINE_API AKRESULT  AK::Monitor::PostCodeVaList (ErrorCode in_eError, ErrorLevel in_eErrorLevel, MsgContext msgContext, ::va_list args)
 
AKSOUNDENGINE_API AKRESULT  AK::Monitor::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)
 
AKSOUNDENGINE_API AKRESULT  AK::Monitor::SetLocalOutput (AkUInt32 in_uErrorLevel=ErrorLevel_All, LocalOutputFunc in_pMonitorFunc=0)
 
AKSOUNDENGINE_API AKRESULT  AK::Monitor::AddTranslator (AkErrorMessageTranslator *translator, bool overridePreviousTranslators=false)
 
AKSOUNDENGINE_API AKRESULT  AK::Monitor::ResetTranslator ()
 
AKSOUNDENGINE_API AkTimeMs  AK::Monitor::GetTimeStamp ()
 
AKSOUNDENGINE_API void  AK::Monitor::MonitorStreamMgrInit (const AkStreamMgrSettings &in_streamMgrSettings)
  Add the streaming manager settings to the profiler capture. More...
 
AKSOUNDENGINE_API void  AK::Monitor::MonitorStreamingDeviceInit (AkDeviceID in_deviceID, const AkDeviceSettings &in_deviceSettings)
 
AKSOUNDENGINE_API void  AK::Monitor::MonitorStreamingDeviceDestroyed (AkDeviceID in_deviceID)
 
AKSOUNDENGINE_API void  AK::Monitor::MonitorStreamMgrTerm ()
 

Variables

const MonitorErrorInfo  AK::Monitor::s_aszMonitorErrorInfos [Num_ErrorCodes]
 

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