COEX-EN
  1. Contents
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
        • 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
      • Retrieve the Number of Cabinets of the Screen
      • Retrieve Screen Information
    • 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. 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 list 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:
1.
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 2024-07-26 07:25:47
Next
Error Code
Built with