Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name	Type	Description
object *		The ID (GUID), name, or path of the object to set value.
value *	string	The new notes of the object.

(Required *)

Arguments Details

object

description : The ID (GUID), name, or path of the object to set value.
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 : ^\

value

type : string
description : The new notes of the object.

Examples :

Setting the notes of an object

Sets the notes of the object defined by "object".

Arguments:

{
    "object": "{A076AA65-B71A-45BB-8841-5A20C52CE727}", 
    "value": "This object's notes are set."
}

Result:

{}

Detailed JSON Schema

Arguments :

{
    "type": "object", 
    "properties": {
        "object": {
            "description": "The ID (GUID), name, or path of the object to set value.", 
            "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": "^\\\\"
                }
            ]
        }, 
        "value": {
            "type": "string", 
            "description": "The new notes of the object."
        }
    }, 
    "required": [
        "object", 
        "value"
    ], 
    "additionalProperties": false
}

Options :

{
    "type": "object", 
    "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 2018.1.11

ak.wwise.core.object.setNotes