COEX-EN
  1. Color Gamut
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
            PUT
          • Switch Color Gamut
            PUT
        • Retrieve Screen Display Effect Parameters
          GET
        • Set Screen Color Temperature
          PUT
        • Set Custom Gamma for the Screen
          POST
        • Set Screen Brightness
          PUT
        • Set Screen Gamma
          PUT
      • 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
        • Retrieve Preset Information
        • Apply Preset
      • 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. Color Gamut

Set Custom Gamut on a Screen-Basis

PUT
/api/v1/screen/output/customgamut
/api/v1/screen/output/customgamut
All
TIP
Adjust the screen custom gamut

Request

Header Params
Content-Type
string 
required
Example:
application/json
Body Params application/json
array of:
screenId
string 
Screen ID
optional
API: /api/v1/screen, key name: screenID.
colorGamutInfo
object 
optional
Gamut information
targetGamut
object 
optional
colorTemperature
number 
optional
Color temperature value corresponding to color gamut
Example
[
  {
    "screenId": "string",
    "colorGamutInfo": {
      "targetGamut": {
        "name": "string",
        "gamut": {
          "rLxy": {
            "name": "string",
            "lum": 0,
            "cx": 0,
            "cy": 0
          },
          "gLxy": {
            "name": "string",
            "lum": 0,
            "cx": 0,
            "cy": 0
          },
          "bLxy": {
            "name": "string",
            "lum": 0,
            "cx": 0,
            "cy": 0
          },
          "wLxy": {
            "name": "string",
            "lum": 0,
            "cx": 0,
            "cy": 0
          }
        }
      },
      "colorTemperature": 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 PUT 'http://127.0.0.1:8001/api/v1/screen/output/customgamut' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "screenId": "string",
        "colorGamutInfo": {
            "targetGamut": {
                "name": "string",
                "gamut": {
                    "rLxy": {
                        "name": "string",
                        "lum": 0,
                        "cx": 0,
                        "cy": 0
                    },
                    "gLxy": {
                        "name": "string",
                        "lum": 0,
                        "cx": 0,
                        "cy": 0
                    },
                    "bLxy": {
                        "name": "string",
                        "lum": 0,
                        "cx": 0,
                        "cy": 0
                    },
                    "wLxy": {
                        "name": "string",
                        "lum": 0,
                        "cx": 0,
                        "cy": 0
                    }
                }
            },
            "colorTemperature": 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
Set HDR Mode
Next
Switch Color Gamut
Built with