Table of Contents

Wwise SDK 2021.1.2
AK::IAkAudioDeviceEffectPlugin Class Referenceabstract

#include <IAkPlugin.h>

Inheritance diagram for AK::IAkAudioDeviceEffectPlugin:
AK::IAkPlugin

Public Member Functions

virtual AKRESULT  Init (IAkPluginMemAlloc *in_pAllocator, IAkAudioDeviceEffectPluginContext *in_pEffectPluginContext, IAkPluginParam *in_pParams, const AkAudioFormat &in_rFormat, const Ak3DAudioSinkCapabilities &in_3dCapabilities)=0
 
virtual void  Execute (AkAudioBuffer *io_pMainMix, AkAudioBuffer *io_pPassthroughMix, const AkAudioObjects &io_objects, AkRamp &io_gain)=0
 
- Public Member Functions inherited from AK::IAkPlugin
virtual AKRESULT  Term (IAkPluginMemAlloc *in_pAllocator)=0
 
virtual AKRESULT  Reset ()=0
 
virtual AKRESULT  GetPluginInfo (AkPluginInfo &out_rPluginInfo)=0
 
virtual bool  SupportMediaRelocation () const
 
virtual AKRESULT  RelocateMedia (AkUInt8 *, AkUInt8 *)
 

Protected Member Functions

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

Detailed Description

Audio device effect plug-in interface. Implement this interface for in-place effects that must be applied at the very end of the pipeline. Audio device effects are applied right before sending audio buffers (main mix, passthrough and objects) to the audio device output through IAkSinkPlugin/IAk3DAudioSinkPlugin. The format of the audio buffers passed to the effect matches the format requested by the sink plug-in. This means that audio device effects must be in-place; they cannot change io_rFormat in Init().

Definition at line 871 of file IAkPlugin.h.