Wwise SDK 2018.1.11

Retrieves the list of property and reference names for an object.

Deprecated in favor of ak.wwise.core.object.getPropertyAndReferenceNames

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name	Type	Description
object		The ID (GUID), name, or path of the object to watch.
classId	integer	The ID (class ID) of the object to retrieve the property and reference names from.

Required argument groups:

(object)
(classId)

Arguments Details

object

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

classId

description : The ID (class ID) of the object to retrieve the property and reference names from.
type : integer
minimum : 0
maximum : 4294967295

Result

Name	Type	Description
return	array

Result Details

return

type : array

resultSchema / return / ...

items

type : string
description : The name of the property or reference.

Examples :

Retrieving the list of property and reference names of an object.

Retrieves the list of property and reference names of an object.

Arguments:

{
    "classId": 8192003
}

Result:

{
    "return": [
        "DelayTime", 
        "DryLevel", 
        "FeedForwardLevel", 
        "FeedBackLevel", 
        "EnableLFO", 
        "ModDepth", 
        "ModFrequency", 
        "ModWaveform", 
        "ModSmoothing", 
        "ModPWM", 
        "ModPhaseOffset", 
        "ModPhaseMode", 
        "ModPhaseSpread", 
        "WetDryMix", 
        "OutputLevel", 
        "ProcessCenter", 
        "ProcessLFE"
    ]
}

Detailed JSON Schema

Arguments :

{
    "type": "object", 
    "properties": {
        "object": {
            "description": "The ID (GUID), name, or path of the object to watch.", 
            "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": "^\\\\"
                }
            ]
        }, 
        "classId": {
            "description": "The ID (class ID) of the object to retrieve the property and reference names from.", 
            "type": "integer", 
            "minimum": 0, 
            "maximum": 4294967295
        }
    }, 
    "oneOf": [
        {
            "required": [
                "object"
            ]
        }, 
        {
            "required": [
                "classId"
            ]
        }
    ], 
    "additionalProperties": false
}

Options :

{
    "type": "object", 
    "properties": {}, 
    "additionalProperties": false
}

Response :

{
    "type": "object", 
    "properties": {
        "return": {
            "type": "array", 
            "items": {
                "type": "string", 
                "description": "The name of the property or reference."
            }
        }
    }, 
    "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