Version

    Other Documentation

menu_open
Wwise SDK 2022.1.11
AK::IAkOutOfPlaceObjectPlugin Class Referenceabstract

#include <IAkPlugin.h>

Inheritance diagram for AK::IAkOutOfPlaceObjectPlugin:
AK::IAkEffectPlugin AK::IAkPlugin

Public Member Functions

virtual void Execute (const AkAudioObjects &in_objects, const AkAudioObjects &out_objects)=0
 
- Public Member Functions inherited from AK::IAkEffectPlugin
virtual AKRESULT Init (IAkPluginMemAlloc *in_pAllocator, IAkEffectPluginContext *in_pEffectPluginContext, IAkPluginParam *in_pParams, AkAudioFormat &io_rFormat)=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 *)
 

Additional Inherited Members

- Protected Member Functions inherited from AK::IAkEffectPlugin
virtual ~IAkEffectPlugin ()
 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

Out-of-place Object Processor plug-in interface. Implement this interface when your plugin returns AkPluginInfo::bCanProcessObjects set to true and AkPluginInfo::bIsInPlace set to false. With out-of-place object processors, the set of output objects is different than that of the input objects. Out-of-place object processors typically create their own output objects using IAkEffectPluginContext::CreateObject. Alternatively, an output object is created by the host bus if the channel configuration returned from Init is not of type AK_ChannelConfigType_Objects. Only out-of-place object processors may create output objects or change the output channel configuration.

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