# Load Preset
This API endpoint loads a specified preset scene.
# Request Path
{CLTPlatform-ip}:8086/processor/loadPreset
- Replace
{CLTPlatform-ip}
with the corresponding IP address. - The request port is
8086
.
# Protocol
HTTP
# Method
POST
# Request Parameters
- Set the
Content-Type
of the request body toapplication/json
.
Parameter Name | Description | Required | Type | Data Dictionary | Restriction | Example |
---|---|---|---|---|---|---|
command | Command type | Yes | string | - | - | processor/loadPreset |
data | Data | Yes | object | - | - | - |
data >> index | Sender index (starts from 0; -1 for broadcast) | Yes | int | - | - | - |
data >> groupIndex | Screen group index | Yes | int | - | - | - |
data >> presetIndex | Preset index | Yes | int | - | - | - |
# Request Example
{
"command": "processor/loadPreset",
"data": {
"index": 0,
"groupIndex": 0,
"presetIndex": 0
}
}
# Response
Parameter Name | Description | Required | Type | Data Dictionary | Restriction | Example |
---|---|---|---|---|---|---|
command | Command type | Yes | string | - | - | processor/loadPreset |
code | Status code | Yes | int | - | - | - |
message | Message | Yes | string | - | - | - |
data | Data | Yes | object | - | - | - |
# Response Example
{
"code": 20000,
"command": "processor/loadPreset",
"data": {},
"message": "Common_Success"
}