Version

menu_open
Wwise SDK 2021.1.14

◆ Consume()

virtual void AK::IAk3DAudioSinkPlugin::Consume ( AkAudioBuffer in_pMainMix,
AkAudioBuffer in_pPassthroughMix,
const AkAudioObjects in_objects,
AkRamp  in_gain 
)
pure virtual

Same as AK::IAkSinkPlugin::Consume(), but receives 3 inputs: the main mix,the stereo passthrough and 3d audio objects.

See also
Parameters
in_pMainMix Audio buffer data structure for the main mix (binauralized or not, depending on if binauralization is supported and enabled).
in_pPassthroughMix The 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.
in_objects 3D 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.
in_gain Volume gain to apply to all inputs.

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