ak.wwise.core.object.isPropertyEnabled

Retrieves the status of a property.

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name	Type	Description
object *		The ID (GUID) or path of the object to check.
platform *	string	The ID (GUID) or path of the platform to link the reference. Set to null-guid for unlinked reference.
property *	string	The name of the property. For more information, refer to the property list of Wwise Objects listed in Wwise Objects Reference.

(Required *)

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

platform

description : The ID (GUID) or path of the platform to link the reference. Set to null-guid for unlinked reference.
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}\}$

property

type : string
description : The name of the property. For more information, refer to the property list of Wwise Objects listed in Wwise Objects Reference.
pattern : ^[a-zA-Z0-9 _]+$

Result

Name	Type	Description
return	boolean	Indicates if the property is enabled.

Result Details

return

type : boolean
description : Indicates if the property is enabled.

Examples :

Checking if a property is enabled.

Checks if a property is enabled.

Arguments:

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

Result:

{
    "return": true
}

Detailed JSON Schema

Arguments :

{
    "type": "object", 
    "properties": {
        "object": {
            "description": "The ID (GUID) or path of the object to check.", 
            "anyOf": [
                {
                    "type": "string", 
                    "pattern": *Must be a valid GUID*
                }, 
                {
                    "type": "string", 
                    "pattern": "^\\\\"
                }
            ]
        }, 
        "platform": {
            "description": "The ID (GUID) or path of the platform to link the reference.  Set to null-guid for unlinked reference.", 
            "type": "string", 
            "pattern": *Must be a valid GUID*
        }, 
        "property": {
            "type": "string", 
            "description": "The name of the property.", 
            "pattern": "^[a-zA-Z0-9 _]+$"
        }
    }, 
    "required": [
        "object", 
        "platform", 
        "property"
    ], 
    "additionalProperties": false
}

Options :

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

Response :

{
    "type": "object", 
    "properties": {
        "return": {
            "type": "boolean", 
            "description": "Indicates if the property is enabled."
        }
    }, 
    "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.2.10