COEX-EN
  1. Preset
COEX-EN
  • Contents
    • API Instructions
    • Error Code
    • General
      • Retrieve Screen Information
      • Set Screen Brightness
      • Set Screen Gamma
      • Set Blackout/Freeze Screen
      • Retrieve Preset Information
      • Apply Preset
      • Retrieve All Cabinet Information
      • Enable Cabinet Mapping
      • Retrieve Input Source List
      • Switch Source for Layer
      • Set EDID
      • Set Screen Color Temperature
    • Input
      • Retrieve Input Information
        • Retrieve Input Data
        • Retrieve Input Source List
      • EDID
        • Set EDID
      • Color Adjustment
        • Set Saturation
        • Set Color Highlight
        • Set Color Shadow
        • Adjust Hue
        • Reset Color Adjustment
      • Internal Source
        • Set Sending Card Test Pattern
      • Set HDR Mode
        • Set HDR Mode
    • Screen
      • Image booster
        • Color Gamut
          • Set Custom Gamut on a Screen-Basis
          • Switch Color Gamut
        • Retrieve Screen Display Effect Parameters
        • Set Screen Color Temperature
        • Set Custom Gamma for the Screen
        • Set Screen Brightness
        • Set Screen Gamma
      • Layer
        • Switch Source for Layer
      • Processing
        • 3D LUT
          • Delete 3D LUT File
          • Import 3D LUT File
          • Set 3D LUT Strength
          • Enable 3D LUT
      • Canvas
        • Canvas Mapping
      • Preset
        • Modify Preset
          POST
        • Retrieve Preset Information
          GET
        • Apply Preset
          POST
      • Schedule
        • Retrieve All Schedule Information of the Screens
        • Set Schedule On\Off
        • Delete Brightness Schedule
      • Output
        • 3D function
          • 3D Emitter
            • Enable 3D Emitter
          • Enable/Disable 3D
        • Retrieve Output Parameters
          • Retrieve Screen Output Data
        • Display mode
          • Set Blackout/Freeze Screen
        • Multi-Mode
          • Set Multi-mode by Screens
        • 3D
          • 3D Emitter
        • Display Mode
        • Retrieve Display Status
        • Set Output Bit Depth
      • Image Booster
        • Color Gamut
      • Retrieve Screen Properties Information
        GET
      • Retrieve the Number of Cabinets of the Screen
        GET
      • Retrieve Screen Information
        GET
    • Device
      • Device Identify
        • Device Identify
      • Monitoring
        • Retrieve Real-Time Monitoring Information
      • Set Blackout/Freeze Screen
    • Cabinet
      • Retrieve Cabinet Information
        • Retrieve All Cabinet Information
      • Brightness Adjustment
        • Set Cabinet RGB Brightness
        • Set Cabinet Brightness
      • Color Temperature Adjustment
        • Adjust Cabinet Color Temperature
      • Cabinet Control
        • Set Receiving Card Test Pattern
      • Cabinet Identify
        • Enable Cabinet Mapping
      • Multi-Mode
        • Set Multi-mode by Cabinets
      • Configure Cabinet Topology
        • Move Cabinet
  1. Preset

Modify Preset

POST
/api/v1/preset/update
/api/v1/preset/update
All
TIP
Modify preset name and whether to include input, output, screen topology data

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
Request Request Example
Shell
JavaScript
Java
Swift
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"
}
Modified at 2024-07-09 11:01:54
Previous
Canvas Mapping
Next
Retrieve Preset Information
Built with