Retrieves information about an object property.
Graphical User Interface, Command-Line Interface.
| Name | Type | Description |
|---|---|---|
| object | The ID (GUID) or path of the object to watch. | |
| classId | integer | The ID (class ID) of the object to retrieve the property from. |
| property | string | The name of the property to retrieve. For more information, refer to the property list of Wwise Objects listed in Wwise Objects Reference. |
Required argument groups:
description : The ID (GUID) or path of the object to watch.
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 : ^\
description : The ID (class ID) of the object to retrieve the property from.
type : integer
minimum : 0
maximum : 4294967295
type : string
description : The name of the property to retrieve. For more information, refer to the property list of Wwise Objects listed in Wwise Objects Reference.
pattern : ^[a-zA-Z0-9 _]+$
| Name | Type | Description |
|---|---|---|
| name | string | The name of the property. |
| type | string | The type of the property. For more information, refer to the property list of Wwise Objects listed in Wwise Objects Reference. |
| audioEngineId | integer | The ID (audio engine ID) of the property. |
| default | The default value of the property. | |
| supports | object | Features supported by the property. |
| display | object | Display information related to the property. |
| dependencies | array | List of dependencies on other properties with their related action and conditions. |
| restriction | Restriction on the value of the property. | |
| ui | object | Information related to how the property is displayed. |
type : string
description : The name of the property.
type : string
description : The type of the property. For more information, refer to the property list of Wwise Objects listed in Wwise Objects Reference.
description : The ID (audio engine ID) of the property.
type : integer
minimum : 0
maximum : 4294967295
description : The default value of the property.
Possibilities, one of the following :
1) type : null
2) type : string
3) type : number
4) type : boolean
type : object
description : Features supported by the property.
| Name | Type | Description |
|---|---|---|
| rtpc | string | The RTPC mode that is supported by the property. Possible values : "None", "Additive", "Exclusive", "Multiplicative" |
| randomizer | boolean | Indicates if the randomizer is supported by the property. |
| unlink | boolean | Indicates if unlink is supported by the property. |
type : object
description : Display information related to the property.
| Name | Type | Description |
|---|---|---|
| name | string | The display name of the property. |
| group | string | The display group of the property. |
| index | integer | The display index of the property. |
type : array
description : List of dependencies on other properties with their related action and conditions.
resultSchema / dependencies / ...
type : object
| Name | Type | Description |
|---|---|---|
| type * | string | Defines the type of dependency. Possible values : "override", "property", "reference" |
| property * | string | The name of the property on which the dependency is. For more information, refer to the property list of Wwise Objects listed in Wwise Objects Reference. |
| action * | string | The name of the action that is performed when the conditions are met. |
| conditions | array | The conditions related to the dependency. |
(Required *)
resultSchema / dependencies / items / ...
type : string
Possible values : "override", "property", "reference"
description : Defines the type of dependency.
resultSchema / dependencies / items / ...
type : string
description : The name of the property on which the dependency is. For more information, refer to the property list of Wwise Objects listed in Wwise Objects Reference.
pattern : ^[a-zA-Z0-9 _]+$
resultSchema / dependencies / items / ...
type : string
description : The name of the action that is performed when the conditions are met.
resultSchema / dependencies / items / ...
type : array
resultSchema / dependencies / items / conditions / ...
type : object
| Name | Type | Description |
|---|---|---|
| referenceIsSet | boolean | Used for reference dependencies, defines if the target reference must be set or not. |
| restriction | Used for property dependencies, defines the restriction on which the property must be set. |
Possibilities, one of the following :
1)
2) description : The conditions related to the dependency.
description : Restriction on the value of the property.
Possibilities, one of the following :
1) type : object
description : Empty object indicating that the property has no restriction.
2) type : object
description : Restriction on the range of values the property supports.
| Name | Type | Description |
|---|---|---|
| type * | string | The value restriction of the property. Possible values : "range" |
| min * | number | The minimum value for the property. |
| max * | number | The maximum value for the property. |
(Required *)
3) type : object
description : Restrictions on the reference object.
| Name | Type | Description |
|---|---|---|
| type * | string | The object reference restrictions of the property. Possible values : "reference" |
| restrictions * | array | List of object reference restrictions. |
(Required *)
resultSchema / restriction / ...
type : string
Possible values : "reference"
description : The object reference restrictions of the property.
resultSchema / restriction / ...
type : array
description : List of object reference restrictions.
resultSchema / restriction / restrictions / ...
Possibilities, one of the following :
1) type : object
description : Restriction on the object type that can be referenced.
| Name | Type | Description |
|---|---|---|
| type * | array |
(Required *)
resultSchema / restriction / restrictions / items / ...
type : array
resultSchema / restriction / restrictions / items / type / ...
type : string
description : Possible object type supported. See Wwise Objects Reference for the list of objects.
2) type : object
description : Restriction on the object category from which objects can be referenced.
| Name | Type | Description |
|---|---|---|
| category * | array |
(Required *)
resultSchema / restriction / restrictions / items / ...
type : array
resultSchema / restriction / restrictions / items / category / ...
type : string
description : Possible category supported.
3) type : object
description : Restriction on the hierarchy position relative to a parent objects must occupy.
| Name | Type | Description |
|---|---|---|
| childOfReference * | string | Name of the reference. |
(Required *)
4) type : string
description : Flag restrictions that, when present, are considered true. notNull indicates that the referenced object must exist; it cannot be null. playable indicates that the referenced object must be playable.
Possible values : "notNull", "playable"
4) type : object
| Name | Type | Description |
|---|---|---|
| type * | string | The value restriction of the property. Possible values : "enum" |
| values * | array | List of the possible enumerated values the property is restricted to. |
(Required *)
resultSchema / restriction / ...
type : string
Possible values : "enum"
description : The value restriction of the property.
resultSchema / restriction / ...
type : array
description : List of the possible enumerated values the property is restricted to.
resultSchema / restriction / values / ...
type : object
| Name | Type | Description |
|---|---|---|
| value | One of the enumerated values. | |
| displayName | string | The name associated with the value. |
type : object
description : Information related to how the property is displayed.
| Name | Type | Description |
|---|---|---|
| value | object | |
| displayAs | object | |
| dataMeaning | string | The unit type of the property. Possible values : "None", "Frequency", "Decibels", "PitchCents" |
| autoUpdate | boolean | Indicates if the value of the property is updated while moving the slider. |
resultSchema / ui / ...
type : object
| Name | Type | Description |
|---|---|---|
| decimals | integer | The number of decimals displayed for the value. |
| step | number | The amount by which the display increments the value. |
| fine | number | The amount by which the display increments the value for fine adjustment. |
| min | number | The minimum display value. |
| max | number | The maximum display value. |
| infinity | number | The number used to represent infinity. |
resultSchema / ui / ...
type : object
| Name | Type | Description |
|---|---|---|
| lrMix | boolean | Indicates if the property should be displayed as a left-right mix. |
| musicNote | boolean | Indicates if the property should be displayed as a music note (MIDI). |
| bitfield | boolean | Indicates if the property should be displayed as a bitfield. |
resultSchema / ui / ...
type : string
Possible values : "None", "Frequency", "Decibels", "PitchCents"
description : The unit type of the property.
resultSchema / ui / ...
type : boolean
description : Indicates if the value of the property is updated while moving the slider.
Retrieves information about an object property.
{
"classId": 65552,
"property": "Volume"
}
{
"name": "Volume",
"type": "Real64",
"default": 0,
"audioEngineId": 0,
"supports": {
"rtpc": "Additive",
"randomizer": true,
"unlink": true
},
"display": {
"name": "Voice Volume",
"index": 1816,
"group": "Audio/General Settings"
},
"dependencies": [],
"restriction": {
"type": "range",
"max": 200,
"min": -200
},
"ui": {
"value": {
"max": 12,
"min": -96,
"decimals": 1,
"step": 1,
"fine": 0.1,
"infinity": 0
},
"displayAs": {
"lrMix": false,
"musicNote": false,
"bitfield": false
},
"dataMeaning": "Decibels",
"autoUpdate": false
}
}
{
"type": "object",
"properties": {
"object": {
"description": "The ID (GUID) or path of the object to watch.",
"anyOf": [
{
"type": "string",
"pattern": *Must be a valid GUID*
},
{
"type": "string",
"pattern": "^\\\\"
}
]
},
"classId": {
"description": "The ID (class ID) of the object to retrieve the property from.",
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"property": {
"type": "string",
"description": "The name of the property to retrieve.",
"pattern": "^[a-zA-Z0-9 _]+$"
}
},
"oneOf": [
{
"required": [
"object",
"property"
]
},
{
"required": [
"classId",
"property"
]
}
],
"additionalProperties": false
}
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
}
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the property."
},
"type": {
"type": "string",
"description": "The type of the property."
},
"audioEngineId": {
"description": "The ID (audio engine ID) of the property.",
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"default": {
"description": "The default value of the property.",
"anyOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"supports": {
"type": "object",
"description": "Features supported by the property.",
"properties": {
"rtpc": {
"type": "string",
"enum": [
"None",
"Additive",
"Exclusive",
"Multiplicative"
],
"description": "The RTPC mode that is supported by the property."
},
"randomizer": {
"type": "boolean",
"description": "Indicates if the randomizer is supported by the property."
},
"unlink": {
"type": "boolean",
"description": "Indicates if unlink is supported by the property."
}
},
"additionalProperties": false
},
"display": {
"type": "object",
"description": "Display information related to the property.",
"properties": {
"name": {
"type": "string",
"description": "The display name of the property."
},
"group": {
"type": "string",
"description": "The display group of the property."
},
"index": {
"type": "integer",
"description": "The display index of the property."
}
},
"additionalProperties": false
},
"dependencies": {
"type": "array",
"description": "List of dependencies on other properties with their related action and conditions.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"override",
"property",
"reference"
],
"description": "Defines the type of dependency."
},
"property": {
"type": "string",
"description": "The name of the property on which the dependency is.",
"pattern": "^[a-zA-Z0-9 _]+$"
},
"action": {
"type": "string",
"description": "The name of the action that is performed when the conditions are met."
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"referenceIsSet": {
"type": "boolean",
"description": "Used for reference dependencies, defines if the target reference must be set or not."
},
"restriction": {
"$ref": "#/properties/restriction",
"description": "Used for property dependencies, defines the restriction on which the property must be set."
}
},
"oneOf": [
{
"required": [
"referenceIsSet"
]
},
{
"required": [
"restriction"
]
}
],
"additionalProperties": false
},
"description": "The conditions related to the dependency."
}
},
"required": [
"type",
"property",
"action"
],
"additionalProperties": false
}
},
"restriction": {
"description": "Restriction on the value of the property.",
"oneOf": [
{
"type": "object",
"description": "Empty object indicating that the property has no restriction.",
"additionalProperties": false
},
{
"type": "object",
"description": "Restriction on the range of values the property supports.",
"properties": {
"type": {
"type": "string",
"enum": [
"range"
],
"description": "The value restriction of the property."
},
"min": {
"type": "number",
"description": "The minimum value for the property."
},
"max": {
"type": "number",
"description": "The maximum value for the property."
}
},
"additionalProperties": false,
"required": [
"type",
"min",
"max"
]
},
{
"type": "object",
"description": "Restrictions on the reference object.",
"properties": {
"type": {
"type": "string",
"enum": [
"reference"
],
"description": "The object reference restrictions of the property."
},
"restrictions": {
"type": "array",
"description": "List of object reference restrictions.",
"items": {
"oneOf": [
{
"type": "object",
"description": "Restriction on the object type that can be referenced.",
"properties": {
"type": {
"type": "array",
"items": {
"type": "string",
"description": "Possible object type supported."
}
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"description": "Restriction on the object category from which objects can be referenced.",
"properties": {
"category": {
"type": "array",
"items": {
"type": "string",
"description": "Possible category supported."
}
}
},
"additionalProperties": false,
"required": [
"category"
]
},
{
"type": "object",
"description": "Restriction on the hierarchy position relative to a parent objects must occupy.",
"properties": {
"childOfReference": {
"type": "string",
"description": "Name of the reference."
}
},
"additionalProperties": false,
"required": [
"childOfReference"
]
},
{
"type": "string",
"description": "Flag restrictions that, when present, are considered true. <b>notNull</b> indicates that the referenced object must exist; it cannot be null. <b>playable</b> indicates that the referenced object must be playable.",
"enum": [
"notNull",
"playable"
]
}
]
}
}
},
"additionalProperties": false,
"required": [
"type",
"restrictions"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"enum"
],
"description": "The value restriction of the property."
},
"values": {
"type": "array",
"description": "List of the possible enumerated values the property is restricted to.",
"items": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "One of the enumerated values."
},
"displayName": {
"type": "string",
"description": "The name associated with the value."
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false,
"required": [
"type",
"values"
]
}
]
},
"ui": {
"type": "object",
"description": "Information related to how the property is displayed.",
"properties": {
"value": {
"type": "object",
"properties": {
"decimals": {
"type": "integer",
"description": "The number of decimals displayed for the value."
},
"step": {
"type": "number",
"description": "The amount by which the display increments the value."
},
"fine": {
"type": "number",
"description": "The amount by which the display increments the value for fine adjustment."
},
"min": {
"type": "number",
"description": "The minimum display value."
},
"max": {
"type": "number",
"description": "The maximum display value."
},
"infinity": {
"type": "number",
"description": "The number used to represent infinity."
}
},
"additionalProperties": false
},
"displayAs": {
"type": "object",
"properties": {
"lrMix": {
"type": "boolean",
"description": "Indicates if the property should be displayed as a left-right mix."
},
"musicNote": {
"type": "boolean",
"description": "Indicates if the property should be displayed as a music note (MIDI)."
},
"bitfield": {
"type": "boolean",
"description": "Indicates if the property should be displayed as a bitfield."
}
},
"additionalProperties": false
},
"dataMeaning": {
"type": "string",
"enum": [
"None",
"Frequency",
"Decibels",
"PitchCents"
],
"description": "The unit type of the property."
},
"autoUpdate": {
"type": "boolean",
"description": "Indicates if the value of the property is updated while moving the slider."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
Document version : 1