COEX-EN
  1. Internal Source
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
          PUT
      • 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. Internal Source

Set Sending Card Test Pattern

PUT
/api/v1/device/input/pattern/test
/api/v1/device/input/pattern/test
All
TIP
Set test pattern for the sending card

Request

Header Params
Content-Type
string 
required
Example:
application/json
Body Params application/json
mode
integer 
Mode
required
0: Pure color (the color is controlled by the red, green and blue component values below)
16: Horizontal stripes downward
17: Horizontal stripes to the right
18: Diagonal stripes from bottom-left to top-right
19: Diagonal stripes from top-left to bottom-right
20: Grid pattern from top-left to bottom-right
21: Grid pattern to the right
32: Red gradient from left to right
33: Green gradient from left to right
34: Blue gradient from left to right
35: Gray gradient from left to right
36: Red gradient from top to bottom
37: Green gradient from top to bottom
38: Blue gradient from top to bottom
39: Gray gradient from top to bottom
48: Lightning pattern
parameters
object 
Parameter
required
red
integer 
Red component
required
green
integer 
Green component
required
blue
integer 
Blue component
required
gray
integer 
Grayscale
required
Range: 0 to 255
gridWidth
integer 
Spacing
required
Range: 8 to 255
moveSpeed
integer 
Moving speed
required
Range: 0 to 100
gradientStretch
integer 
Gradient stretch
required
Range: 1 to 20
state
integer 
Status
required
Constant to 0
Example
{
  "mode": 0,
  "parameters": {
    "red": 0,
    "green": 0,
    "blue": 0,
    "gray": 0,
    "gridWidth": 0,
    "moveSpeed": 0,
    "gradientStretch": 0,
    "state": 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/device/input/pattern/test' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mode": 0,
    "parameters": {
        "red": 0,
        "green": 0,
        "blue": 0,
        "gray": 0,
        "gridWidth": 0,
        "moveSpeed": 0,
        "gradientStretch": 0,
        "state": 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
Reset Color Adjustment
Next
Set HDR Mode
Built with