_ak_monitor_error_8h

Wwise SDK 2018.1.11
 /*******************************************************************************

 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.

   Version: <VERSION>  Build: <BUILDNUMBER>

   Copyright (c) <COPYRIGHTYEAR> Audiokinetic Inc.

 *******************************************************************************/

 #ifndef _AKMONITORERROR_H

 #define _AKMONITORERROR_H

 #include <AK/SoundEngine/Common/AkSoundEngineExport.h>

 #include <AK/SoundEngine/Common/AkTypes.h>

 namespace AK

 {

     // Error monitoring.

     namespace Monitor

     {

         ///  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_aszErrorCodes table 

             ErrorCode_FileNotFound, 

             ErrorCode_CannotOpenFile,

             ErrorCode_CannotStartStreamNoMemory,

             ErrorCode_IODevice,

             ErrorCode_IncompatibleIOSettings,

             ErrorCode_PluginUnsupportedChannelConfiguration,

             ErrorCode_PluginMediaUnavailable,

             ErrorCode_PluginInitialisationFailed,

             ErrorCode_PluginProcessingFailed,

             ErrorCode_PluginExecutionInvalid,

             ErrorCode_PluginAllocationFailed,

             ErrorCode_VorbisRequireSeekTable,

             ErrorCode_VorbisDecodeError,

             ErrorCode_AACDecodeError,

             ErrorCode_xWMACreateDecoderFailed,//Deprecated, keep in place for legacy maintenance.

             ErrorCode_ATRAC9CreateDecoderFailed,

             ErrorCode_ATRAC9CreateDecoderFailedChShortage,

             ErrorCode_ATRAC9DecodeFailed,

             ErrorCode_ATRAC9ClearContextFailed,

             ErrorCode_ATRAC9LoopSectionTooSmall,

             ErrorCode_InvalidAudioFileHeader,

             ErrorCode_AudioFileHeaderTooLarge,

             ErrorCode_FileTooSmall,

             ErrorCode_TransitionNotAccurateChannel,

             ErrorCode_TransitionNotAccurateStarvation,

             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,           //Deprecated

             ErrorCode_UnknownListener, 

             ErrorCode_GameObjectIsNotListener,

             ErrorCode_GameObjectIsNotEmitter,

             ErrorCode_UnknownGameObjectEvent,   //Deprecated

             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_MediaDuplicationLength,

             Num_ErrorCodes // THIS STAYS AT END OF ENUM

         };

         /// 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 AkOSChar* s_aszErrorCodes[ Num_ErrorCodes ];

         /// Post a monitoring message or error code. 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, 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

             );

 #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.

             );

         /// 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 )();

     }

 }

 // Macros.

 #ifndef AK_OPTIMIZED

     #define AK_MONITOR_ERROR( in_eErrorCode )\

     AK::Monitor::PostCode( in_eErrorCode, AK::Monitor::ErrorLevel_Error )

 #else

     #define AK_MONITOR_ERROR( in_eErrorCode )

 #endif

 #ifdef AK_MONITOR_IMPLEMENT_ERRORCODES

 namespace AK

 {

     namespace Monitor

     {

         const AkOSChar* s_aszErrorCodes[ Num_ErrorCodes ] =

         {

             AKTEXT("No error"), // ErrorCode_NoError

             AKTEXT("File not found"), // ErrorCode_FileNotFound,

             AKTEXT("Cannot open file"), // ErrorCode_CannotOpenFile,

             AKTEXT("Not enough memory in I/O pool to start stream"), // ErrorCode_CannotStartStreamNoMemory,

             AKTEXT("Unknown I/O device error"), // ErrorCode_IODevice,

             AKTEXT("I/O settings incompatible."), // ErrorCode_IncompatibleIOSettings

             AKTEXT("Plug-in unsupported channel configuration"), // ErrorCode_PluginUnsupportedChannelConfiguration,

             AKTEXT("Plug-in media unavailable"), // ErrorCode_PluginMediaUnavailable,

             AKTEXT("Plug-in initialization failure"), // ErrorCode_PluginInitialisationFailed,

             AKTEXT("Plug-in execution failure"), // ErrorCode_PluginProcessingFailed,

             AKTEXT("Invalid plug-in execution mode"), // ErrorCode_PluginExecutionInvalid

             AKTEXT("Could not allocate effect"), // ErrorCode_PluginAllocationFailed

 AKTEXT("Seek table required to seek in Vorbis sources. Please update conversion settings."), // ErrorCode_VorbisRequireSeekTable,

 AKTEXT("Vorbis decoder failure"), // ErrorCode_VorbisDecodeError,

 AKTEXT("AAC decoder failure"), // ErrorCode_AACDecodeError

 AKTEXT("Failed creating xWMA decoder"), // ErrorCode_xWMACreateDecoderFailed,

 AKTEXT("Failed creating ATRAC9 decoder"), // ErrorCode_ATRAC9CreateDecoderFailed

 AKTEXT("Failed creating ATRAC9 decoder: no more ATRAC9 decoding channels available"), // ErrorCode_ATRAC9CreateDecoderFailedChShortage

 AKTEXT("ATRAC9 decoding failed"), // ErrorCode_ATRAC9DecodeFailed

 AKTEXT("ATRAC9 context clear failed"), // ErrorCode_ATRAC9ClearContextFailed

 AKTEXT("ATRAC9 loop section is too small"), // ErrorCode_ATRAC9LoopSectionTooSmall

 AKTEXT("Invalid file header"), // ErrorCode_InvalidAudioFileHeader,

 AKTEXT("File header too large (due to markers or envelope)"), // ErrorCode_AudioFileHeaderTooLarge,

 AKTEXT("File or loop region is too small to be played properly"), // ErrorCode_FileTooSmall,

 AKTEXT("Transition not sample-accurate due to mixed channel configurations"), // ErrorCode_TransitionNotAccurateChannel,

 AKTEXT("Transition not sample-accurate due to source starvation"), // ErrorCode_TransitionNotAccurateStarvation,

 AKTEXT("Nothing to play in Dynamic Sequence"), // ErrorCode_NothingToPlay, 

 AKTEXT("Play Failed"), // ErrorCode_PlayFailed, // Notification meaning the play asked was not done for an out of control reason

 // For example, if The Element has a missing source file.

 AKTEXT("Stinger could not be scheduled in this segment or was dropped"), // ErrorCode_StingerCouldNotBeScheduled,

 AKTEXT("Segment look-ahead plus pre-entry duration is longer than previous segment in sequence"), // ErrorCode_TooLongSegmentLookAhead,

 AKTEXT("Cannot schedule music switch transition in upcoming segments: using Exit Cue"), // ErrorCode_CannotScheduleMusicSwitch,

 AKTEXT("Cannot schedule music segments: Stopping music"), // ErrorCode_TooManySimultaneousMusicSegments,

 AKTEXT("Music system is stopped because a music playlist is modified"), // ErrorCode_PlaylistStoppedForEditing

 AKTEXT("Rescheduling music clips because a track was modified"), // ErrorCode_MusicClipsRescheduledAfterTrackEdit

 AKTEXT("Failed creating source"), // ErrorCode_CannotPlaySource_Create,

 AKTEXT("Virtual source failed becoming physical"), // ErrorCode_CannotPlaySource_VirtualOff,

 AKTEXT("Error while computing virtual source elapsed time"), // ErrorCode_CannotPlaySource_TimeSkip,

 AKTEXT("Inconsistent source status"), // ErrorCode_CannotPlaySource_InconsistentState,

 AKTEXT("Media was not loaded for this source"),// ErrorCode_MediaNotLoaded,

 AKTEXT("Voice Starvation"), // ErrorCode_VoiceStarving,

 AKTEXT("Source starvation"), // ErrorCode_StreamingSourceStarving,

 AKTEXT("XMA decoder starvation"), // ErrorCode_XMADecoderSourceStarving,

 AKTEXT("XMA decoding error"), // ErrorCode_XMADecodingError

 AKTEXT("Invalid XMA data - Make sure data is allocated from APU memory and is aligned to 2K."), // ErrorCode_InvalidXMAData

 AKTEXT("Plug-in not found"), // ErrorCode_PluginNotRegistered,

 AKTEXT("Codec plug-in not registered"), // ErrorCode_CodecNotRegistered,

 AKTEXT("Plug-in version doesn't match sound engine version.  Please ensure the plug-in is compatible with this version of Wwise"), //ErrorCode_PluginVersionMismatch

 AKTEXT("Event ID not found"), // ErrorCode_EventIDNotFound,

 AKTEXT("Invalid State Group ID"), // ErrorCode_InvalidGroupID,

 AKTEXT("Selected Child Not Available"), // ErrorCode_SelectedChildNotAvailable,

 AKTEXT("Selected Node Not Available"), // ErrorCode_SelectedNodeNotAvailable,

 AKTEXT("Selected Media Not Available"),// ErrorCode_SelectedMediaNotAvailable,

 AKTEXT("No Valid Switch"), // ErrorCode_NoValidSwitch,

 AKTEXT("Selected node not available. Make sure the structure associated to the event is loaded or that the event has been prepared"), // ErrorCode_SelectedNodeNotAvailablePlay,

 AKTEXT("Motion voice starvation"), // ErrorCode_FeedbackVoiceStarving,

 AKTEXT("Bank Load Failed"), // ErrorCode_BankLoadFailed,

 AKTEXT("Bank Unload Failed"), // ErrorCode_BankUnloadFailed,

 AKTEXT("Error while loading bank"), // ErrorCode_ErrorWhileLoadingBank,

 AKTEXT("Insufficient Space to Load Bank"), // ErrorCode_InsufficientSpaceToLoadBank,

 AKTEXT("Lower engine command list is full"), // ErrorCode_LowerEngineCommandListFull,

 AKTEXT("No marker in file; seeking to specified location"), // ErrorCode_SeekNoMarker

 AKTEXT("Cannot seek in sound that is within a continuous container with special transitions"), // ErrorCode_CannotSeekContinuous

 AKTEXT("Seeking after end of file. Playback will stop"), // ErrorCode_SeekAfterEof

 AKTEXT("Unknown game object ID. Make sure the game object is registered before using it and do not use it once it was unregistered."), // ErrorCode_UnknownGameObject,

 AKTEXT("Unknown emitter game object ID. Make sure the game object is registered before using it and do not use it once it was unregistered."), // ErrorCode_UnknownEmitter,

 AKTEXT("Unknown listener game object ID. Make sure the game object is registered before using it and do not use it once it was unregistered."), // ErrorCode_UnknownListener,

 AKTEXT("The requested game object is not a listener."), // ErrorCode_GameObjectIsNotListener,

 AKTEXT("The requested game object is not an emitter."), // ErrorCode_GameObjectIsNotEmitter,

 AKTEXT("Unknown emitter game object ID on event. Make sure the game object is registered before using it and do not use it once it was unregistered."), // ErrorCode_UnknownGameObjectEvent

 AKTEXT("The requested game object for an event was not registered as an emitter. Make sure the game object is registered as an emitter before using it to post an event."), // ErrorCode_GameObjectIsNotEmitterEvent

 AKTEXT("External source missing from PostEvent call"), // ErrorCode_ExternalSourceNotResolved

 AKTEXT("Source file is of different format than expected"), //ErrorCode_FileFormatMismatch

 AKTEXT("Audio command queue is full, blocking caller.  Reduce number of calls to sound engine or boost command queue memory."), // ErrorCode_CommandQueueFull

 AKTEXT("Audio command is too large to fit in the command queue.  Break the command in smaller pieces."), //ErrorCode_CommandTooLarge

 AKTEXT("Failed creating XMA decoder: no more XMA voices available"), // ErrorCode_XMACreateDecoderLimitReached

 AKTEXT("Failed seeking in XMA source: stream buffer is smaller than XMA block size"), // ErrorCode_XMAStreamBufferTooSmall

 AKTEXT("Triggered a note-scoped or playing-instance-scoped modulator in a global context (such as a bus or bus effect).  Modulator will have global scope."), // ErrorCode_ModulatorScopeError_Inst

 AKTEXT("Triggered a game-object-scoped modulator in a global context (such as a bus or bus effect).  Modulator will have global scope."), // ErrorCode_ModulatorScopeError_Obj

 AKTEXT("Ignoring seek after end of playlist"), // ErrorCode_SeekAfterEndOfPlaylist

 AKTEXT("Seek table required to seek in Opus sources. Please update conversion settings."), // ErrorCode_OpusRequireSeekTable,

 AKTEXT("Opus decoder failure"), // ErrorCode_OpusDecodeError,

 AKTEXT("Failed creating Opus decoder"), // ErrorCode_OpusCreateDecoderFailed

 AKTEXT("Source plugin not found in currently loaded banks."), //ErrorCode_SourcePluginNotFound

 AKTEXT("Number of Resume and/or Play-From-Beginning virtual voices has reached warning limit (see Project Settings > Log tab). There may be some infinite, leaked voices.") , // ErrorCode_VirtualVoiceLimit

 AKTEXT("AK::SoundEngine::AddOutput() - Device ShareSet not found in Init bank."),   //ErrorCode_AudioDeviceShareSetNotFound

 AKTEXT("Not enough memory to start sound."),    //ErrorCode_NotEnoughMemoryToStart

 AKTEXT("Error while decoding Opus header."),    //ErrorCode_UnkownOpusError

 AKTEXT("The Output Device specified by AddOutput() or Init() could not be initialized."), //ErrorCode_AudioDeviceInitFailure

 AKTEXT("Duplicated media has different length in two separate banks.  Stopping sound."), // ErrorCode_MediaDuplicationLength

         };

     }

 }

 #endif // AK_MONITOR_IMPLEMENT_ERRORCODES

 #endif // _AKMONITORERROR_H
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 2018.1.11

_ak_monitor_error_8h_source

Was this page helpful?

Need Support?

Tell us about your project. We're here to help.
