Wwise Version
arrow_right Table of Contents
Wwise SDK 2021.1.3
AK::IAk3DAudioSinkPlugin Class Referenceabstract

Software plug-in interface for sink (audio end point) which supports 3D audio features. More...

#include <IAkPlugin.h>

Inheritance diagram for AK::IAk3DAudioSinkPlugin:
AK::IAkSinkPluginBase AK::IAkPlugin

Public Member Functions

virtual void  Get3DAudioCapabilities (Ak3DAudioSinkCapabilities &out_rCapabilities)=0
  Returns the capabilities of the sink's 3D audio system. More...
 
virtual void  Consume (AkAudioBuffer *in_pMainMix, AkAudioBuffer *in_pPassthroughMix, const AkAudioObjects &in_objects, AkRamp in_gain)=0
 
virtual AkSinkPluginType  GetSinkPluginType () const override final
 
- Public Member Functions inherited from AK::IAkSinkPluginBase
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  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  ~IAk3DAudioSinkPlugin ()
  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 plug-in interface for sink (audio end point) which supports 3D audio features.

Definition at line 1191 of file IAkPlugin.h.