H Series OpenAPI Instructions
Home
ChineseVersion
Home
ChineseVersion
  1. Inputs
  • Instructions
  • Error Codes
  • Change History
  • Devices
    • Read Device Detailed Information
      POST
    • Read Device Card Information
      POST
    • Read Device IP
      POST
  • Homepage
    • Read System Initialization Status
      POST
    • Read Video Server Address
      POST
  • Screen
    • Set Screen Gamma
    • Display Screen ID
    • Set Screen Brightness
    • Save Screen Brightness
    • Add Screens
    • Delete Screens
    • Read Screen Detailed Information
    • Query Screen List
    • Screen FTB
    • Set BKG
    • Set Freezing
    • Read Screen Not in Live Mode
    • Set 3D Effect
    • Set Screen Layout Information
    • Set Image OSD
    • Set Text OSD
    • Delete Multiple Screens
    • Rename Screens
  • Inputs
    • Read Input List
      POST
    • Read Detailed Information of Specified Inputs
      POST
    • Set Cropping
      POST
    • Delete
      POST
    • Edit Cropping
      POST
    • Set Resolutions
      POST
    • Set Timing
      POST
    • Create Input Groups
      POST
    • Sort Input Groups
      POST
    • Edit Groups
      POST
    • Delete Groups
      POST
    • Delete Input Sources by Groups
      POST
    • Import EDID
      POST
    • Rename
      POST
    • Create Signal Source Playlists
      POST
    • Read Signal Source Playlists
      POST
    • Edit Signal Source Playlist Information
      POST
    • Enable Signal Source Playlists
      POST
    • Delete Signal Source Playlists
      POST
  • Outputs
    • Set Image Quality
    • Set Gamma
    • Set Output Locating
    • Rename
    • Set Timing for 4K Output Card
    • Read Detailed Information
    • Read Output List
    • Se Output Timing
    • Set Output Resolutions
    • Set Areas Loaded by All-in-One Cards
  • Layers
    • Set Stream Pulling Rules for IPC Sources Only
    • Add Layers
    • Delete Layers
    • Read Layer List
    • Read Layer Details
    • Set Layer Basic Information
    • Read Layer Z-order
    • Set Layer Information
    • Clear Layers
    • Set Layer Z-order
    • Lock Layers
    • Change Layer Source Information
    • Freeze Layers
    • Open Layer Layouts
  • Presets
    • Create Presets
    • Delete Presets
    • Set Basic Information of Specified Presets
    • Load Presets
    • Read Detailed Information of Specified Presets
    • Clear Presets
    • Get Preset Group List
    • Create Preset Groups
    • Delete Preset Groups
    • Get Preset Group Enumeration
    • Play Preset Playlist
    • Read All Presets
    • Read Preset Playlist
    • Read Current Played Preset
    • Edit Preset Groups
    • Overwrite Presets
  • BKG
    • Create BKG
    • Delete BKG
    • Get BKG Detailed Information
    • Comprehensive Query
  • IPC
    • IPC Source List
    • Read Specified Data in IPC Source List
    • IP Camera List
    • Obtain IPC Source Channel List
    • Obtain Details of IPC Source Channel List
    • Details of IPC Mosaic Source Channel Data
    • Add IPC Sources
    • Delete IPC Sources
    • Rename IPC Sources
    • Change IPC Source Channels
    • Add IPC Source Channels
    • Delete IPC Source Channels
    • IPC Source Slot List
    • IPC Sources and Channels
    • Check IPC Source Names
    • IPC Source Group List
    • Create IPC Source Groups
    • Delete IPC Source Groups
    • Change IPC Groups
    • Delete IPC Source Group Nodes
    • IPC Mosaic Source List
    • Create IPC Mosaic Source Templates
    • Update IPC Mosaic Source Templates
    • Delete IPC Mosaic Source Templates
    • Apply IPC Mosaic Source Templates
    • Rename IPC Mosaic Sources
  1. Inputs

Read Input List

POST
/open/api/input/readList
Description
"inputId": Input ID. Each card has four fixed interface IDs. For input card 1, these four interface IDs are 0, 1, 2, and 3. Slots reserve IDs even when no card is installed.
"deviceId": Device ID
"general":
colorDepth": Color depth (0: 8bits, 1: 10bits, 2: 12bits, 3: 16bits)
"colorSpace": Output color space (0: RGB, 1: YCbCr)
"sampleRate": Color/sampling rate (0: 444, 1: 422, 2: 420)
"connectCapacity": Connection capacity (0: SL, 1: DL. 2: 4K)
"HDCPEncryted": Encrypt or not.
"cscMode": 0: Enable the limited to full function. 1: Disable the limited to full function.
“backup”: This field is now deprecated.
"resolution": Actual input resolution, refresh: refresh valuex100
"timing":
"refreshRate": Frame ratex100
"templateOperationType": 0: Default EDID template, 1: Download the EDID template.
"horizontal” and "vertical” represent the horizontal and vertical timing respectively.
"addrTime": Horizontal or vertical resolution
"frontPorch": Front porch
"sync": Synchronization
"syncPolarity": Sync polarity
"online": 0: Offline, 1: Online, 2: Online and then offline
"isSupportAudio": Support audio or not. 0: Not support, 1: Support
"withAudioInterface": With an audio interface or not, such as 3.5mm audio interface
"audioSrc": 0: From a video interface, 1: From an audio interface, such as 3.5mm audio interface
"linkStatus": Link status of an audio interface (0: Offline, 1: Online)
"hdcpConfig": HDCP configuration (0: Off, 1: HDCP 1.3, 2: HDCP 1.4, 3: HDCP 2.2)
“reverseControl”: Reverse control
1. Online=1 in an input source means that this input source is valid.

Request

Body Params application/json

Example
{
    "body": "PRHDAqKg0ZVlmoTm5ezyNBhYLkeHY/Bq",
    "sign": "MjI0OGYzMGQwMjhlMmI4YTNmMjM2MjE3MjYzYTFkODg=",
    "pId": "1",
    "timeStamp": "1631949094265"
}

Request Code 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 --request POST '/open/api/input/readList' \
--header 'Content-Type: application/json' \
--data-raw '{
    "body": "PRHDAqKg0ZVlmoTm5ezyNBhYLkeHY/Bq",
    "sign": "MjI0OGYzMGQwMjhlMmI4YTNmMjM2MjE3MjYzYTFkODg=",
    "pId": "1",
    "timeStamp": "1631949094265"
}'

Responses

🟢200Successful
application/json
Body

Example
{
    "body": {
        "inputs": [
            {
                "audioInterface": {
                    "audioSrc": 1,
                    "linkStatus": 0,
                    "withAudioInterface": 0
                },
                "backup": {
                    "cropId": 0,
                    "enable": 0,
                    "inputId": 0,
                    "type": 0
                },
                "crops": [],
                "defaultName": "input 3-3-1",
                "general": {
                    "HDCPEncryted": 0,
                    "channelNum": 1,
                    "colorDepth": 0,
                    "colorGamut": 0,
                    "colorRange": 0,
                    "colorSpace": 0,
                    "connectCapacity": 0,
                    "cscMode": 0,
                    "defaultName": "input 3-3-1",
                    "dynamicRange": 0,
                    "name": "input 3-3-1",
                    "sampleRate": 0
                },
                "inputId": 8,
                "interfaceId": 0,
                "interfaceType": 27,
                "isSupportAudio": 0,
                "isUsed": 1,
                "macCompatibility": 0,
                "mismatchState": 0,
                "modelId": 31504,
                "mosaicMode": 0,
                "name": "input 3-3-1",
                "online": 1,
                "overLoadState": 0,
                "resolution": {
                    "height": 0,
                    "isInterlace": 0,
                    "refresh": 0,
                    "width": 0
                },
                "reverseControl": {
                    "ip": "",
                    "port": 18986
                },
                "slotId": 2,
                "sourceType": 1,
                "timing": {
                    "horizontal": {
                        "addrTime": 3840,
                        "frontPorch": 176,
                        "sync": 88,
                        "syncPolarity": 0,
                        "totalTime": 4400
                    },
                    "refreshRate": 60,
                    "templateId": 0,
                    "templateOperationType": 0,
                    "vertical": {
                        "addrTime": 2160,
                        "frontPorch": 8,
                        "sync": 10,
                        "syncPolarity": 0,
                        "totalTime": 2250
                    }
                }
            },
            {
                "audioInterface": {
                    "audioSrc": 1,
                    "linkStatus": 0,
                    "withAudioInterface": 0
                },
                "backup": {
                    "cropId": 0,
                    "enable": 0,
                    "inputId": 0,
                    "type": 0
                },
                "crops": [],
                "defaultName": "input 3-3-2",
                "general": {
                    "HDCPEncryted": 0,
                    "channelNum": 1,
                    "colorDepth": 0,
                    "colorGamut": 0,
                    "colorRange": 0,
                    "colorSpace": 0,
                    "connectCapacity": 0,
                    "cscMode": 0,
                    "defaultName": "input 3-3-2",
                    "dynamicRange": 0,
                    "name": "input 3-3-2",
                    "sampleRate": 0
                },
                "inputId": 9,
                "interfaceId": 1,
                "interfaceType": 27,
                "isSupportAudio": 0,
                "isUsed": 0,
                "macCompatibility": 0,
                "mismatchState": 0,
                "modelId": 31504,
                "mosaicMode": 0,
                "name": "input 3-3-2",
                "online": 1,
                "overLoadState": 0,
                "resolution": {
                    "height": 0,
                    "isInterlace": 0,
                    "refresh": 0,
                    "width": 0
                },
                "reverseControl": {
                    "ip": "",
                    "port": 18986
                },
                "slotId": 2,
                "sourceType": 1,
                "timing": {
                    "horizontal": {
                        "addrTime": 3840,
                        "frontPorch": 176,
                        "sync": 88,
                        "syncPolarity": 0,
                        "totalTime": 4400
                    },
                    "refreshRate": 60,
                    "templateId": 0,
                    "templateOperationType": 0,
                    "vertical": {
                        "addrTime": 2160,
                        "frontPorch": 8,
                        "sync": 10,
                        "syncPolarity": 0,
                        "totalTime": 2250
                    }
                }
            },
            {
                "audioInterface": {
                    "audioSrc": 1,
                    "linkStatus": 0,
                    "withAudioInterface": 0
                },
                "backup": {
                    "cropId": 0,
                    "enable": 0,
                    "inputId": 0,
                    "type": 0
                },
                "crops": [],
                "defaultName": "input 3-4-1",
                "general": {
                    "HDCPEncryted": 0,
                    "channelNum": 1,
                    "colorDepth": 0,
                    "colorGamut": 0,
                    "colorRange": 0,
                    "colorSpace": 0,
                    "connectCapacity": 0,
                    "cscMode": 0,
                    "defaultName": "input 3-4-1",
                    "dynamicRange": 0,
                    "name": "input 3-4-1",
                    "sampleRate": 0
                },
                "inputId": 10,
                "interfaceId": 2,
                "interfaceType": 27,
                "isSupportAudio": 0,
                "isUsed": 1,
                "macCompatibility": 0,
                "mismatchState": 0,
                "modelId": 31504,
                "mosaicMode": 0,
                "name": "input 3-4-1",
                "online": 1,
                "overLoadState": 0,
                "resolution": {
                    "height": 0,
                    "isInterlace": 0,
                    "refresh": 0,
                    "width": 0
                },
                "reverseControl": {
                    "ip": "",
                    "port": 18986
                },
                "slotId": 2,
                "sourceType": 1,
                "timing": {
                    "horizontal": {
                        "addrTime": 3840,
                        "frontPorch": 176,
                        "sync": 88,
                        "syncPolarity": 0,
                        "totalTime": 4400
                    },
                    "refreshRate": 60,
                    "templateId": 0,
                    "templateOperationType": 0,
                    "vertical": {
                        "addrTime": 2160,
                        "frontPorch": 8,
                        "sync": 10,
                        "syncPolarity": 0,
                        "totalTime": 2250
                    }
                }
            },
            {
                "audioInterface": {
                    "audioSrc": 1,
                    "linkStatus": 0,
                    "withAudioInterface": 0
                },
                "backup": {
                    "cropId": 0,
                    "enable": 0,
                    "inputId": 0,
                    "type": 0
                },
                "crops": [],
                "defaultName": "input 3-4-2",
                "general": {
                    "HDCPEncryted": 0,
                    "channelNum": 1,
                    "colorDepth": 0,
                    "colorGamut": 0,
                    "colorRange": 0,
                    "colorSpace": 0,
                    "connectCapacity": 0,
                    "cscMode": 0,
                    "defaultName": "input 3-4-2",
                    "dynamicRange": 0,
                    "name": "input 3-4-2",
                    "sampleRate": 0
                },
                "inputId": 11,
                "interfaceId": 3,
                "interfaceType": 27,
                "isSupportAudio": 0,
                "isUsed": 0,
                "macCompatibility": 0,
                "mismatchState": 0,
                "modelId": 31504,
                "mosaicMode": 0,
                "name": "input 3-4-2",
                "online": 1,
                "overLoadState": 0,
                "resolution": {
                    "height": 0,
                    "isInterlace": 0,
                    "refresh": 0,
                    "width": 0
                },
                "reverseControl": {
                    "ip": "",
                    "port": 18986
                },
                "slotId": 2,
                "sourceType": 1,
                "timing": {
                    "horizontal": {
                        "addrTime": 3840,
                        "frontPorch": 176,
                        "sync": 88,
                        "syncPolarity": 0,
                        "totalTime": 4400
                    },
                    "refreshRate": 60,
                    "templateId": 0,
                    "templateOperationType": 0,
                    "vertical": {
                        "addrTime": 2160,
                        "frontPorch": 8,
                        "sync": 10,
                        "syncPolarity": 0,
                        "totalTime": 2250
                    }
                }
            }
        ]
    },
    "msg": "Success",
    "sign": "",
    "status": 0
}
Modified at 2025-10-23 10:11:15
Previous
Rename Screens
Next
Read Detailed Information of Specified Inputs
Built with