Version

menu_open
Wwise SDK 2022.1.11

◆ Execute()

virtual void AK::IAkAudioDeviceEffectPlugin::Execute ( AkAudioBuffer io_pMainMix,
AkAudioBuffer io_pPassthroughMix,
const AkAudioObjects io_objects,
AkRamp io_gain 
)
pure virtual
Parameters
io_pMainMixAudio buffer data structure for the main mix (binauralized or not, depending on if binauralization is supported and enabled).
io_pPassthroughMixThe stereo mix to send out to the system in passthrough fashion (no binauralization). NULL if the channel configuration of the device is not object-based or does not have a passthrough.
io_objects3D Audio objects and object audio buffers to be consumed. The audio buffers are in the native format of the sound engine (typically float, deinterleaved), as specified by io_rFormat passed to Init(). It is up to the plugin to transform it into a format that is compatible with its output.
io_gainVolume gain to apply to all inputs. If the effect applies the gain, it must reset the gain to 1.0f so that it's not applied a second time in the sink plug-in.

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