Version

    Other Documentation

menu_open
Wwise SDK 2018.1.11
AK::IAkSinkPlugin Class Referenceabstract

Software effect plug-in interface for sink (audio end point) plugins. More...

Inheritance diagram for AK::IAkSinkPlugin:
AK::IAkPlugin

Public Member Functions

virtual AKRESULT  Init (IAkPluginMemAlloc *in_pAllocator, IAkSinkPluginContext *in_pSinkPluginContext, IAkPluginParam *in_pParams, AkAudioFormat &io_rFormat)=0
 
virtual AKRESULT  IsDataNeeded (AkUInt32 &out_uNumFramesNeeded)=0
 
virtual void  Consume (AkAudioBuffer *in_pInputBuffer, AkRamp in_gain)=0
 
virtual void  OnFrameEnd ()=0
 
virtual bool  IsStarved ()=0
 
virtual void  ResetStarved ()=0
  Reset the "starvation" flag after IsStarved() returned true. More...
 
- 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  ~IAkSinkPlugin ()
  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

Software effect plug-in interface for sink (audio end point) plugins.

Definition at line 943 of file IAkPlugin.h.


The documentation for this class was generated from the following file:

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