Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2023.1.8

◆ PostString()

AKSOUNDENGINE_API AKRESULT AK::Monitor::PostString ( const char *  in_pszError,
ErrorLevel  in_eErrorLevel,
AkPlayingID  in_playingID = AK_INVALID_PLAYING_ID,
AkGameObjectID  in_gameObjID = AK_INVALID_GAME_OBJECT,
AkUniqueID  in_audioNodeID = AK_INVALID_UNIQUE_ID,
bool  in_bIsBus = false 
)

Post a monitoring message or error string. This will be displayed in the Wwise capture log.

Returns
AK_Success if successful, AK_Fail if there was a problem posting the message. In optimized mode, this function returns AK_NotCompatible.
Remarks
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.
Parameters
in_pszErrorMessage or error string to be displayed
in_eErrorLevelSpecifies whether it should be displayed as a message or an error
in_playingIDRelated Playing ID if applicable
in_gameObjIDRelated Game Object ID if applicable, AK_INVALID_GAME_OBJECT otherwise
in_audioNodeIDRelated Audio Node ID if applicable, AK_INVALID_UNIQUE_ID otherwise
in_bIsBustrue if in_audioNodeID is a bus

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