COEX140

修改预设

POST

/api/v1/preset/update

All

提示

该接口用于修改预设的名称，是否包含输入，输出，屏体拓扑等

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

Device-Key

string

可选

默认值:

10.40.41.200:8001

Body 参数application/json

screenID

string

屏幕ID

必需

获取接口/api/v1/preset，字段为screenID

preset

object

必需

sequenceNumber

integer

预设序号

必需

int16类型，获取接口/api/v1/preset，字段为sequenceNumber

name

string

预设名字

必需

sourceData

boolean

是否修改源相关预设信息

必需

true表示此预设包含输入源参数，false表示不包含

processingData

boolean

是否修改处理相关预设信息

必需

true表示此预设包含处理参数，false表示不包含

outputData

boolean

是否修改输出相关预设信息

必需

true表示此预设包含输出参数，false表示不包含

screenData

boolean

是否修改屏相关预设信息

必需

true表示此预设包含屏参数（包括图层参数），false表示不包含

effectSwitch

integer

过渡是否开启黑屏

必需

0表示不开启黑屏渐变，1表示开启黑屏渐变，默认不开启

示例

{
    "screenID": "string",
    "preset": {
        "sequenceNumber": 0,
        "name": "string",
        "sourceData": true,
        "processingData": true,
        "outputData": true,
        "screenData": true,
        "effectSwitch": 0
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://dev-cn.your-api-server.com:8001/api/v1/preset/update' \
--header 'Device-Key: 10.40.41.200:8001' \
--header 'Content-Type: application/json' \
--data-raw '{
    "screenID": "string",
    "preset": {
        "sequenceNumber": 0,
        "name": "string",
        "sourceData": true,
        "processingData": true,
        "outputData": true,
        "screenData": true,
        "effectSwitch": 0
    }
}'

返回响应

🟢200成功

application/json

Body

code

integer

可选

code返回码，参考《错误码》

data

object

返回数据

可选

message

string

code码对应信息

可选

示例

{
    "code": 0,
    "data": {},
    "message": "string"
}

修改于 2024-07-01 08:40:42

应用预设

获取所有屏的计划信息