Version

menu_open
Wwise SDK 2023.1.4
AK::IAkSinkPluginContext Class Referenceabstract

#include <IAkPlugin.h>

Inheritance diagram for AK::IAkSinkPluginContext:
AK::IAkPluginContextBase

Public Member Functions

virtual bool IsPrimary ()=0
 
virtual AKRESULT SignalAudioThread ()=0
 
virtual AkUInt16 GetNumRefillsInVoice ()=0
 
virtual AKRESULT ComputePositioning (const AkPositioningData &in_posData, AkChannelConfig in_inputConfig, AkChannelConfig in_outputConfig, AK::SpeakerVolumes::MatrixPtr out_mxVolumes)=0
 
virtual AkPanningRule GetPanningRule () const =0
 Returns the panning rule for the output device to which the sink plug-in is attached. More...
 
- Public Member Functions inherited from AK::IAkPluginContextBase
virtual IAkGlobalPluginContextGlobalContext () const =0
 
virtual IAkGameObjectPluginInfoGetGameObjectInfo ()=0
 
virtual AKRESULT GetOutputID (AkUInt32 &out_uOutputID, AkPluginID &out_uDevicePlugin) const =0
 
virtual void GetPluginMedia (AkUInt32 in_dataIndex, AkUInt8 *&out_rpData, AkUInt32 &out_rDataSize)=0
 
virtual void GetPluginCustomGameData (void *&out_rpData, AkUInt32 &out_rDataSize)=0
 
virtual AKRESULT PostMonitorData (void *in_pData, AkUInt32 in_uDataSize)=0
 
virtual bool CanPostMonitorData ()=0
 
virtual AKRESULT PostMonitorMessage (const char *in_pszError, AK::Monitor::ErrorLevel in_eErrorLevel)=0
 
virtual AkReal32 GetDownstreamGain ()=0
 
virtual AKRESULT GetParentChannelConfig (AkChannelConfig &out_channelConfig) const =0
 
virtual IAkProcessorFeaturesGetProcessorFeatures ()=0
 Return an interface to query processor specific features. More...
 
virtual AkUniqueID GetAudioNodeID () const =0
 
virtual AKRESULT GetSinkChannelConfig (AkChannelConfig &out_sinkConfig, Ak3DAudioSinkCapabilities &out_3dAudioCaps) const =0
 

Protected Member Functions

virtual ~IAkSinkPluginContext ()
 Virtual destructor on interface to avoid warnings. More...
 
- Protected Member Functions inherited from AK::IAkPluginContextBase
virtual ~IAkPluginContextBase ()
 Virtual destructor on interface to avoid warnings. More...
 

Detailed Description

Interface to retrieve contextual information for a sink plugin.

See also

Definition at line 915 of file IAkPlugin.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.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise