COEX150
English
  • 简体中文
  • English
  1. Contents
COEX150
English
  • 简体中文
  • English
  • Contents
    • API Instructions
    • Error Codes
    • General API
      • 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
      • Adjust Cabinet Color Temperature
      • Switch Source for Layer
      • Configure EDID
      • Retrieve Real-Time Monitoring Information
    • Input
      • Internal sources
        • Set Internal Source Information
        • Set Sending Card Test Pattern
      • Retrieve Input Information
        • Retrieve Input Source Info
        • Retrieve Input Data
      • Color Adjustment
        • Set Red Shadow
        • Set Green Shadow
        • Set Blue Shadow
        • Set Red Highlight
        • Set Green Highlight
        • Reset Color Adjustment
        • Set Blue Highlight
        • Set Saturation
        • Set Contrast
        • Set Black Level
        • Adjust Hue
      • EDID
        • Set EDID
      • Set HDR Mode
        • Set HDR Mode
    • Screen
      • Image
        • Color Gamut
          • Set Custom Gamut on a Screen-Basis
          • Switch Color Gamut
        • Set Screen Color Temperature
        • Retrieve Screen Display Effect Parameters
        • Set Brightness Limit On/Off
        • Set Brightness Limit Value
        • Set Custom Gamma for the Screen
        • Set Screen Color Temperature
        • Set Screen Brightness
        • Set Screen Gamma
      • Schedule
        • Retrieve All Schedule Information of the Screens
        • Set Schedule On\Off
        • Delete Brightness Strategy
      • Color Correction
        • Set Color Correction On/Off
        • Set Color Correction Data (Black/White)
        • Set Color Correction Data (Other Colors)
      • Layer
        • Switch Source for Layer
      • Process
        • 3D LUT
          • Import 3D LUT File
          • Delete 3D LUT File
          • Set 3D LUT Strength
          • Enable 3D LUT
      • Canvas
        • Canvas Mapping
      • Preset
        • Retrieve Preset Information
        • Apply Preset
        • Modify Preset
      • Output
        • 3D
          • 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
        • Retrieve Display Status
        • Set Output Bit Depth
        • Output Sync Source Switching
      • Retrieve the Number of Cabinets of the Screen
      • Retrieve Screen Information
      • Retrieve Screen Properties Information
    • Device
      • Audio
        • Set Output Audio
        • Retrieve Audio Settings
      • Controller Identify
        • Controller Identify
      • Device Backup
        • Retrieve Device Backup Status
        • Primary/Backup Verify
      • Logs
        • Export Log
      • Controller Time
        • Set System Time
        • Automatic Time Setting On/Off
        • Change the time zone
      • Controller Name
        • Change Controller Name
      • SNMP
        • Retrieve SNMP On/Off Status
        • Set SNMP On/Off
      • Multifunction Card
        • Retrieve Multifunction Card Information
      • Device Identify
        • Device Identify
      • Monitoring
        • Retrieve Real-Time Monitoring Information
      • Set Blackout/Freeze Screen
      • Retrieve Device Information
    • Cabinet
      • Pre-stored Image
        • Set No Data Signal
      • Thermal Calibration
        • Set Thermal Compensation On/Off
        • Thermal Compensation Intensity Adjustment
        • Set Thermal Compensation Mode
      • Brightness Adjustment
        • Set Cabinet RGB Brightness
        • Set Cabinet Brightness
      • Adjust Color Temperature
        • Adjust Cabinet Color Temperature
      • Cabinet Display Control
        • Set Receiving Card Test Pattern
      • Cabinet Identify
        • Enable Cabinet Mapping
      • Multi-Mode
        • Set Multi-mode by Cabinets
      • Configure Cabinet Topology
        • Move Cabinet
      • Retrieve All Cabinet Information
      • Set Cabinet RGBW Brightness Components
  1. Contents

API Instructions

Prerequisites#

Before calling the APIs, it is necessary to ensure the following environment:
1.
Ensure proper communication between the PC and the device.
2.
Make sure that the device is not being occupied by VMP (we recommend clicking on a blank space in the device tree to release the device).

Basic Steps for Use#

1.
Open a API tool of your choice.
2.
Find the information for the API you need to use.
3.
Call the API according to the documentation.

Explanation of Request Methods#

API request methods can be categorized as follows:
1.
GET method
2.
POST method
3.
PUT method
4.
DELETE method
Examples:
####** GET Request**
For example, to retrieve screen information:
5.
Open the API tool.
image.png
2. Find the relevant API endpoint, construct the URL using the IP address and port, change the request method to GET, then call the API to retrieve the results.
image.png

PUT Request#

For example, to set the screen brightness, black screen, or freeze screen:
Screen brightness:
1.
Open the API tool, set the request method to PUT and construct the URL using the IP address and port.
Image.png
2.
Construct the JSON based on the documentation
image.png
3. Send the API request and check if it was successful.
image.png
Black screen and freeze screen:
1.
Open the API tool, set the request method to PUT and construct the URL using the IP address and port.
image.png
2. Construct the JSON based on the documentation
image.png
3. Send the API request and check if it was successful.
image.png

POST Request#

For example, to apply a preset:
1.
Open the API tool, set the request method to POST and construct the URL using the IP address and port.
image.png
2.
Construct the JSON based on the documentation
image.png
3.
Send the API request and check if it was successful.
image.png
Modified at 2025-10-21 01:43:57
Next
Error Codes
Built with