# Save Preset

This API endpoint allows you to save the current screen content as a preset scene.

# Request Path

{CLTPlatform-ip}:8086/processor/savePreset

  • 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/savePreset
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 - - -
data >> presetName Preset name (UTF-8, max 47 bytes) Yes string - - -
data >> bSaveColorBrightness Whether to save color and brightness settings Yes boolean - - -

# Request Example

{
    "command": "processor/savePreset",
    "data": {
        "index": 0,
        "groupIndex": 0,
        "presetIndex": 0,
        "presetName": "MyPreset",
        "bSaveColorBrightness": false
    }
}

# Response

Parameter Name Description Required Type Data Dictionary Restriction Example
command Command type Yes string - - processor/savePreset
code Status code Yes int - - -
message Message Yes string - - -
data Data Yes object - - -

# Response Example

{
    "code": 20000,
    "command": "processor/savePreset",
    "data": {},
    "message": "Common_Success"
}

# Detailed Description