Other Documentation

Wwise SDK 2022.1.8
AK::IAkEffectPluginContext Class Referenceabstract

#include <IAkPlugin.h>

Inheritance diagram for AK::IAkEffectPluginContext:

Public Member Functions

virtual bool  IsSendModeEffect () const =0
virtual IAkVoicePluginInfo GetVoiceInfo ()=0
virtual IAkMixerPluginContext GetMixerCtx ()=0
For object processors:

Output object management.

virtual AKRESULT  CreateOutputObjects (AkChannelConfig in_channelConfig, AkAudioObjects &io_objects)=0
virtual void  GetOutputObjects (AkAudioObjects &io_objects)=0
- Public Member Functions inherited from AK::IAkPluginContextBase
virtual IAkGlobalPluginContext GlobalContext () const =0
virtual IAkGameObjectPluginInfo GetGameObjectInfo ()=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 IAkProcessorFeatures GetProcessorFeatures ()=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  ~IAkEffectPluginContext ()
  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 an effect plug-in.

See also

Definition at line 355 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