Version

menu_open
Wwise SDK 2021.1.14

◆ Init()

virtual AKRESULT AK::IAkAudioDeviceEffectPlugin::Init ( IAkPluginMemAlloc in_pAllocator,
IAkAudioDeviceEffectPluginContext in_pEffectPluginContext,
IAkPluginParam in_pParams,
const AkAudioFormat in_rFormat,
const Ak3DAudioSinkCapabilities in_3dCapabilities 
)
pure virtual

Audio device effect plug-in initialization. Prepares the effect for data processing, allocates memory and sets up the initial conditions.

Note: Memory allocation should be done through appropriate macros (see Allocating/De-allocating Memory in Audio Plug-ins).
Parameters
in_pAllocator Interface to memory allocator to be used by the effect
in_pEffectPluginContext Interface to audio effect's plug-in context
in_pParams Interface to plug-in parameters
in_rFormat Audio data format of the input/output signal. Matches the channel configuration of the audio device sink plug-in. If format is object-based (AkChannelConfig::eConfigType is Ak_ChannelConfigType_Objects), the plug-in should verify Ak3DAudioSinkCapabilities to determine which inputs it can expect in Execute (main mix, passthrough, objects).
in_3dCapabilities 3D capabilities of the output device sink plug-in. If io_rFormat is not object-based, this can be ignored and only the main mix will be submitted to Execute().

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