Retrieves information about a plugin property.
(Required *)
Graphical User Interface, Command-Line Interface.
| Name | Type | Description |
|---|---|---|
| classId * | integer | The ID (class ID) of the plugin to retrieve the property from. |
| property * | string | The name of the property to retrieve. Refer to the property list for more information. See also Wwise Objects Reference . |
description : The ID (class ID) of the plugin to retrieve the property from.
type : integer
minimum : 0
maximum : 4294967295
type : string
description : The name of the property to retrieve. Refer to the property list for more information. See also Wwise Objects Reference .
pattern : ^[a-zA-Z]
| Name | Type | Description |
|---|---|---|
| name | string | The name of the property. |
| type | string | The type of the property. Refer to the property list for more information. See also Wwise Objects Reference . |
| audioEngineId | integer | The ID (audio engine ID) of the property. |
| default | The default value of the property. | |
| supports | object | |
| display | object | |
| dependencies | array | |
| restriction | object | |
| ui | object |
type : string
description : The name of the property.
type : string
description : The type of the property. Refer to the property list for more information. See also 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 : string
2) type : number
3) type : boolean
type : object
| 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
| 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
resultSchema / dependencies / ...
type : object
| Name | Type | Description |
|---|---|---|
| property | string | The name of the property related to the dependency. Refer to the property list for more information. See also 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. |
resultSchema / dependencies / items / ...
type : string
description : The name of the property related to the dependency. Refer to the property list for more information. See also Wwise Objects Reference .
pattern : ^[a-zA-Z]
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 |
|---|
description : The conditions related to the dependency.
addtionalProperties : False
type : object
| Name | Type | Description |
|---|---|---|
| type | string | The value restriction of the property. Possible values : "Range", "Enum" |
addtionalProperties : True
type : object
| 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 adjustement. |
| 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. |
addtionalProperties : False
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.
addtionalProperties : False
Checks if a property is enabled.
{
"classId": 8192003,
"property": "ModDepth"
}
{
"audioEngineId": 10,
"name": "ModDepth",
"type": "Real32",
"default": 50,
"restriction": {
"type": "Range",
"min": 0,
"max": 100
},
"dependencies": [
{
"property": "EnableLFO",
"action": "Enable",
"conditions": [
{
"type": "Enum",
"values": [
true
]
}
]
}
],
"supports": {
"randomizer": false,
"rtpc": "Exclusive",
"unlink": false
},
"ui": {
"value": {
"decimals": 2,
"fine": 0.01,
"infinity": 0,
"max": 0,
"min": 0,
"step": 0.1
},
"displayAs": {
"lrMix": false,
"musicNote": false,
"bitfield": false
},
"dataMeaning": "None",
"autoUpdate": false
}
}
{
"type": "object",
"properties": {
"classId": {
"description": "The ID (class ID) of the plugin to retrieve the property from.",
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"property": {
"type": "string",
"description": "The name of the property to retrieve. Refer to the property list for more information.",
"pattern": "^[a-zA-Z]"
}
},
"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. Refer to the property list for more information."
},
"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": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"supports": {
"type": "object",
"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",
"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",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string",
"description": "The name of the property related to the dependency. Refer to the property list for more information.",
"pattern": "^[a-zA-Z]"
},
"action": {
"type": "string",
"description": "The name of the action that is performed when the conditions are met."
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"description": "The conditions related to the dependency."
}
},
"addtionalProperties": false
}
},
"restriction": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Range",
"Enum"
],
"description": "The value restriction of the property."
}
},
"addtionalProperties": true
},
"ui": {
"type": "object",
"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 adjustement."
},
"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."
}
},
"addtionalProperties": 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."
}
},
"addtionalProperties": false
}
},
"additionalProperties": false
}
Document version : 1
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise