Version

menu_open
Wwise SDK 2023.1.3
AK::Monitor Namespace Reference

Classes

struct  MonitorErrorInfo
 
struct  MsgContext
 

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_ATRAC9DecodeFailed, ErrorCode_ATRAC9LoopSectionTooSmall,
  ErrorCode_InvalidAudioFileHeader, ErrorCode_AudioFileHeaderTooLarge, ErrorCode_LoopTooSmall, 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_SelectedNodeNotAvailable,
  ErrorCode_SelectedMediaNotAvailable, ErrorCode_NoValidSwitch, ErrorCode_BankLoadFailed, ErrorCode_ErrorWhileLoadingBank,
  ErrorCode_InsufficientSpaceToLoadBank, ErrorCode_LowerEngineCommandListFull, ErrorCode_SeekNoMarker, ErrorCode_CannotSeekContinuous,
  ErrorCode_SeekAfterEof, ErrorCode_UnknownGameObject, ErrorCode_GameObjectNeverRegistered, ErrorCode_DeadGameObject,
  ErrorCode_GameObjectIsNotEmitter, 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_SourcePluginNotFound, ErrorCode_VirtualVoiceLimit, ErrorCode_NotEnoughMemoryToStart, ErrorCode_UnknownOpusError,
  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_OpusHWFatalError, ErrorCode_OpusHWDecodeUnavailable, ErrorCode_OpusHWTimeout,
  ErrorCode_SystemAudioObjectsUnavailable, ErrorCode_AddOutputNoDistinctListener, ErrorCode_PluginCannotRunOnObjectConfig, ErrorCode_SpatialAudio_ReflectionBusError,
  ErrorCode_VorbisHWDecodeUnavailable, ErrorCode_ExternalSourceNoMemorySize, ErrorCode_MonitorQueueFull, ErrorCode_MonitorMsgTooLarge,
  ErrorCode_NonCompliantDeviceMemory, ErrorCode_JobWorkerFuncCallMismatch, ErrorCode_JobMgrOutOfMemory, ErrorCode_InvalidFileSize,
  ErrorCode_PluginMsg, ErrorCode_SinkOpenSL, ErrorCode_AudioOutOfRange, ErrorCode_AudioOutOfRangeOnBus,
  ErrorCode_AudioOutOfRangeOnBusFx, ErrorCode_AudioOutOfRangeRay, ErrorCode_UnknownDialogueEvent, ErrorCode_FailedPostingEvent,
  ErrorCode_OutputDeviceInitializationFailed, ErrorCode_UnloadBankFailed, ErrorCode_PluginFileNotFound, ErrorCode_PluginFileIncompatible,
  ErrorCode_PluginFileNotEnoughMemoryToStart, ErrorCode_PluginFileInvalid, ErrorCode_PluginFileRegisterFailed, ErrorCode_UnknownArgument,
  ErrorCode_DynamicSequenceAlreadyClosed, ErrorCode_PendingActionDestroyed, ErrorCode_CrossFadeTransitionIgnored, ErrorCode_MusicRendererSeekingFailed,
  ErrorCode_DynamicSequenceIdNotFound, ErrorCode_BusNotFoundByName, ErrorCode_AudioDeviceShareSetNotFound, ErrorCode_AudioDeviceShareSetNotFoundByName,
  ErrorCode_SoundEngineTooManyGameObjects, ErrorCode_SoundEngineTooManyPositions, ErrorCode_SoundEngineCantCallOnChildBus, ErrorCode_SoundEnginePlayingIdNotFound,
  ErrorCode_SoundEngineInvalidTransform, ErrorCode_SoundEngineTooManyEventPosts, ErrorCode_AudioSubsystemStoppedResponding, ErrorCode_NotEnoughMemInFunction,
  ErrorCode_FXNotFound, ErrorCode_SetMixerNotABus, ErrorCode_AudioNodeNotFound, ErrorCode_SetMixerFailed,
  ErrorCode_SetBusConfigUnsupported, ErrorCode_BusNotFound, ErrorCode_MismatchingMediaSize, ErrorCode_IncompatibleBankVersion,
  ErrorCode_UnexpectedPrepareGameSyncsCall, ErrorCode_MusicEngineNotInitialized, ErrorCode_LoadingBankMismatch, ErrorCode_MasterBusStructureNotLoaded,
  ErrorCode_TooManyChildren, ErrorCode_BankContainUneditableEffect, ErrorCode_MemoryAllocationFailed, ErrorCode_InvalidFloatPriority,
  ErrorCode_SoundLoadFailedInsufficientMemory, ErrorCode_NXDeviceRegistrationFailed, ErrorCode_MixPluginOnObjectBus, ErrorCode_XboxXMAVoiceResetFailed,
  ErrorCode_XboxACPMessage, ErrorCode_XboxFrameDropped, ErrorCode_XboxACPError, ErrorCode_XboxXMAFatalError,
  ErrorCode_MissingMusicNodeParent, ErrorCode_HardwareOpusDecoderError, ErrorCode_SetGeometryTooManyTriangleConnected, ErrorCode_SetGeometryTriangleTooLarge,
  ErrorCode_SetGeometryFailed, ErrorCode_RemovingGeometrySetFailed, ErrorCode_SetGeometryInstanceFailed, ErrorCode_RemovingGeometryInstanceFailed,
  ErrorCode_RevertingToDefaultAudioDevice, ErrorCode_RevertingToDummyAudioDevice, ErrorCode_AudioThreadSuspended, ErrorCode_AudioThreadResumed,
  ErrorCode_ResetPlaylistActionIgnoredGlobalScope, ErrorCode_ResetPlaylistActionIgnoredContinuous, ErrorCode_PlayingTriggerRateNotSupported, ErrorCode_SetGeometryTriangleIsSkipped,
  ErrorCode_SetGeometryInstanceInvalidTransform, ErrorCode_SetGameObjectRadiusSizeError, ErrorCode_SetPortalNonDistinctRoom, ErrorCode_SetPortalInvalidExtent,
  ErrorCode_SpatialAudio_PortalNotFound, ErrorCode_InvalidFloatInFunction, ErrorCode_FLTMAXNotSupported, ErrorCode_CannotInitializeAmbisonicChannelConfiguration,
  ErrorCode_CannotInitializePassthrough, ErrorCode_3DAudioUnsupportedSize, ErrorCode_AmbisonicNotAvailable, ErrorCode_NoAudioDevice,
  ErrorCode_Support, ErrorCode_ReplayMessage, ErrorCode_GameMessage, ErrorCode_TestMessage,
  ErrorCode_TranslatorStandardTagTest, ErrorCode_TranslatorWwiseTagTest, ErrorCode_TranslatorStringSizeTest, ErrorCode_InvalidParameter,
  ErrorCode_MaxAudioObjExceeded, ErrorCode_MMSNotEnabled, ErrorCode_NotEnoughSystemObj, ErrorCode_NotEnoughSystemObjWin,
  ErrorCode_TransitionNotAccurateSourceTooShort, ErrorCode_AlreadyInitialized, ErrorCode_WrongNumberOfArguments, ErrorCode_DataAlignement,
  ErrorCode_PluginMsgWithShareSet, ErrorCode_SoundEngineNotInit, ErrorCode_NoDefaultSwitch, ErrorCode_CantSetBoundSwitch,
  ErrorCode_IODeviceInitFailed, ErrorCode_SwitchListEmpty, ErrorCode_NoSwitchSelected, ErrorCode_FilePermissionError,
  ErrorCode_SetEffectOnRendered, ErrorCode_GeometryNotWatertight, ErrorCode_CannotInitialize3DAudio, ErrorCode_CannotInitializeInputCallbacks,
  ErrorCode_CannotConnectAVAudioEngineSource, ErrorCode_ChannelConfigRequestDenied, ErrorCode_MediaUpdatedFromWwise, ErrorCode_MediaErrorFromWwise,
  ErrorCode_OutputAlreadyExists, ErrorCode_UnknownStateGroup, ErrorCode_MediaErrorWwiseMRUFull, ErrorCode_AudioOut2ContextCreateError,
  ErrorCode_AudioOut2UserCreateError, ErrorCode_FeedbackOnAudioObjectsBus, ErrorCode_AssetSwapEnabled, ErrorCode_SpatialAudio_SiblingPortal,
  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 PostCodeVarArg (ErrorCode in_eError, ErrorLevel in_eErrorLevel, MsgContext msgContext,...)
 
AKSOUNDENGINE_API AKRESULT PostCodeVaList (ErrorCode in_eError, ErrorLevel in_eErrorLevel, MsgContext msgContext, ::va_list args)
 
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 AKRESULT AddTranslator (AkErrorMessageTranslator *translator, bool overridePreviousTranslators=false)
 
AKSOUNDENGINE_API AKRESULT ResetTranslator ()
 
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 MonitorErrorInfo 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