Retrieves the list of property names for an object.
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 properties from. |
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 properties from.
type : integer
minimum : 0
maximum : 4294967295
| Name | Type | Description |
|---|---|---|
| return | array |
type : array
resultSchema / return / ...
type : string
description : The name of the property.
Retrieves the list of properties of an object.
{
"classId": 8192003
}
{
"return": [
"DelayTime",
"DryLevel",
"FeedForwardLevel",
"FeedBackLevel",
"EnableLFO",
"ModDepth",
"ModFrequency",
"ModWaveform",
"ModSmoothing",
"ModPWM",
"ModPhaseOffset",
"ModPhaseMode",
"ModPhaseSpread",
"WetDryMix",
"OutputLevel",
"ProcessCenter",
"ProcessLFE"
]
}
{
"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 properties from.",
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
},
"oneOf": [
{
"required": [
"object"
]
},
{
"required": [
"classId"
]
}
],
"additionalProperties": false
}
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
}
{
"type": "object",
"properties": {
"return": {
"type": "array",
"items": {
"type": "string",
"description": "The name of the property."
}
}
},
"additionalProperties": false
}
Document version : 1