Get Preset Information

This API endpoint retrieves a list of preset scenes from a specified device.

Request Path

{CLTPlatform-ip}:8086/processor/getPreset

• 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 to application/json.

Parameter Name	Description	Required	Type	Data Dictionary	Restriction	Example
command	Command type	Yes	string	-	-	processor/getPreset
data	Data	Yes	object	-	-	-
data >> index	Sender index (starts from 0; -1 for broadcast)	Yes	int	-	-	-
data >> groupIndex	Screen group index	Yes	int	-	-	-

Request Example

{
    "command": "processor/getPreset",
    "data": {
        "index": 0,
        "groupIndex": 0
    }
}

Response

Parameter Name	Description	Required	Type	Data Dictionary	Restriction	Example
command	Command type	Yes	string	-	-	processor/getPreset
code	Status code	Yes	int	-	-	-
message	Message	Yes	string	-	-	-
data	Data	Yes	object	-	-	-
data >> presetList	List of presets	Yes	array	-	-	-
data >> presetList >> presetIndex	Preset index	Yes	int	-	-	-
data >> presetList >> presetName	Preset name (UTF-8)	Yes	string	-	-	-
data >> presetList >> bSaveColorBrightness	Whether color and brightness settings are saved	Yes	boolean	-	-	-
data >> presetList >> supportMaxPresetCount	Maximum supported preset count (0 means not supported)	Yes	int	-	-	-

Response Example

{
    "code": 20000,
    "command": "processor/getPreset",
    "data": {
        "presetList": [
            {
                "bSaveColorBrightness": false,
                "presetIndex": 0,
                "presetName": "Preset 1"
            },
            {
                "bSaveColorBrightness": false,
                "presetIndex": 1,
                "presetName": "Preset 2"
            },
            {
                "bSaveColorBrightness": false,
                "presetIndex": 2,
                "presetName": "Preset 3"
            },
            {
                "bSaveColorBrightness": false,
                "presetIndex": 3,
                "presetName": "Preset 4"
            },
            {
                "bSaveColorBrightness": false,
                "presetIndex": 4,
                "presetName": "Preset 5"
            },
            {
                "bSaveColorBrightness": false,
                "presetIndex": 5,
                "presetName": "Preset 6"
            },
            {
                "bSaveColorBrightness": false,
                "presetIndex": 6,
                "presetName": "Preset 7"
            }
        ]
    },
    "message": "Common_Success"
}

Detailed Description