Version

menu_open
Wwise SDK 2021.1.14
AK::Monitor Namespace Reference

Typedefs

typedef 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. More...
 

Enumerations

enum   ErrorLevel { ErrorLevel_Message = (1<<0), ErrorLevel_Error = (1<<1), ErrorLevel_All = ErrorLevel_Message | ErrorLevel_Error }
  ErrorLevel. More...
 
enum   ErrorCode {
  ErrorCode_NoError = 0, ErrorCode_FileNotFound, ErrorCode_CannotOpenFile, ErrorCode_CannotStartStreamNoMemory,
  ErrorCode_IODevice, ErrorCode_IncompatibleIOSettings, ErrorCode_PluginUnsupportedChannelConfiguration, ErrorCode_PluginMediaUnavailable,
  ErrorCode_PluginInitialisationFailed, ErrorCode_PluginProcessingFailed, ErrorCode_PluginExecutionInvalid, ErrorCode_PluginAllocationFailed,
  ErrorCode_VorbisSeekTableRecommended, ErrorCode_VorbisDecodeError, ErrorCode_AACDecodeError, ErrorCode_xWMACreateDecoderFailed,
  ErrorCode_ATRAC9DecodeFailed, ErrorCode_ATRAC9LoopSectionTooSmall, ErrorCode_InvalidAudioFileHeader, ErrorCode_AudioFileHeaderTooLarge,
  ErrorCode_FileTooSmall, ErrorCode_TransitionNotAccurateChannel, ErrorCode_TransitionNotAccuratePluginMismatch, ErrorCode_TransitionNotAccurateRejectedByPlugin,
  ErrorCode_TransitionNotAccurateStarvation, ErrorCode_TransitionNotAccurateCodecError, ErrorCode_NothingToPlay, ErrorCode_PlayFailed,
  ErrorCode_StingerCouldNotBeScheduled, ErrorCode_TooLongSegmentLookAhead, ErrorCode_CannotScheduleMusicSwitch, ErrorCode_TooManySimultaneousMusicSegments,
  ErrorCode_PlaylistStoppedForEditing, ErrorCode_MusicClipsRescheduledAfterTrackEdit, ErrorCode_CannotPlaySource_Create, ErrorCode_CannotPlaySource_VirtualOff,
  ErrorCode_CannotPlaySource_TimeSkip, ErrorCode_CannotPlaySource_InconsistentState, ErrorCode_MediaNotLoaded, ErrorCode_VoiceStarving,
  ErrorCode_StreamingSourceStarving, ErrorCode_XMADecoderSourceStarving, ErrorCode_XMADecodingError, ErrorCode_InvalidXMAData,
  ErrorCode_PluginNotRegistered, ErrorCode_CodecNotRegistered, ErrorCode_PluginVersionMismatch, ErrorCode_EventIDNotFound,
  ErrorCode_InvalidGroupID, ErrorCode_SelectedChildNotAvailable, ErrorCode_SelectedNodeNotAvailable, ErrorCode_SelectedMediaNotAvailable,
  ErrorCode_NoValidSwitch, ErrorCode_SelectedNodeNotAvailablePlay, ErrorCode_FeedbackVoiceStarving, ErrorCode_BankLoadFailed,
  ErrorCode_BankUnloadFailed, ErrorCode_ErrorWhileLoadingBank, ErrorCode_InsufficientSpaceToLoadBank, ErrorCode_LowerEngineCommandListFull,
  ErrorCode_SeekNoMarker, ErrorCode_CannotSeekContinuous, ErrorCode_SeekAfterEof, ErrorCode_UnknownGameObject,
  ErrorCode_UnknownEmitter, ErrorCode_UnknownListener, ErrorCode_GameObjectIsNotListener, ErrorCode_GameObjectIsNotEmitter,
  ErrorCode_UnknownGameObjectEvent, ErrorCode_GameObjectIsNotEmitterEvent, ErrorCode_ExternalSourceNotResolved, ErrorCode_FileFormatMismatch,
  ErrorCode_CommandQueueFull, ErrorCode_CommandTooLarge, ErrorCode_XMACreateDecoderLimitReached, ErrorCode_XMAStreamBufferTooSmall,
  ErrorCode_ModulatorScopeError_Inst, ErrorCode_ModulatorScopeError_Obj, ErrorCode_SeekAfterEndOfPlaylist, ErrorCode_OpusRequireSeekTable,
  ErrorCode_OpusDecodeError, ErrorCode_OpusCreateDecoderFailed, ErrorCode_SourcePluginNotFound, ErrorCode_VirtualVoiceLimit,
  ErrorCode_AudioDeviceShareSetNotFound, ErrorCode_NotEnoughMemoryToStart, ErrorCode_UnkownOpusError, ErrorCode_AudioDeviceInitFailure,
  ErrorCode_AudioDeviceRemoveFailure, ErrorCode_AudioDeviceNotFound, ErrorCode_AudioDeviceNotValid, ErrorCode_SpatialAudio_ListenerAutomationNotSupported,
  ErrorCode_MediaDuplicationLength, ErrorCode_HwVoicesSystemInitFailed, ErrorCode_HwVoicesDecodeBatchFailed, ErrorCode_HwVoiceLimitReached,
  ErrorCode_HwVoiceInitFailed, ErrorCode_OpusHWCommandFailed, ErrorCode_AddOutputListenerIdWithZeroListeners, ErrorCode_3DObjectLimitExceeded,
  ErrorCode_OpusHWDecodeUnavailable, ErrorCode_OpusHWFatalError, ErrorCode_OpusHWTimeout, ErrorCode_SystemAudioObjectsUnavailable,
  ErrorCode_AddOutputNoDistinctListener, ErrorCode_PluginCannotRunOnObjectConfig, ErrorCode_SpatialAudio_ReflectionBusError, ErrorCode_VorbisHWDecodeUnavailable,
  Num_ErrorCodes
}
  ErrorCode. More...
 

Functions

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)
 
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)
 
AKSOUNDENGINE_API AKRESULT  SetLocalOutput (AkUInt32 in_uErrorLevel=ErrorLevel_All, LocalOutputFunc in_pMonitorFunc=0)
 
AKSOUNDENGINE_API AkTimeMs  GetTimeStamp ()
 
AKSOUNDENGINE_API void  MonitorStreamMgrInit (const AkStreamMgrSettings &in_streamMgrSettings)
  Add the streaming manager settings to the profiler capture. More...
 
AKSOUNDENGINE_API void  MonitorStreamingDeviceInit (AkDeviceID in_deviceID, const AkDeviceSettings &in_deviceSettings)
 
AKSOUNDENGINE_API void  MonitorStreamingDeviceDestroyed (AkDeviceID in_deviceID)
 
AKSOUNDENGINE_API void  MonitorStreamMgrTerm ()
 

Variables

const AkOSChar s_aszErrorCodes [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