ak.wwise.core.object.setName

Renames an object.

(Required *)

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

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

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

value

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

Examples :

Renaming a WwiseObject

Renames the object specified by "object" to "value".

Arguments:

{
    "object": "{24979032-B170-43E3-A2E4-469E0193E2C3}", 
    "value": "new name"
}

Result:

{}

Detailed JSON Schema

Arguments :

{
    "type": "object", 
    "properties": {
        "object": {
            "description": "The ID (GUID) or path of the object to rename.", 
            "anyOf": [
                {
                    "type": "string", 
                    "pattern": *Must be a valid GUID*
                }, 
                {
                    "type": "string", 
                    "pattern": "^\\\\"
                }
            ]
        }, 
        "value": {
            "type": "string", 
            "description": "The new name of the object."
        }
    }, 
    "required": [
        "object", 
        "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