Wwise SDK 2019.2.15
Schema

{
    "type": "object",
    "properties": {
        "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. Ex: Event:Play_Sound_01"
                },
                {
                    "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}\\}$",
                    "description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
                },
                {
                    "type": "string",
                    "pattern": "^\\\\",
                    "description": "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."
                }
            ],
            "description": "The ID (GUID), name, or path of attenuation object."
        },
        "platform": {
            "anyOf": [
                {
                    "type": "string",
                    "pattern": "^[a-zA-Z_]+[a-zA-Z_0-9()]*$",
                    "description": "The name of the object."
                },
                {
                    "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}\\}$",
                    "description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
                }
            ],
            "description": "The ID (GUID) or unique name of the platform to set curves. Set to null-guid for unlinked curve."
        },
        "curveType": {
            "type": "string",
            "enum": [
                "VolumeDryUsage",
                "VolumeWetGameUsage",
                "VolumeWetUserUsage",
                "LowPassFilterUsage",
                "HighPassFilterUsage",
                "SpreadUsage",
                "FocusUsage"
            ],
            "description": "The type 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",
            "description": "An array of points defining the curve.",
            "items": {
                "type": "object",
                "description": "A point in the curve.",
                "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 the 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
            }
        }
    },
    "required": [
        "object",
        "curveType",
        "use",
        "points"
    ],
    "additionalProperties": false
}
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.

Get started with Wwise
Wwise SDK 2019.2.15

ak.wwise.core.object.setAttenuationCurve Arguments Schema

Schema

Was this page helpful?

Need Support?

Tell us about your project. We're here to help.
