_ak_monitor_error_8h

Wwise SDK 2023.1.9

 /*******************************************************************************
 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
 released in source code form as part of the SDK installer package.
  
 Commercial License Usage
  
 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
 may use this file in accordance with the end user license agreement provided 
 with the software or, alternatively, in accordance with the terms contained in a
 written agreement between you and Audiokinetic Inc.
  
 Apache License Usage
  
 Alternatively, this file may be used under the Apache License, Version 2.0 (the 
 "Apache License"); you may not use this file except in compliance with the 
 Apache License. You may obtain a copy of the Apache License at 
 http://www.apache.org/licenses/LICENSE-2.0.
  
 Unless required by applicable law or agreed to in writing, software distributed
 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
 the specific language governing permissions and limitations under the License.
  
   Copyright (c) 2024 Audiokinetic Inc.
 *******************************************************************************/
  
 #ifndef _AKMONITORERROR_H
 #define _AKMONITORERROR_H
  
 #include <AK/SoundEngine/Common/AkSoundEngineExport.h>
 #include <AK/SoundEngine/Common/AkTypes.h>
 #define ERROR_CODE_DEF( in_name, in_msg ){ MonitorErrorInfo(in_name, in_msg)  }
  
 struct AkStreamMgrSettings;
 struct AkDeviceSettings;
 class AkErrorMessageTranslator;
  
 namespace AK
 {
     // Error monitoring.
  
     namespace Monitor
     {
         // This structure contains information related to the error message
         struct MsgContext
         {
             MsgContext(AkPlayingID pId = AK_INVALID_PLAYING_ID, AkGameObjectID goId = AK_INVALID_GAME_OBJECT, AkUniqueID nodeId = AK_INVALID_UNIQUE_ID, bool isBus = false)
                 :   in_playingID{ pId },
                     in_gameObjID{ goId },
                     in_soundID{ nodeId },
                     in_bIsBus{ isBus }
             {}
  
             AkPlayingID in_playingID;       ///< Related Playing ID if applicable
             AkGameObjectID in_gameObjID;    ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
             AkUniqueID in_soundID;          ///< Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise
             bool in_bIsBus;                 ///< true if in_audioNodeID is a bus
         };
  
         struct MonitorErrorInfo
         {
             MonitorErrorInfo(const AkOSChar* in_name = nullptr, const AkOSChar* in_message= nullptr)
                 :   m_name{ in_name },
                     m_message{in_message}
  
             {}
             const AkOSChar* m_name;
             const AkOSChar* m_message;
         };
  
         ///  ErrorLevel
         enum ErrorLevel
         {
             ErrorLevel_Message  = (1<<0), // used as bitfield
             ErrorLevel_Error    = (1<<1),
             
             ErrorLevel_All = ErrorLevel_Message | ErrorLevel_Error
         };
         /// ErrorCode
         enum ErrorCode
         {
             ErrorCode_NoError = 0, // 0-based index into AK::Monitor::s_aszMonitorErrorInfos table 
             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,    //To be used by the Capture Log to replace ErrorCode_UnknownGameObject
             ErrorCode_DeadGameObject,               //To be used by the Capture Log to replace ErrorCode_UnknownGameObject
             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,         //Deprecated Opus error.
  
             ErrorCode_AudioDeviceInitFailure,
             ErrorCode_AudioDeviceRemoveFailure,
             ErrorCode_AudioDeviceNotFound,
             ErrorCode_AudioDeviceNotValid,
  
             ErrorCode_SpatialAudio_ListenerAutomationNotSupported,
             ErrorCode_MediaDuplicationLength,
  
             ErrorCode_HwVoicesSystemInitFailed, // When the hardware-accelerated subsystem fails to initialize
             ErrorCode_HwVoicesDecodeBatchFailed, // When a grouping of hardware-accelerated voices fail to decode collectively
             ErrorCode_HwVoiceLimitReached, // Cannot create any more hardware-accelerated voices
             ErrorCode_HwVoiceInitFailed, // A hardware-accelerated voice fails to be created, but not because the max number of voices was reached
  
             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,
  
             //MONITOR_ERRORMSG
             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,
             
             //AkSpatialAudio:AkMonitorError_WithID
             ErrorCode_SetGameObjectRadiusSizeError,
             ErrorCode_SetPortalNonDistinctRoom,
             ErrorCode_SetPortalInvalidExtent,
             ErrorCode_SpatialAudio_PortalNotFound,
  
             //Invalid float
             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,
  
             // ALWAYS ADD NEW CODES AT THE END !!!!!!!
             // Otherwise it may break comm compatibility in a patch
  
             Num_ErrorCodes // THIS STAYS AT END OF ENUM
         };
  
         static_assert(Num_ErrorCodes == 228,
             "Please document your new ErrorCode "
             "in 'Documentation/Help/source_en/reference/common_errors_capture_log.xml', "
             "then you can increment this value."
         );
  
         /// Function prototype of local output function pointer.
         AK_CALLBACK( void, LocalOutputFunc )(
             ErrorCode in_eErrorCode,    ///< Error code number value
             const AkOSChar* in_pszError,    ///< Message or error string to be displayed
             ErrorLevel in_eErrorLevel,  ///< Specifies whether it should be displayed as a message or an error
             AkPlayingID in_playingID,   ///< Related Playing ID if applicable, AK_INVALID_PLAYING_ID otherwise
             AkGameObjectID in_gameObjID ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
             );
  
         extern const MonitorErrorInfo s_aszMonitorErrorInfos[ Num_ErrorCodes ];
  
         /// Post a monitoring message or error code. This will be displayed in the Wwise capture
         /// log. Since this function doesn't send variable arguments, be sure that the error code you're posting doesn't contain any tag.
         /// Otherwise, there'll be an undefined behavior
         /// \return AK_Success if successful, AK_Fail if there was a problem posting the message.
         ///         In optimized mode, this function returns AK_NotCompatible.
         /// \remark This function is provided as a tracking tool only. It does nothing if it is 
         ///         called in the optimized/release configuration and return AK_NotCompatible.
         AK_EXTERNAPIFUNC( AKRESULT, PostCode )( 
             ErrorCode in_eError,        ///< Message or error code to be displayed
             ErrorLevel in_eErrorLevel,  ///< Specifies whether it should be displayed as a message or an error
             AkPlayingID in_playingID = AK_INVALID_PLAYING_ID,   ///< Related Playing ID if applicable
             AkGameObjectID in_gameObjID = AK_INVALID_GAME_OBJECT, ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
             AkUniqueID in_audioNodeID = AK_INVALID_UNIQUE_ID, ///< Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise
             bool in_bIsBus = false      ///< true if in_audioNodeID is a bus
             );
  
         AK_EXTERNAPIFUNC(AKRESULT, PostCodeVarArg)(
             ErrorCode in_eError,        ///< Error code to be displayed. This code corresponds to a predefined message, that may have parameters that can be passed in the variable arguments. Check the message format at the end of AkMonitorError.h.
             ErrorLevel in_eErrorLevel,  ///< Specifies whether it should be displayed as a message or an error
             MsgContext msgContext,      ///< The message context containing the following information : Related Playing ID if applicable, Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise,  Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise and whether if in_audioNodeID is a bus
             ...                         ///< The variable arguments, depending on the ErrorCode posted.
             );
  
         /// Post a monitoring message. This will be displayed in the Wwise capture log.
         /// \return AK_Success if successful, AK_Fail if there was a problem posting the message.
         ///         In optimized mode, this function returns AK_NotCompatible.
         /// \remark This function is provided as a tracking tool only. It does nothing if it is 
         ///         called in the optimized/release configuration and return AK_NotCompatible.
         AK_EXTERNAPIFUNC(AKRESULT, PostCodeVaList)(
             ErrorCode in_eError,        ///< Error code to be displayed. This code corresponds to a predefined message, that may have parameters that can be passed in the variable arguments. Check the message format at the end of AkMonitorError.h.
             ErrorLevel in_eErrorLevel,  ///< Specifies whether it should be displayed as a message or an error
             MsgContext msgContext,      ///< The message context containing the following information : Related Playing ID if applicable, Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise,  Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise and whether if in_audioNodeID is a bus
             ::va_list args              ///< The variable arguments, depending on the ErrorCode posted.
             );
  
 #ifdef AK_SUPPORT_WCHAR
         /// Post a unicode monitoring message or error string. This will be displayed in the Wwise capture
         /// log.
         /// \return AK_Success if successful, AK_Fail if there was a problem posting the message.
         ///         In optimized mode, this function returns AK_NotCompatible.
         /// \remark This function is provided as a tracking tool only. It does nothing if it is 
         ///         called in the optimized/release configuration and return AK_NotCompatible.
         AK_EXTERNAPIFUNC( AKRESULT, PostString )( 
             const wchar_t* in_pszError, ///< Message or error string to be displayed
             ErrorLevel in_eErrorLevel,  ///< Specifies whether it should be displayed as a message or an error
             AkPlayingID in_playingID = AK_INVALID_PLAYING_ID,   ///< Related Playing ID if applicable
             AkGameObjectID in_gameObjID = AK_INVALID_GAME_OBJECT, ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
             AkUniqueID in_audioNodeID = AK_INVALID_UNIQUE_ID, ///< Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise
             bool in_bIsBus = false      ///< true if in_audioNodeID is a bus
             );
  
 #endif // #ifdef AK_SUPPORT_WCHAR
  
         /// Post a monitoring message or error string. This will be displayed in the Wwise capture
         /// log.
         /// \return AK_Success if successful, AK_Fail if there was a problem posting the message.
         ///         In optimized mode, this function returns AK_NotCompatible.
         /// \remark This function is provided as a tracking tool only. It does nothing if it is 
         ///         called in the optimized/release configuration and return AK_NotCompatible.
         AK_EXTERNAPIFUNC( AKRESULT, PostString )( 
             const char* in_pszError,    ///< Message or error string to be displayed
             ErrorLevel in_eErrorLevel,  ///< Specifies whether it should be displayed as a message or an error
             AkPlayingID in_playingID = AK_INVALID_PLAYING_ID,   ///< Related Playing ID if applicable
             AkGameObjectID in_gameObjID = AK_INVALID_GAME_OBJECT, ///< Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
             AkUniqueID in_audioNodeID = AK_INVALID_UNIQUE_ID, ///< Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise
             bool in_bIsBus = false      ///< true if in_audioNodeID is a bus
             );
  
         /// Enable/Disable local output of monitoring messages or errors. Pass 0 to disable,
         /// or any combination of ErrorLevel_Message and ErrorLevel_Error to enable. 
         /// \return AK_Success.
         ///         In optimized/release configuration, this function returns AK_NotCompatible.
         AK_EXTERNAPIFUNC( AKRESULT, SetLocalOutput )(
             AkUInt32 in_uErrorLevel = ErrorLevel_All, ///< ErrorLevel(s) to enable in output. Default parameters enable all.
             LocalOutputFunc in_pMonitorFunc = 0       ///< Handler for local output. If NULL, the standard platform debug output method is used.
             );
  
         /// Add a translator to the wwiseErrorHandler
         /// The additional translators increase the chance of a monitoring messages or errors
         /// to be succeffully translated.
         /// \return AK_Success.
         /// In optimized/release configuration, this function returns AK_NotCompatible.
         AK_EXTERNAPIFUNC( AKRESULT, AddTranslator )(
             AkErrorMessageTranslator* translator,   ///< The AkErrorMessageTranslator to add to the WwiseErrorHandler
             bool overridePreviousTranslators = false        ///< Whether or not the newly added translator should override all the previous translators. 
                                                             ///< In both cases, the default translator will remain
             );
  
         /// Reset the wwiseErrorHandler to only using the default translator
         /// \return AK_Success.
         /// In optimized/release configuration, this function returns AK_NotCompatible.
         AK_EXTERNAPIFUNC(AKRESULT, ResetTranslator)(
             );
  
         /// Get the time stamp shown in the capture log along with monitoring messages.
         /// \return Time stamp in milliseconds.
         ///         In optimized/release configuration, this function returns 0.
         AK_EXTERNAPIFUNC( AkTimeMs, GetTimeStamp )();
  
         /// Add the streaming manager settings to the profiler capture.
         AK_EXTERNAPIFUNC(void, MonitorStreamMgrInit)(
             const AkStreamMgrSettings& in_streamMgrSettings
             );
  
         /// Add device settings to the list of active streaming devices.
         /// The list of streaming devices and their settings will be 
         /// sent to the profiler capture when remote connecting from Wwise.
         /// 
         /// \remark \c AK::Monitor::MonitorStreamMgrTerm must be called to
         ///         clean-up memory used to keep track of active streaming devices.
         AK_EXTERNAPIFUNC(void, MonitorStreamingDeviceInit)(
             AkDeviceID in_deviceID,
             const AkDeviceSettings& in_deviceSettings 
             );
  
         /// Remove streaming device entry from the list of devices
         /// to send when remote connecting from Wwise.
         AK_EXTERNAPIFUNC(void, MonitorStreamingDeviceDestroyed)(
             AkDeviceID in_deviceID
             );
  
         /// Monitor streaming manager destruction as part of the
         /// profiler capture.
         /// 
         /// \remark This function must be called to clean-up memory used by
         ///         \c AK::Monitor::MonitorStreamingDeviceInit and \c AK::Monitor::MonitorStreamingDeviceTerm
         ///         to keep track of active streaming devices.
         AK_EXTERNAPIFUNC(void, MonitorStreamMgrTerm)();
     }
 }
  
 // Macros.
 #ifndef AK_OPTIMIZED
     #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()
 #else
     #define AK_MONITOR_ERROR( in_eErrorCode )
     #define AK_MONITOR_STREAM_MGR_INIT( in_streamMgrSettings )
     #define AK_MONITOR_STREAMING_DEVICE_INIT( in_deviceID, in_deviceSettings )
     #define AK_MONITOR_STREAMING_DEVICE_DESTROYED( in_deviceID )
     #define AK_MONITOR_STREAM_MGR_TERM( )
 #endif
  
 #ifdef AK_MONITOR_IMPLEMENT_ERRORCODES
 #include <AK/Tools/Common/AkMonitorErrorImpl.h>
 #endif // AK_MONITOR_IMPLEMENT_ERRORCODES
  
 #endif // _AKMONITORERROR_H

AK::Monitor::ErrorCode_TooManyChildren

@ ErrorCode_TooManyChildren

Definition: AkMonitorError.h:281

AK::Monitor::ErrorCode_SetEffectOnRendered

@ ErrorCode_SetEffectOnRendered

Definition: AkMonitorError.h:360

AK::Monitor::ErrorCode_CannotScheduleMusicSwitch

@ ErrorCode_CannotScheduleMusicSwitch

Definition: AkMonitorError.h:117

AK::Monitor::ErrorCode_FailedPostingEvent

@ ErrorCode_FailedPostingEvent

Definition: AkMonitorError.h:234

AK::Monitor::ErrorCode_SoundEnginePlayingIdNotFound

@ ErrorCode_SoundEnginePlayingIdNotFound

Definition: AkMonitorError.h:260

AK::Monitor::ErrorCode_AmbisonicNotAvailable

@ ErrorCode_AmbisonicNotAvailable

Definition: AkMonitorError.h:327

AK::Monitor::ErrorCode

ErrorCode

ErrorCode.

Definition: AkMonitorError.h:81

AK::Monitor::PostCodeVaList

AKSOUNDENGINE_API AKRESULT PostCodeVaList(ErrorCode in_eError, ErrorLevel in_eErrorLevel, MsgContext msgContext, ::va_list args)

AK::Monitor::ErrorCode_PendingActionDestroyed

@ ErrorCode_PendingActionDestroyed

Definition: AkMonitorError.h:247

AK::Monitor::ErrorCode_3DObjectLimitExceeded

@ ErrorCode_3DObjectLimitExceeded

Definition: AkMonitorError.h:200

AK::Monitor::ErrorCode_GeometryNotWatertight

@ ErrorCode_GeometryNotWatertight

Definition: AkMonitorError.h:361

AK::Monitor::ErrorCode_SetPortalInvalidExtent

@ ErrorCode_SetPortalInvalidExtent

Definition: AkMonitorError.h:316

AK::Monitor::MsgContext::in_gameObjID

AkGameObjectID in_gameObjID

Related Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise.

Definition: AkMonitorError.h:55

AK::Monitor::ErrorCode_MusicEngineNotInitialized

@ ErrorCode_MusicEngineNotInitialized

Definition: AkMonitorError.h:277

AK::Monitor::ErrorCode_PluginProcessingFailed

@ ErrorCode_PluginProcessingFailed

Definition: AkMonitorError.h:92

AK::Monitor::ErrorCode_NXDeviceRegistrationFailed

@ ErrorCode_NXDeviceRegistrationFailed

Definition: AkMonitorError.h:286

AK::Monitor::ErrorCode_SetGeometryInstanceFailed

@ ErrorCode_SetGeometryInstanceFailed

Definition: AkMonitorError.h:300

AK::Monitor::Num_ErrorCodes

@ Num_ErrorCodes

Definition: AkMonitorError.h:384

AK::Monitor::ErrorCode_ResetPlaylistActionIgnoredGlobalScope

@ ErrorCode_ResetPlaylistActionIgnoredGlobalScope

Definition: AkMonitorError.h:307

AK::Monitor::LocalOutputFunc

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.

Definition: AkMonitorError.h:394

AK::Monitor::ErrorCode_CannotInitialize3DAudio

@ ErrorCode_CannotInitialize3DAudio

Definition: AkMonitorError.h:363

AkTimeMs

AkInt32 AkTimeMs

Time in ms.

Definition: AkTypes.h:56

Audiokinetic namespace.

Definition: AkWwiseSDKVersion.cs:31

AK::Monitor::ErrorCode_TooLongSegmentLookAhead

@ ErrorCode_TooLongSegmentLookAhead

Definition: AkMonitorError.h:116

AK::Monitor::ErrorCode_StreamingSourceStarving

@ ErrorCode_StreamingSourceStarving

Definition: AkMonitorError.h:128

AK::Monitor::ErrorCode_PluginUnsupportedChannelConfiguration

@ ErrorCode_PluginUnsupportedChannelConfiguration

Definition: AkMonitorError.h:89

AK::Monitor::ErrorCode_NoAudioDevice

@ ErrorCode_NoAudioDevice

Definition: AkMonitorError.h:329

AK::Monitor::ErrorCode_RevertingToDefaultAudioDevice

@ ErrorCode_RevertingToDefaultAudioDevice

Definition: AkMonitorError.h:303

AK::Monitor::ErrorCode_CrossFadeTransitionIgnored

@ ErrorCode_CrossFadeTransitionIgnored

Definition: AkMonitorError.h:248

AK::Monitor::ErrorCode_FileNotFound

@ ErrorCode_FileNotFound

Definition: AkMonitorError.h:83

AK.Wwise::Plugin::Notifications::Monitor

V1::Notifications::Monitor Monitor

Latest version of the C++ Monitor notification interface.

Definition: Notifications.h:203

AK::Monitor::ErrorCode_PluginFileRegisterFailed

@ ErrorCode_PluginFileRegisterFailed

Definition: AkMonitorError.h:242

AK::Monitor::ErrorCode_TooManySimultaneousMusicSegments

@ ErrorCode_TooManySimultaneousMusicSegments

Definition: AkMonitorError.h:118

AK::Monitor::ErrorCode_BusNotFound

@ ErrorCode_BusNotFound

Definition: AkMonitorError.h:272

AK::Monitor::ErrorCode_CannotStartStreamNoMemory

@ ErrorCode_CannotStartStreamNoMemory

Definition: AkMonitorError.h:85

AK::Monitor::ErrorCode_DataAlignement

@ ErrorCode_DataAlignement

Definition: AkMonitorError.h:350

AK::Monitor::ErrorCode_BankLoadFailed

@ ErrorCode_BankLoadFailed

Definition: AkMonitorError.h:144

AK::Monitor::ErrorCode_JobMgrOutOfMemory

@ ErrorCode_JobMgrOutOfMemory

Definition: AkMonitorError.h:222

AK::Monitor::ErrorCode_SoundEngineCantCallOnChildBus

@ ErrorCode_SoundEngineCantCallOnChildBus

Definition: AkMonitorError.h:259

AK::Monitor::ErrorCode_UnknownDialogueEvent

@ ErrorCode_UnknownDialogueEvent

Definition: AkMonitorError.h:233

AK::Monitor::ErrorCode_SpatialAudio_ListenerAutomationNotSupported

@ ErrorCode_SpatialAudio_ListenerAutomationNotSupported

Definition: AkMonitorError.h:188

AK::Monitor::ErrorCode_XboxXMAFatalError

@ ErrorCode_XboxXMAFatalError

Definition: AkMonitorError.h:293

AK::Monitor::MonitorErrorInfo::MonitorErrorInfo

MonitorErrorInfo(const AkOSChar *in_name=nullptr, const AkOSChar *in_message=nullptr)

Definition: AkMonitorError.h:62

AK::Monitor::ErrorCode_CannotSeekContinuous

@ ErrorCode_CannotSeekContinuous

Definition: AkMonitorError.h:151

AK::Monitor::ErrorCode_InvalidFloatInFunction

@ ErrorCode_InvalidFloatInFunction

Definition: AkMonitorError.h:320

AK::Monitor::ErrorCode_ATRAC9LoopSectionTooSmall

@ ErrorCode_ATRAC9LoopSectionTooSmall

Definition: AkMonitorError.h:101

AkErrorMessageTranslator

Definition: AkErrorMessageTranslator.h:24

AK::Monitor::MonitorErrorInfo

Definition: AkMonitorError.h:61

AK::Monitor::ErrorCode_TranslatorWwiseTagTest

@ ErrorCode_TranslatorWwiseTagTest

Definition: AkMonitorError.h:336

AK::Monitor::ErrorCode_SoundLoadFailedInsufficientMemory

@ ErrorCode_SoundLoadFailedInsufficientMemory

Definition: AkMonitorError.h:285

AK::Monitor::ErrorCode_UnknownStateGroup

@ ErrorCode_UnknownStateGroup

Definition: AkMonitorError.h:371

AK::Monitor::ErrorCode_SeekNoMarker

@ ErrorCode_SeekNoMarker

Definition: AkMonitorError.h:150

AK::Monitor::AddTranslator

AKSOUNDENGINE_API AKRESULT AddTranslator(AkErrorMessageTranslator *translator, bool overridePreviousTranslators=false)

AK::Monitor::ErrorCode_HardwareOpusDecoderError

@ ErrorCode_HardwareOpusDecoderError

Definition: AkMonitorError.h:295

AK::Monitor::ErrorCode_PluginVersionMismatch

@ ErrorCode_PluginVersionMismatch

Definition: AkMonitorError.h:135

AK::Monitor::ErrorCode_OutputAlreadyExists

@ ErrorCode_OutputAlreadyExists

Definition: AkMonitorError.h:370

AK::Monitor::ErrorCode_AudioFileHeaderTooLarge

@ ErrorCode_AudioFileHeaderTooLarge

Definition: AkMonitorError.h:104

AK::Monitor::SetLocalOutput

AKSOUNDENGINE_API AKRESULT SetLocalOutput(AkUInt32 in_uErrorLevel=ErrorLevel_All, LocalOutputFunc in_pMonitorFunc=0)

AK::Monitor::ErrorCode_UnknownOpusError

@ ErrorCode_UnknownOpusError

Definition: AkMonitorError.h:181

AK::Monitor::ErrorCode_RevertingToDummyAudioDevice

@ ErrorCode_RevertingToDummyAudioDevice

Definition: AkMonitorError.h:304

AK::Monitor::ErrorCode_MasterBusStructureNotLoaded

@ ErrorCode_MasterBusStructureNotLoaded

Definition: AkMonitorError.h:280

AK::Monitor::ErrorCode_EventIDNotFound

@ ErrorCode_EventIDNotFound

Definition: AkMonitorError.h:137

AK::Monitor::ErrorCode_PluginInitialisationFailed

@ ErrorCode_PluginInitialisationFailed

Definition: AkMonitorError.h:91

AK::Monitor::ErrorCode_MonitorMsgTooLarge

@ ErrorCode_MonitorMsgTooLarge

Definition: AkMonitorError.h:217

AK::Monitor::ErrorCode_PlayingTriggerRateNotSupported

@ ErrorCode_PlayingTriggerRateNotSupported

Definition: AkMonitorError.h:309

AkGameObjectID

AkUInt64 AkGameObjectID

Game object ID.

Definition: AkTypes.h:60

AK::Monitor::ErrorCode_HwVoiceLimitReached

@ ErrorCode_HwVoiceLimitReached

Definition: AkMonitorError.h:193

AK::Monitor::ErrorCode_PlaylistStoppedForEditing

@ ErrorCode_PlaylistStoppedForEditing

Definition: AkMonitorError.h:119

AK::Monitor::ErrorCode_AudioThreadSuspended

@ ErrorCode_AudioThreadSuspended

Definition: AkMonitorError.h:305

AK::Monitor::ErrorCode_ModulatorScopeError_Inst

@ ErrorCode_ModulatorScopeError_Inst

Definition: AkMonitorError.h:168

AK::Monitor::ErrorCode_SoundEngineTooManyPositions

@ ErrorCode_SoundEngineTooManyPositions

Definition: AkMonitorError.h:258

AK_EXTERNAPIFUNC

#define AK_EXTERNAPIFUNC(_type, _name)

Definition: AkSoundEngineExport.h:81

AK::Monitor::ErrorCode_TransitionNotAccurateChannel

@ ErrorCode_TransitionNotAccurateChannel

Definition: AkMonitorError.h:107

AK::Monitor::ErrorCode_SetGeometryInstanceInvalidTransform

@ ErrorCode_SetGeometryInstanceInvalidTransform

Definition: AkMonitorError.h:311

AK::Monitor::ErrorCode_AudioSubsystemStoppedResponding

@ ErrorCode_AudioSubsystemStoppedResponding

Definition: AkMonitorError.h:264

AKRESULT

Standard function call result.

Definition: AkTypes.h:131

AK::Monitor::ErrorCode_SeekAfterEof

@ ErrorCode_SeekAfterEof

Definition: AkMonitorError.h:152

AkDeviceID

AkUInt32 AkDeviceID

I/O device ID.

Definition: AkTypes.h:78

AK::Monitor::ErrorCode_IncompatibleIOSettings

@ ErrorCode_IncompatibleIOSettings

Definition: AkMonitorError.h:87

AK::Monitor::ErrorCode_InsufficientSpaceToLoadBank

@ ErrorCode_InsufficientSpaceToLoadBank

Definition: AkMonitorError.h:146

AK::Monitor::ErrorCode_AudioNodeNotFound

@ ErrorCode_AudioNodeNotFound

Definition: AkMonitorError.h:269

AK::Monitor::ErrorLevel_All

@ ErrorLevel_All

Definition: AkMonitorError.h:77

AK::Monitor::ErrorCode_CannotPlaySource_VirtualOff

@ ErrorCode_CannotPlaySource_VirtualOff

Definition: AkMonitorError.h:123

AK::Monitor::ErrorCode_ResetPlaylistActionIgnoredContinuous

@ ErrorCode_ResetPlaylistActionIgnoredContinuous

Definition: AkMonitorError.h:308

AK::Monitor::ErrorCode_MediaUpdatedFromWwise

@ ErrorCode_MediaUpdatedFromWwise

Definition: AkMonitorError.h:368

AkMonitorErrorImpl.h

AK::Monitor::ErrorCode_MediaDuplicationLength

@ ErrorCode_MediaDuplicationLength

Definition: AkMonitorError.h:189

AK::Monitor::ErrorCode_CannotPlaySource_Create

@ ErrorCode_CannotPlaySource_Create

Definition: AkMonitorError.h:122

AK::Monitor::ErrorCode_InvalidParameter

@ ErrorCode_InvalidParameter

Definition: AkMonitorError.h:339

AkOSChar

char AkOSChar

Generic character string.

Definition: AkTypes.h:60

AK::Monitor::MonitorStreamingDeviceInit

AKSOUNDENGINE_API void MonitorStreamingDeviceInit(AkDeviceID in_deviceID, const AkDeviceSettings &in_deviceSettings)

AK::Monitor::ErrorCode_MemoryAllocationFailed

@ ErrorCode_MemoryAllocationFailed

Definition: AkMonitorError.h:283

AK::Monitor::MsgContext::in_playingID

AkPlayingID in_playingID

Related Playing ID if applicable.

Definition: AkMonitorError.h:54

AkDeviceSettings

Definition: AkStreamMgrModule.h:59

AK::Monitor::ErrorCode_NothingToPlay

@ ErrorCode_NothingToPlay

Definition: AkMonitorError.h:112

AK::Monitor::ErrorCode_StingerCouldNotBeScheduled

@ ErrorCode_StingerCouldNotBeScheduled

Definition: AkMonitorError.h:115

AK::Monitor::MsgContext::in_bIsBus

bool in_bIsBus

true if in_audioNodeID is a bus

Definition: AkMonitorError.h:57

AK::Monitor::ErrorCode_XMAStreamBufferTooSmall

@ ErrorCode_XMAStreamBufferTooSmall

Definition: AkMonitorError.h:166

AK::Monitor::ErrorCode_ModulatorScopeError_Obj

@ ErrorCode_ModulatorScopeError_Obj

Definition: AkMonitorError.h:169

AK::Monitor::ErrorCode_CannotInitializeInputCallbacks

@ ErrorCode_CannotInitializeInputCallbacks

Definition: AkMonitorError.h:364

AK::Monitor::ErrorLevel_Message

@ ErrorLevel_Message

Definition: AkMonitorError.h:74

AK::Monitor::ErrorCode_AudioOut2ContextCreateError

@ ErrorCode_AudioOut2ContextCreateError

Definition: AkMonitorError.h:373

AK::Monitor::ErrorCode_SetMixerFailed

@ ErrorCode_SetMixerFailed

Definition: AkMonitorError.h:270

AK::Monitor::ErrorCode_SetGeometryTooManyTriangleConnected

@ ErrorCode_SetGeometryTooManyTriangleConnected

Definition: AkMonitorError.h:296

AK::Monitor::ErrorCode_AudioDeviceRemoveFailure

@ ErrorCode_AudioDeviceRemoveFailure

Definition: AkMonitorError.h:184

AK::Monitor::ErrorCode_MissingMusicNodeParent

@ ErrorCode_MissingMusicNodeParent

Definition: AkMonitorError.h:294

AK::Monitor::MonitorStreamMgrTerm

AKSOUNDENGINE_API void MonitorStreamMgrTerm()

AK::Monitor::ErrorCode_UnloadBankFailed

@ ErrorCode_UnloadBankFailed

Definition: AkMonitorError.h:236

AK::Monitor::ErrorCode_RemovingGeometrySetFailed

@ ErrorCode_RemovingGeometrySetFailed

Definition: AkMonitorError.h:299

AK::Monitor::ErrorCode_TransitionNotAccurateSourceTooShort

@ ErrorCode_TransitionNotAccurateSourceTooShort

Definition: AkMonitorError.h:346

AK::Monitor::ErrorCode_PluginFileInvalid

@ ErrorCode_PluginFileInvalid

Definition: AkMonitorError.h:241

AK::Monitor::ErrorCode_TranslatorStringSizeTest

@ ErrorCode_TranslatorStringSizeTest

Definition: AkMonitorError.h:337

AK::Monitor::MsgContext::in_soundID

AkUniqueID in_soundID

Related Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise.

Definition: AkMonitorError.h:56

AK::Monitor::ErrorCode_AudioDeviceShareSetNotFound

@ ErrorCode_AudioDeviceShareSetNotFound

Definition: AkMonitorError.h:254

AK::Monitor::ErrorCode_InvalidFileSize

@ ErrorCode_InvalidFileSize

Definition: AkMonitorError.h:224

AK::Monitor::ErrorCode_NonCompliantDeviceMemory

@ ErrorCode_NonCompliantDeviceMemory

Definition: AkMonitorError.h:219

AK::Monitor::ErrorCode_ExternalSourceNotResolved

@ ErrorCode_ExternalSourceNotResolved

Definition: AkMonitorError.h:159

AK::Monitor::ErrorCode_PluginMsg

@ ErrorCode_PluginMsg

Definition: AkMonitorError.h:225

AK::Monitor::ErrorCode_CannotOpenFile

@ ErrorCode_CannotOpenFile

Definition: AkMonitorError.h:84

AK::Monitor::ErrorCode_TransitionNotAccuratePluginMismatch

@ ErrorCode_TransitionNotAccuratePluginMismatch

Definition: AkMonitorError.h:108

AK::Monitor::ErrorCode_CannotConnectAVAudioEngineSource

@ ErrorCode_CannotConnectAVAudioEngineSource

Definition: AkMonitorError.h:365

AK::Monitor::ErrorCode_DynamicSequenceIdNotFound

@ ErrorCode_DynamicSequenceIdNotFound

Definition: AkMonitorError.h:252

AK::Monitor::ErrorCode_TranslatorStandardTagTest

@ ErrorCode_TranslatorStandardTagTest

Definition: AkMonitorError.h:335

AK::Monitor::ErrorCode_TransitionNotAccurateStarvation

@ ErrorCode_TransitionNotAccurateStarvation

Definition: AkMonitorError.h:110

AK::Monitor::ErrorCode_PluginMsgWithShareSet

@ ErrorCode_PluginMsgWithShareSet

Definition: AkMonitorError.h:351

AK::Monitor::ErrorCode_MusicRendererSeekingFailed

@ ErrorCode_MusicRendererSeekingFailed

Definition: AkMonitorError.h:249

AK::Monitor::ErrorCode_InvalidFloatPriority

@ ErrorCode_InvalidFloatPriority

Definition: AkMonitorError.h:284

AK::Monitor::ErrorCode_NoError

@ ErrorCode_NoError

Definition: AkMonitorError.h:82

AkUniqueID

AkUInt32 AkUniqueID

Unique 32-bit ID.

Definition: AkTypes.h:52

AK::Monitor::ErrorCode_SoundEngineNotInit

@ ErrorCode_SoundEngineNotInit

Definition: AkMonitorError.h:352

AK::Monitor::ErrorCode_SetGeometryTriangleTooLarge

@ ErrorCode_SetGeometryTriangleTooLarge

Definition: AkMonitorError.h:297

AK::Monitor::ErrorCode_UnknownArgument

@ ErrorCode_UnknownArgument

Definition: AkMonitorError.h:244

AK::Monitor::ErrorCode_SpatialAudio_SiblingPortal

@ ErrorCode_SpatialAudio_SiblingPortal

Definition: AkMonitorError.h:379

AK::Monitor::ErrorCode_SetBusConfigUnsupported

@ ErrorCode_SetBusConfigUnsupported

Definition: AkMonitorError.h:271

AK::Monitor::ErrorCode_TransitionNotAccurateRejectedByPlugin

@ ErrorCode_TransitionNotAccurateRejectedByPlugin

Definition: AkMonitorError.h:109

AK::Monitor::ErrorCode_MediaNotLoaded

@ ErrorCode_MediaNotLoaded

Definition: AkMonitorError.h:126

AK::Monitor::ErrorCode_AudioOutOfRangeOnBusFx

@ ErrorCode_AudioOutOfRangeOnBusFx

Definition: AkMonitorError.h:231

AK::Monitor::ErrorCode_DeadGameObject

@ ErrorCode_DeadGameObject

Definition: AkMonitorError.h:156

AK::Monitor::ErrorCode_MixPluginOnObjectBus

@ ErrorCode_MixPluginOnObjectBus

Definition: AkMonitorError.h:287

AK::Monitor::ErrorCode_AlreadyInitialized

@ ErrorCode_AlreadyInitialized

Definition: AkMonitorError.h:348

AK::Monitor::ErrorCode_SetGeometryFailed

@ ErrorCode_SetGeometryFailed

Definition: AkMonitorError.h:298

AK::Monitor::ErrorCode_VorbisSeekTableRecommended

@ ErrorCode_VorbisSeekTableRecommended

Definition: AkMonitorError.h:96

AK::Monitor::ErrorCode_NotEnoughSystemObjWin

@ ErrorCode_NotEnoughSystemObjWin

Definition: AkMonitorError.h:344

AK::Monitor::ErrorCode_NotEnoughMemInFunction

@ ErrorCode_NotEnoughMemInFunction

Definition: AkMonitorError.h:266

AK::Monitor::MonitorErrorInfo::m_message

const AkOSChar * m_message

Definition: AkMonitorError.h:68

AK::Monitor::PostCodeVarArg

AKSOUNDENGINE_API AKRESULT PostCodeVarArg(ErrorCode in_eError, ErrorLevel in_eErrorLevel, MsgContext msgContext,...)

AK::Monitor::ErrorCode_CommandQueueFull

@ ErrorCode_CommandQueueFull

Definition: AkMonitorError.h:162

AK::Monitor::ErrorCode_HwVoicesSystemInitFailed

@ ErrorCode_HwVoicesSystemInitFailed

Definition: AkMonitorError.h:191

AK::Monitor::ErrorCode_VorbisHWDecodeUnavailable

@ ErrorCode_VorbisHWDecodeUnavailable

Definition: AkMonitorError.h:213

AK::Monitor::ErrorCode_XMADecoderSourceStarving

@ ErrorCode_XMADecoderSourceStarving

Definition: AkMonitorError.h:129

AK::Monitor::ErrorCode_NotEnoughMemoryToStart

@ ErrorCode_NotEnoughMemoryToStart

Definition: AkMonitorError.h:180

AK::Monitor::ErrorCode_ErrorWhileLoadingBank

@ ErrorCode_ErrorWhileLoadingBank

Definition: AkMonitorError.h:145

AK::Monitor::ErrorCode_MMSNotEnabled

@ ErrorCode_MMSNotEnabled

Definition: AkMonitorError.h:342

AK::Monitor::ErrorCode_RemovingGeometryInstanceFailed

@ ErrorCode_RemovingGeometryInstanceFailed

Definition: AkMonitorError.h:301

AK::Monitor::GetTimeStamp

AKSOUNDENGINE_API AkTimeMs GetTimeStamp()

AK::Monitor::ErrorCode_AudioDeviceNotFound

@ ErrorCode_AudioDeviceNotFound

Definition: AkMonitorError.h:185

AK::Monitor::ErrorCode_PluginMediaUnavailable

@ ErrorCode_PluginMediaUnavailable

Definition: AkMonitorError.h:90

AK::Monitor::ErrorCode_WrongNumberOfArguments

@ ErrorCode_WrongNumberOfArguments

Definition: AkMonitorError.h:349

AK::Monitor::ErrorCode_SinkOpenSL

@ ErrorCode_SinkOpenSL

Definition: AkMonitorError.h:228

AK::Monitor::MsgContext::MsgContext

MsgContext(AkPlayingID pId=AK_INVALID_PLAYING_ID, AkGameObjectID goId=AK_INVALID_GAME_OBJECT, AkUniqueID nodeId=AK_INVALID_UNIQUE_ID, bool isBus=false)

Definition: AkMonitorError.h:47

AkSoundEngineExport.h

AK::Monitor::ErrorCode_SetMixerNotABus

@ ErrorCode_SetMixerNotABus

Definition: AkMonitorError.h:268

AK::Monitor::ErrorCode_SoundEngineInvalidTransform

@ ErrorCode_SoundEngineInvalidTransform

Definition: AkMonitorError.h:261

AK::Monitor::ErrorCode_FeedbackOnAudioObjectsBus

@ ErrorCode_FeedbackOnAudioObjectsBus

Definition: AkMonitorError.h:376

AK::Monitor::s_aszMonitorErrorInfos

const MonitorErrorInfo s_aszMonitorErrorInfos[Num_ErrorCodes]

Definition: AkMonitorErrorImpl.h:37

AK::Monitor::ErrorCode_XboxACPMessage

@ ErrorCode_XboxACPMessage

Definition: AkMonitorError.h:290

AK::Monitor::ErrorCode_MediaErrorFromWwise

@ ErrorCode_MediaErrorFromWwise

Definition: AkMonitorError.h:369

AK::Monitor::ErrorCode_ChannelConfigRequestDenied

@ ErrorCode_ChannelConfigRequestDenied

Definition: AkMonitorError.h:367

AK::Monitor::ErrorCode_OpusDecodeError

@ ErrorCode_OpusDecodeError

Definition: AkMonitorError.h:174

AK::Monitor::ErrorCode_SetPortalNonDistinctRoom

@ ErrorCode_SetPortalNonDistinctRoom

Definition: AkMonitorError.h:315

AK::Monitor::ErrorCode_CantSetBoundSwitch

@ ErrorCode_CantSetBoundSwitch

Definition: AkMonitorError.h:354

AK::Monitor::ErrorLevel_Error

@ ErrorLevel_Error

Definition: AkMonitorError.h:75

AK::Monitor::ErrorCode_PluginFileNotFound

@ ErrorCode_PluginFileNotFound

Definition: AkMonitorError.h:238

AK::Monitor::ErrorCode_OpusRequireSeekTable

@ ErrorCode_OpusRequireSeekTable

Definition: AkMonitorError.h:173

AK::Monitor::ErrorCode_AudioDeviceNotValid

@ ErrorCode_AudioDeviceNotValid

Definition: AkMonitorError.h:186

AK::Monitor::ErrorCode_IODeviceInitFailed

@ ErrorCode_IODeviceInitFailed

Definition: AkMonitorError.h:355

AK::Monitor::ErrorCode_ReplayMessage

@ ErrorCode_ReplayMessage

Definition: AkMonitorError.h:332

AK_CALLBACK

#define AK_CALLBACK(_type, _name)

Definition: AkSoundEngineExport.h:87

AK::Monitor::ErrorCode_OutputDeviceInitializationFailed

@ ErrorCode_OutputDeviceInitializationFailed

Definition: AkMonitorError.h:235

AK::Monitor::ErrorCode_SpatialAudio_ReflectionBusError

@ ErrorCode_SpatialAudio_ReflectionBusError

Definition: AkMonitorError.h:211

AK::Monitor::ErrorCode_CannotPlaySource_InconsistentState

@ ErrorCode_CannotPlaySource_InconsistentState

Definition: AkMonitorError.h:125

AK::Monitor::ErrorCode_SelectedNodeNotAvailable

@ ErrorCode_SelectedNodeNotAvailable

Definition: AkMonitorError.h:140

AK::Monitor::ErrorCode_SetGameObjectRadiusSizeError

@ ErrorCode_SetGameObjectRadiusSizeError

Definition: AkMonitorError.h:314

AK::Monitor::ErrorCode_SetGeometryTriangleIsSkipped

@ ErrorCode_SetGeometryTriangleIsSkipped

Definition: AkMonitorError.h:310

AK_INVALID_UNIQUE_ID

static const AkUniqueID AK_INVALID_UNIQUE_ID

Invalid unique 32-bit ID.

Definition: AkTypes.h:95

AK::Monitor::ErrorCode_XMADecodingError

@ ErrorCode_XMADecodingError

Definition: AkMonitorError.h:130

AK::Monitor::ErrorCode_TestMessage

@ ErrorCode_TestMessage

Definition: AkMonitorError.h:334

AK::Monitor::ErrorCode_OpusHWFatalError

@ ErrorCode_OpusHWFatalError

Definition: AkMonitorError.h:202

AK::Monitor::ErrorCode_MediaErrorWwiseMRUFull

@ ErrorCode_MediaErrorWwiseMRUFull

Definition: AkMonitorError.h:372

AK::Monitor::ErrorCode_PluginCannotRunOnObjectConfig

@ ErrorCode_PluginCannotRunOnObjectConfig

Definition: AkMonitorError.h:210

AK::Monitor::ErrorCode_CannotInitializeAmbisonicChannelConfiguration

@ ErrorCode_CannotInitializeAmbisonicChannelConfiguration

Definition: AkMonitorError.h:324

AK::Monitor::ErrorCode_XboxFrameDropped

@ ErrorCode_XboxFrameDropped

Definition: AkMonitorError.h:291

AK::Monitor::ErrorCode_XMACreateDecoderLimitReached

@ ErrorCode_XMACreateDecoderLimitReached

Definition: AkMonitorError.h:165

AK_INVALID_PLAYING_ID

static const AkPlayingID AK_INVALID_PLAYING_ID

Invalid playing ID.

Definition: AkTypes.h:97

AK::Monitor::MonitorStreamMgrInit

AKSOUNDENGINE_API void MonitorStreamMgrInit(const AkStreamMgrSettings &in_streamMgrSettings)

Add the streaming manager settings to the profiler capture.

AK::Monitor::ErrorCode_GameObjectIsNotEmitter

@ ErrorCode_GameObjectIsNotEmitter

Definition: AkMonitorError.h:157

AK::Monitor::ErrorCode_HwVoiceInitFailed

@ ErrorCode_HwVoiceInitFailed

Definition: AkMonitorError.h:194

AK::Monitor::ErrorCode_IODevice

@ ErrorCode_IODevice

Definition: AkMonitorError.h:86

AK::Monitor::ErrorCode_InvalidGroupID

@ ErrorCode_InvalidGroupID

Definition: AkMonitorError.h:139

AK::Monitor::ErrorCode_XboxXMAVoiceResetFailed

@ ErrorCode_XboxXMAVoiceResetFailed

Definition: AkMonitorError.h:289

AK::Monitor::ErrorCode_OpusHWDecodeUnavailable

@ ErrorCode_OpusHWDecodeUnavailable

Definition: AkMonitorError.h:203

AK::Monitor::ErrorCode_InvalidAudioFileHeader

@ ErrorCode_InvalidAudioFileHeader

Definition: AkMonitorError.h:103

AK::Monitor::ErrorCode_CommandTooLarge

@ ErrorCode_CommandTooLarge

Definition: AkMonitorError.h:163

AK::Monitor::ErrorCode_JobWorkerFuncCallMismatch

@ ErrorCode_JobWorkerFuncCallMismatch

Definition: AkMonitorError.h:221

AK::Monitor::ErrorCode_LowerEngineCommandListFull

@ ErrorCode_LowerEngineCommandListFull

Definition: AkMonitorError.h:148

AK::Monitor::ErrorCode_AudioOutOfRangeRay

@ ErrorCode_AudioOutOfRangeRay

Definition: AkMonitorError.h:232

AK::Monitor::ErrorCode_DynamicSequenceAlreadyClosed

@ ErrorCode_DynamicSequenceAlreadyClosed

Definition: AkMonitorError.h:246

AK::Monitor::ErrorCode_GameMessage

@ ErrorCode_GameMessage

Definition: AkMonitorError.h:333

AkTypes.h

AK::Monitor::ErrorCode_AssetSwapEnabled

@ ErrorCode_AssetSwapEnabled

Definition: AkMonitorError.h:377

AK::Monitor::ErrorCode_LoopTooSmall

@ ErrorCode_LoopTooSmall

Definition: AkMonitorError.h:105

AK::Monitor::ErrorCode_CannotPlaySource_TimeSkip

@ ErrorCode_CannotPlaySource_TimeSkip

Definition: AkMonitorError.h:124

AK::Monitor::ErrorCode_SelectedMediaNotAvailable

@ ErrorCode_SelectedMediaNotAvailable

Definition: AkMonitorError.h:141

AK::Monitor::ErrorCode_PluginFileIncompatible

@ ErrorCode_PluginFileIncompatible

Definition: AkMonitorError.h:239

AK::Monitor::ErrorCode_Support

@ ErrorCode_Support

Definition: AkMonitorError.h:331

AK::Monitor::ErrorCode_NotEnoughSystemObj

@ ErrorCode_NotEnoughSystemObj

Definition: AkMonitorError.h:343

AK_INVALID_GAME_OBJECT

static const AkGameObjectID AK_INVALID_GAME_OBJECT

Invalid game object (may also mean all game objects)

Definition: AkTypes.h:94

AK::Monitor::ErrorCode_FXNotFound

@ ErrorCode_FXNotFound

Definition: AkMonitorError.h:267

AK::Monitor::ErrorCode_VirtualVoiceLimit

@ ErrorCode_VirtualVoiceLimit

Definition: AkMonitorError.h:178

AK::Monitor::ErrorCode_PluginExecutionInvalid

@ ErrorCode_PluginExecutionInvalid

Definition: AkMonitorError.h:93

AK::Monitor::ErrorCode_SoundEngineTooManyEventPosts

@ ErrorCode_SoundEngineTooManyEventPosts

Definition: AkMonitorError.h:262

AK::Monitor::ErrorCode_TransitionNotAccurateCodecError

@ ErrorCode_TransitionNotAccurateCodecError

Definition: AkMonitorError.h:111

AK::Monitor::ErrorCode_AudioDeviceInitFailure

@ ErrorCode_AudioDeviceInitFailure

Definition: AkMonitorError.h:183

AK::Monitor::ErrorCode_AudioOutOfRangeOnBus

@ ErrorCode_AudioOutOfRangeOnBus

Definition: AkMonitorError.h:230

AkUInt32

uint32_t AkUInt32

Unsigned 32-bit integer.

Definition: AkNumeralTypes.h:38

AK::Monitor::MonitorStreamingDeviceDestroyed

AKSOUNDENGINE_API void MonitorStreamingDeviceDestroyed(AkDeviceID in_deviceID)

AK::Monitor::ErrorCode_BankContainUneditableEffect

@ ErrorCode_BankContainUneditableEffect

Definition: AkMonitorError.h:282

AK::Monitor::ErrorCode_InvalidXMAData

@ ErrorCode_InvalidXMAData

Definition: AkMonitorError.h:131

AK::Monitor::ResetTranslator

AKSOUNDENGINE_API AKRESULT ResetTranslator()

AK::Monitor::ErrorCode_LoadingBankMismatch

@ ErrorCode_LoadingBankMismatch

Definition: AkMonitorError.h:278

AK::Monitor::ErrorCode_SystemAudioObjectsUnavailable

@ ErrorCode_SystemAudioObjectsUnavailable

Definition: AkMonitorError.h:206

AK::Monitor::ErrorCode_UnexpectedPrepareGameSyncsCall

@ ErrorCode_UnexpectedPrepareGameSyncsCall

Definition: AkMonitorError.h:276

AK::Monitor::ErrorCode_AddOutputListenerIdWithZeroListeners

@ ErrorCode_AddOutputListenerIdWithZeroListeners

Definition: AkMonitorError.h:198

AK::Monitor::ErrorCode_CodecNotRegistered

@ ErrorCode_CodecNotRegistered

Definition: AkMonitorError.h:134

AK::Monitor::ErrorCode_UnknownGameObject

@ ErrorCode_UnknownGameObject

Definition: AkMonitorError.h:154

AK::Monitor::ErrorCode_HwVoicesDecodeBatchFailed

@ ErrorCode_HwVoicesDecodeBatchFailed

Definition: AkMonitorError.h:192

AK::Monitor::ErrorCode_AudioOutOfRange

@ ErrorCode_AudioOutOfRange

Definition: AkMonitorError.h:229

AK::Monitor::MonitorErrorInfo::m_name

const AkOSChar * m_name

Definition: AkMonitorError.h:67

AK::Monitor::ErrorCode_SoundEngineTooManyGameObjects

@ ErrorCode_SoundEngineTooManyGameObjects

Definition: AkMonitorError.h:257

AK::Monitor::ErrorCode_SourcePluginNotFound

@ ErrorCode_SourcePluginNotFound

Definition: AkMonitorError.h:176

AK::Monitor::PostCode

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)

AK::Monitor::ErrorCode_MaxAudioObjExceeded

@ ErrorCode_MaxAudioObjExceeded

Definition: AkMonitorError.h:341

AK::Monitor::ErrorCode_FLTMAXNotSupported

@ ErrorCode_FLTMAXNotSupported

Definition: AkMonitorError.h:321

AK::Monitor::ErrorCode_VoiceStarving

@ ErrorCode_VoiceStarving

Definition: AkMonitorError.h:127

AK::Monitor::ErrorCode_MismatchingMediaSize

@ ErrorCode_MismatchingMediaSize

Definition: AkMonitorError.h:274

AK::Monitor::MsgContext

Definition: AkMonitorError.h:46

AK::Monitor::ErrorCode_MusicClipsRescheduledAfterTrackEdit

@ ErrorCode_MusicClipsRescheduledAfterTrackEdit

Definition: AkMonitorError.h:120

AK::Monitor::ErrorCode_AddOutputNoDistinctListener

@ ErrorCode_AddOutputNoDistinctListener

Definition: AkMonitorError.h:208

AK::Monitor::ErrorCode_AudioDeviceShareSetNotFoundByName

@ ErrorCode_AudioDeviceShareSetNotFoundByName

Definition: AkMonitorError.h:255

AK::Monitor::ErrorCode_ATRAC9DecodeFailed

@ ErrorCode_ATRAC9DecodeFailed

Definition: AkMonitorError.h:100

AK::Monitor::ErrorCode_3DAudioUnsupportedSize

@ ErrorCode_3DAudioUnsupportedSize

Definition: AkMonitorError.h:326

AkStreamMgrSettings

Definition: AkStreamMgrModule.h:50

AK::Monitor::ErrorCode_VorbisDecodeError

@ ErrorCode_VorbisDecodeError

Definition: AkMonitorError.h:98

AK::Monitor::ErrorCode_NoSwitchSelected

@ ErrorCode_NoSwitchSelected

Definition: AkMonitorError.h:357

AK::Monitor::ErrorCode_OpusHWCommandFailed

@ ErrorCode_OpusHWCommandFailed

Definition: AkMonitorError.h:196

AK::Monitor::ErrorCode_OpusHWTimeout

@ ErrorCode_OpusHWTimeout

Definition: AkMonitorError.h:204

AK::Monitor::ErrorLevel

ErrorLevel

ErrorLevel.

Definition: AkMonitorError.h:73

AK::Monitor::ErrorCode_NoValidSwitch

@ ErrorCode_NoValidSwitch

Definition: AkMonitorError.h:142

AK::Monitor::ErrorCode_FilePermissionError

@ ErrorCode_FilePermissionError

Definition: AkMonitorError.h:358

AK::Monitor::ErrorCode_BusNotFoundByName

@ ErrorCode_BusNotFoundByName

Definition: AkMonitorError.h:253

AK::Monitor::ErrorCode_MonitorQueueFull

@ ErrorCode_MonitorQueueFull

Definition: AkMonitorError.h:216

AK::Monitor::ErrorCode_PluginFileNotEnoughMemoryToStart

@ ErrorCode_PluginFileNotEnoughMemoryToStart

Definition: AkMonitorError.h:240

AK::Monitor::ErrorCode_NoDefaultSwitch

@ ErrorCode_NoDefaultSwitch

Definition: AkMonitorError.h:353

AkPlayingID

AkUInt32 AkPlayingID

Playing ID.

Definition: AkTypes.h:55

AK::Monitor::ErrorCode_FileFormatMismatch

@ ErrorCode_FileFormatMismatch

Definition: AkMonitorError.h:160

AK::Monitor::ErrorCode_PlayFailed

@ ErrorCode_PlayFailed

Definition: AkMonitorError.h:113

AK::Monitor::ErrorCode_PluginNotRegistered

@ ErrorCode_PluginNotRegistered

Definition: AkMonitorError.h:133

AK::Monitor::ErrorCode_ExternalSourceNoMemorySize

@ ErrorCode_ExternalSourceNoMemorySize

Definition: AkMonitorError.h:214

AK::Monitor::ErrorCode_AudioThreadResumed

@ ErrorCode_AudioThreadResumed

Definition: AkMonitorError.h:306

AK::Monitor::ErrorCode_IncompatibleBankVersion

@ ErrorCode_IncompatibleBankVersion

Definition: AkMonitorError.h:275

AK::Monitor::ErrorCode_PluginAllocationFailed

@ ErrorCode_PluginAllocationFailed

Definition: AkMonitorError.h:94

AK::Monitor::ErrorCode_SwitchListEmpty

@ ErrorCode_SwitchListEmpty

Definition: AkMonitorError.h:356

AK::Monitor::ErrorCode_XboxACPError

@ ErrorCode_XboxACPError

Definition: AkMonitorError.h:292

AK::Monitor::ErrorCode_GameObjectNeverRegistered

@ ErrorCode_GameObjectNeverRegistered

Definition: AkMonitorError.h:155

AK::Monitor::ErrorCode_SpatialAudio_PortalNotFound

@ ErrorCode_SpatialAudio_PortalNotFound

Definition: AkMonitorError.h:317

AK::Monitor::ErrorCode_AudioOut2UserCreateError

@ ErrorCode_AudioOut2UserCreateError

Definition: AkMonitorError.h:374

AK::Monitor::ErrorCode_SeekAfterEndOfPlaylist

@ ErrorCode_SeekAfterEndOfPlaylist

Definition: AkMonitorError.h:171

AK::Monitor::ErrorCode_CannotInitializePassthrough

@ ErrorCode_CannotInitializePassthrough

Definition: AkMonitorError.h:325

AK::Monitor::PostString

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)

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.

Get started with Wwise

Wwise SDK