Version

menu_open
Wwise SDK 2022.1.11

◆ CreateOutputObjects()

virtual AKRESULT AK::IAkEffectPluginContext::CreateOutputObjects ( AkChannelConfig  in_channelConfig,
AkAudioObjects io_objects 
)
pure virtual

Create new objects on the output side. Only out-of-place object processors (plugins implementing AK::IAkOutOfPlaceObjectPlugin) may create output objects. If successful, the newly constructed objects will be available in out_ppBuffer/out_ppObjects. To obtain all the output objects in a single array after having created objects using this function, use GetOutputObjects, or wait for the next call to AK::IAkOutOfPlaceObjectPlugin::Execute where output objects are passed via the in_pObjectBuffersOut/in_pObjectsOut arguments. Object processors inform the host that an output object may be disposed of by setting its state to AK_NoMoreData from within AK::IAkOutOfPlaceObjectPlugin::Execute.

Note: You should never store the pointers returned by out_ppBuffer/out_ppObjects, as the location of pointed objects may change at each frame, or after subsequent calls to CreateOutputObjects.
Returns
AK_Success if all objects were created successfully, AK_Fail otherwise. The optional arguments out_ppBuffer and out_ppObjects may be used to obtain the output objects newly created.
See also
Parameters
in_channelConfigDesired channel configuration for all new objects.
io_objectsAkAudioObjects::uNumObjects, the number of objects to create. AkAudioObjects::ppObjectBuffers, Returned array of pointers to the object buffers newly created, allocated by the caller. Pass nullptr if they're not needed. AkAudioObjects::ppObjects, Returned array of pointers to the objects newly created, allocated by the caller. Pass nullptr if they're not needed.

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