menu
 
Version
2023.1.9.8628

2024.1.1.8691

2023.1.9.8628

2022.1.18.8567

2021.1.14.8108

2019.2.15.7667

2019.1.11.7296

2018.1.11.6987

2017.2.10.6745

2017.1.9.6501

2016.2.6.6153

2015.1.9.5624


menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.9.8628 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2023.1.9
ak.wwise.core.object.getAttenuationCurve

Gets the specified attenuation curve for a given attenuation object.

Arguments

Name Type Description
object * any of: The ID (GUID), name, or path of attenuation object.
string The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
string A project path to a Wwise object, including the category and the work-unit. For example: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.
platform any of: The ID (GUID) or unique name of the platform to get curves. Set to null-guid for unlinked reference.
string The name of the object.
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
curveType * string Type of attenuation curve. Possible values:
  • VolumeDryUsage
  • VolumeWetGameUsage
  • VolumeWetUserUsage
  • LowPassFilterUsage
  • HighPassFilterUsage
  • SpreadUsage
  • FocusUsage
  • ObstructionVolumeUsage
  • ObstructionLPFUsage
  • ObstructionHPFUsage
  • OcclusionVolumeUsage
  • OcclusionLPFUsage
  • OcclusionHPFUsage
  • DiffractionVolumeUsage
  • DiffractionLPFUsage
  • DiffractionHPFUsage
  • TransmissionVolumeUsage
  • TransmissionLPFUsage
  • TransmissionHPFUsage

(Required *)

Arguments Schema

Result

Name Type Description
curveType string Name of attenuation curve. Possible values:
  • VolumeDryUsage
  • VolumeWetGameUsage
  • VolumeWetUserUsage
  • LowPassFilterUsage
  • HighPassFilterUsage
  • SpreadUsage
  • FocusUsage
  • ObstructionVolumeUsage
  • ObstructionLPFUsage
  • ObstructionHPFUsage
  • OcclusionVolumeUsage
  • OcclusionLPFUsage
  • OcclusionHPFUsage
  • DiffractionVolumeUsage
  • DiffractionLPFUsage
  • DiffractionHPFUsage
  • TransmissionVolumeUsage
  • TransmissionLPFUsage
  • TransmissionHPFUsage
use string Defines whether the curve has no points, has its own set of points, or uses those of the VolumeDryUsage curve. Possible values:
  • None
  • Custom
  • UseVolumeDry
  • UseProject
points array The attenuation curve.
An array of points defining a curve.
points [...] object A point in the curve.
points[...].x * number X coordinate of curve point.
points[...].y * number Y coordinate of curve point.
points[...].shape * string Shape of the curve segment between this point and the next. Possible values:
  • Constant
  • Linear
  • Log3
  • Log2
  • Log1
  • InvertedSCurve
  • SCurve
  • Exp1
  • Exp2
  • Exp3

Result Schema

See Also

Examples

Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.


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