ak.wwise.core.object.setProperty

Sets a property value of an object for a specific platform. Refer to Wwise Objects Reference for more information on the properties available on each object type.

(Required *)

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name	Type	Description
object *		The ID (GUID) or path of the object to set value.
property *	string	The name of the property. Refer to the property list for more information. See also Wwise Objects Reference .
platform	string	The ID (GUID) or path of the platform.
value *		The value of the object.

description : The ID (GUID) or path of the object to set value.
Possibilities, one of the following :

1) 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}$

2) type : string
pattern : ^\

property

type : string
description : The name of the property. Refer to the property list for more information. See also Wwise Objects Reference .
pattern : ^[a-zA-Z]

platform

description : The ID (GUID) or path of the platform.
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}$

value

description : The value of the object.
Possibilities, one of the following :

1) type : string

2) type : number

3) type : boolean

Examples :

Setting the value of a specified property

Sets the "Volume" property of the object defined by "object" to "Value".

Arguments:

{
    "object": "{A076AA65-B71A-45BB-8841-5A20C52CE727}", 
    "property": "Volume", 
    "platform": "{66666666-7777-8888-9999-AAAAAAAAAAAA}", 
    "value": 5.7
}

Result:

{}

Detailed JSON Schema

Arguments :

{
    "type": "object", 
    "properties": {
        "object": {
            "description": "The ID (GUID) or path of the object to set value.", 
            "anyOf": [
                {
                    "type": "string", 
                    "pattern": *Must be a valid GUID*
                }, 
                {
                    "type": "string", 
                    "pattern": "^\\\\"
                }
            ]
        }, 
        "property": {
            "type": "string", 
            "description": "The name of the property. Refer to the property list for more information.", 
            "pattern": "^[a-zA-Z]"
        }, 
        "platform": {
            "description": "The ID (GUID) or path of the platform.", 
            "type": "string", 
            "pattern": *Must be a valid GUID*
        }, 
        "value": {
            "description": "The value of the object.", 
            "anyOf": [
                {
                    "type": "string"
                }, 
                {
                    "type": "number"
                }, 
                {
                    "type": "boolean"
                }
            ]
        }
    }, 
    "required": [
        "object", 
        "property", 
        "value"
    ], 
    "additionalProperties": false
}

Options :

{
    "type": "object", 
    "required": [], 
    "properties": {}, 
    "additionalProperties": false
}

Response :

{
    "type": "object", 
    "properties": {}, 
    "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.

Get started with Wwise

Wwise SDK 2017.1.9