Version

menu_open
Wwise SDK 2018.1.11
ak.wwise.core.object.getAttenuationCurve


Gets the specified attenuation curve for a given attenuation object.

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name Type Description
object *   The ID (GUID), name, or path of attenuation object.
platform string The ID (GUID) of the platform to get curves. Set to null-guid for unlinked reference.
curveType * string Type of attenuation curve.
Possible values : "VolumeDryUsage", "VolumeWetGameUsage", "VolumeWetUserUsage", "LowPassFilterUsage", "HighPassFilterUsage", "SpreadUsage", "FocusUsage"

(Required *)

Arguments Details


object

description : The ID (GUID), name, or path of attenuation object.
Possibilities, one of the following :

1) type : string
pattern : ^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$
description : The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported.

2) type : string
pattern : ^\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\}$

3) type : string
pattern : ^\

platform

description : The ID (GUID) of the platform to get curves. Set to null-guid for unlinked reference.
type : string
pattern : ^\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\}$

curveType

type : string
Possible values : "VolumeDryUsage", "VolumeWetGameUsage", "VolumeWetUserUsage", "LowPassFilterUsage", "HighPassFilterUsage", "SpreadUsage", "FocusUsage"
description : Type of attenuation curve.


Result

Name Type Description
curveType string Name of attenuation curve.
Possible values : "VolumeDryUsage", "VolumeWetGameUsage", "VolumeWetUserUsage", "LowPassFilterUsage", "HighPassFilterUsage", "SpreadUsage", "FocusUsage"
use string Defines if the curve has no points, has its own set of points, or uses those of the VolumeDryUsage curve.
Possible values : "None", "Custom", "UseVolumeDry"
points array  

Result Details


curveType

type : string
Possible values : "VolumeDryUsage", "VolumeWetGameUsage", "VolumeWetUserUsage", "LowPassFilterUsage", "HighPassFilterUsage", "SpreadUsage", "FocusUsage"
description : Name of attenuation curve.

use

type : string
Possible values : "None", "Custom", "UseVolumeDry"
description : Defines if the curve has no points, has its own set of points, or uses those of the VolumeDryUsage curve.

points

type : array

resultSchema / points / ...

items

type : object

Name Type Description
x * number X coordinate of curve point.
y * number Y coordinate of curve point.
shape * string Shape of curve segment between this point and the next.
Possible values : "Constant", "Linear", "Log3", "Log2", "Log1", "InvertedSCurve", "SCurve", "Exp1", "Exp2", "Exp3"

(Required *)


Examples :

Getting an attenuation curve of an object

Gets the "curve" from an object specified by "object"

Arguments:

{
"object": "{A076AA65-B71A-45BB-8841-5A20C52CE727}",
"platform": "{66666666-7777-8888-9999-AAAAAAAAAAAA}",
"curveType": "VolumeDryUsage"
}

Result:

{
"curveType": "VolumeDryUsage",
"points": [
{
"shape": "Exp3",
"x": 0,
"y": 0
},
{
"shape": "SCurve",
"x": 30,
"y": -3
},
{
"shape": "Log1",
"x": 60,
"y": -5
},
{
"shape": "Linear",
"x": 100,
"y": -200
}
],
"use": "Custom"
}


Detailed JSON Schema


Arguments :

{
"type": "object",
"properties": {
"object": {
"description": "The ID (GUID), name, or path of attenuation object.",
"anyOf": [
{
"type": "string",
"pattern": "^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$",
"description": "The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported."
},
{
"type": "string",
"pattern": *Must be a valid GUID*
},
{
"type": "string",
"pattern": "^\\\\"
}
]
},
"platform": {
"description": "The ID (GUID) of the platform to get curves. Set to null-guid for unlinked reference.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"curveType": {
"type": "string",
"enum": [
"VolumeDryUsage",
"VolumeWetGameUsage",
"VolumeWetUserUsage",
"LowPassFilterUsage",
"HighPassFilterUsage",
"SpreadUsage",
"FocusUsage"
],
"description": "Type of attenuation curve."
}
},
"required": [
"object",
"curveType"
]
}


Options :

{
"type": "object",
"properties": {},
"additionalProperties": false
}


Response :

{
"type": "object",
"properties": {
"curveType": {
"type": "string",
"enum": [
"VolumeDryUsage",
"VolumeWetGameUsage",
"VolumeWetUserUsage",
"LowPassFilterUsage",
"HighPassFilterUsage",
"SpreadUsage",
"FocusUsage"
],
"description": "Name of attenuation curve."
},
"use": {
"type": "string",
"enum": [
"None",
"Custom",
"UseVolumeDry"
],
"description": "Defines if the curve has no points, has its own set of points, or uses those of the VolumeDryUsage curve."
},
"points": {
"type": "array",
"items": {
"type": "object",
"properties": {
"x": {
"type": "number",
"description": "X coordinate of curve point."
},
"y": {
"type": "number",
"description": "Y coordinate of curve point."
},
"shape": {
"type": "string",
"description": "Shape of curve segment between this point and the next.",
"enum": [
"Constant",
"Linear",
"Log3",
"Log2",
"Log1",
"InvertedSCurve",
"SCurve",
"Exp1",
"Exp2",
"Exp3"
]
}
},
"required": [
"x",
"y",
"shape"
],
"additionalProperties": false
}
}
}
}

Document version : 1


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