Version

menu_open

◆ ExtractCurves()

virtual bool AK::IAkPluginServiceAudioObjectAttenuation::ExtractCurves ( IAkPluginMemAlloc in_pAllocator,
const AkAudioObject in_object,
AkUInt32  in_curveTypesMask,
void *  out_curves[] 
) const
pure virtual

Extract the curve of a given type from the set of Attenuation curves attached to the given audio object. The curve's data is copied into an opaque data structure, pointed to by out_curve. The curve's data remain until the client of this service calls AK::IAkPluginServiceAttenuationCurve::Delete.

Returns
true if the copy succeeded, or if the requested curve was not initialized.
Parameters
in_pAllocatorMemory allocator.
in_objectThe audio object from which to extract the curve.
in_curveTypesMaskThe set of curves, identified with a mask of bits offset by AkAttenuationCurveType values, to extract from the set of Attenuation curves. For example, set to (1 << AttenuationCurveID_VolumeDry | 1 << AttenuationCurveID_Spread) to obtain the distance-driven dry volume and spread curves.
out_curvesThe returned addresses of the requested curve data. Pass in an array of void* with length corresponding to the number of desired curves. For each curve, if it exists, a blob of data is allocated by the function and the address is returned in the corresponding item of the out_curves. The item is set to nullptr if the curve does not exist.

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