Version

menu_open
Wwise SDK 2021.1.14

◆ NotifyMonitorData()

virtual void AK.Wwise::IAudioPlugin::NotifyMonitorData ( AkTimeMs  in_iTimeStamp,
const MonitorData in_pDataArray,
unsigned int  in_uCount,
bool  in_bNeedsByteSwap,
bool  in_bRealtime 
)
pure virtual

Called when an instance of the run-time component of the plug-in sends data using AK::IAkEffectPluginContext::PostMonitorData(), and this plug-in's settings are being displayed in a window. Because multiple run-time instances may exist for a single authoring tool plug-in, the data is batched together and passed at the end of the frame. Define the CanSendMonitorData element to true in the plug-in XML to activate the monitoring user interface.

Parameters
in_iTimeStamp Timestamp of the data (in milliseconds)
in_pDataArray Array of blobs of data
in_uCount Number of elements in array 'in_pDataArray'
in_bNeedsByteSwap True if data comes from platform with a different byte ordering (i.e. Big Endian)
in_bRealtime True if monitoring in real-time, false if scrubbing through profiler history

Implemented in AK.Wwise::DefaultAudioPluginImplementation.


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