Wwise SDK 2019.1.11

Schema

{
    "additionalProperties": false, 
    "required": [
        "object", 
        "property", 
        "value"
    ], 
    "type": "object", 
    "properties": {
        "property": {
            "pattern": "^[:a-zA-Z0-9 _]+$", 
            "type": "string", 
            "description": "The name of the property. For more information, refer to the property list of Wwise Objects listed in \\ref wobjects_index .\\n A property name. Refer to \\ref wobjects_index for information about the Wwise objects and their properties."
        }, 
        "object": {
            "anyOf": [
                {
                    "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_]*$", 
                    "type": "string", 
                    "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"
                }, 
                {
                    "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}\\}$", 
                    "type": "string", 
                    "description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
                }, 
                {
                    "pattern": "^\\\\", 
                    "type": "string", 
                    "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 the object to set value."
        }, 
        "value": {
            "anyOf": [
                {
                    "type": "null", 
                    "description": "A null value. No reference to an object."
                }, 
                {
                    "type": "string", 
                    "description": "A string value."
                }, 
                {
                    "type": "number", 
                    "description": "A numerical value."
                }, 
                {
                    "type": "boolean", 
                    "description": "A boolean value."
                }
            ], 
            "description": "The value of the object.\\n The value of a property."
        }, 
        "platform": {
            "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}\\}$", 
            "type": "string", 
            "description": "The ID (GUID) of the platform."
        }
    }
}

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.1.11

ak.wwise.core.object.setProperty Arguments Schema

Schema

Was this page helpful?

Need Support?

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