Modify Preset - COEX-EN

Request

Header Params

Content-Type

string

required

Example:

application/json

Body Params application/json

screenID

string

Screen ID

required

API: /api/v1/preset, key name: screenID.

preset

object

required

sequenceNumber

integer

Preset number

required

int16 type, API: /api/v1/preset, key name: sequenceNumber.

name

string

Preset Name

required

sourceData

boolean

Whether to modify the input source-related information for the preset

required

true: The preset includes input source-related parameters, false: Not included

processingData

boolean

Whether to modify the processing-related information for the preset

required

true: The preset includes processing-related parameters, false: Not included

outputData

boolean

Whether to modify the output-related information for the preset

required

true: The preset includes output-related parameters, false: Not included

screenData

boolean

Whether to modify the screen-related information for the preset

required

true: The preset includes screen-related parameters (including layer parameters), false: Not included

effectSwitch

integer

Transition through black enabled or not

required

0: Transition through black not enabled, 1: Transition through black enabled. Default to not enabled.

Example

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

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request POST 'http://127.0.0.1:8001/api/v1/preset/update' \
--header 'Content-Type: application/json' \
--data-raw '{
    "screenID": "string",
    "preset": {
        "sequenceNumber": 0,
        "name": "string",
        "sourceData": true,
        "processingData": true,
        "outputData": true,
        "screenData": true,
        "effectSwitch": 0
    }
}'

Responses

🟢200Successful

application/json

Body

code

integer

optional

The return code, refer to "Error Codes."

data

object

optional

Return Data

message

string

optional

Information corresponding to the code.

Example

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