H Series OpenAPI Instructions
Home
ChineseVersion
Home
ChineseVersion
  1. Outputs
  • 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
      POST
    • Display Screen ID
      POST
    • Set Screen Brightness
      POST
    • Save Screen Brightness
      POST
    • Add Screens
      POST
    • Delete Screens
      POST
    • Read Screen Detailed Information
      POST
    • Query Screen List
      POST
    • Screen FTB
      POST
    • Set BKG
      POST
    • Set Freezing
      POST
    • Read Screen Not in Live Mode
      POST
    • Set 3D Effect
      POST
    • Set Screen Layout Information
      POST
    • Set Image OSD
      POST
    • Set Text OSD
      POST
    • Delete Multiple Screens
      POST
    • Rename Screens
      POST
  • Inputs
    • Read Input List
    • Read Detailed Information of Specified Inputs
    • Set Cropping
    • Delete
    • Edit Cropping
    • Set Resolutions
    • Set Timing
    • Create Input Groups
    • Sort Input Groups
    • Edit Groups
    • Delete Groups
    • Delete Input Sources by Groups
    • Import EDID
    • Rename
    • Create Signal Source Playlists
    • Read Signal Source Playlists
    • Edit Signal Source Playlist Information
    • Enable Signal Source Playlists
    • Delete Signal Source Playlists
  • Outputs
    • Set Image Quality
      POST
    • Set Gamma
      POST
    • Set Output Locating
      POST
    • Rename
      POST
    • Set Timing for 4K Output Card
      POST
    • Read Detailed Information
      POST
    • Read Output List
      POST
    • Se Output Timing
      POST
    • Set Output Resolutions
      POST
    • Set Areas Loaded by All-in-One Cards
      POST
  • 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. Outputs

Read Detailed Information

POST
/open/api/output/readDetail

Request

Body Params application/json

Example
{
    "body": {
        "deviceId": 0,
        "outputId": 16
    },
    "sign": "MDBmZjQ1NzgxMGFjNGNhZTQ2N2U3ZTc4ODk0YTBiN2M=",
    "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/output/readDetail' \
--header 'Content-Type: application/json' \
--data-raw '{
    "body": {
        "deviceId": 0,
        "outputId": 16
    },
    "sign": "MDBmZjQ1NzgxMGFjNGNhZTQ2N2U3ZTc4ODk0YTBiN2M=",
    "pId": "1",
    "timeStamp": "1631949094265"
}'

Responses

🟢200Successful
application/json
Body

Example
{
    "body": {
        "cardMode": 2,
        "connectCapacity": 2,
        "deviceId": 0,
        "gamma": {
            "gamma": 1
        },
        "general": {
            "colorDepth": 0,
            "colorSpace": 0,
            "name": "output 12-1",
            "sampleRate": 0
        },
        "imageQuality": {
            "brightness": {
                "B": 50,
                "G": 50,
                "R": 50,
                "all": 50
            },
            "colorTemperature": 6500,
            "contrast": {
                "B": 50,
                "G": 50,
                "R": 50,
                "all": 50
            },
            "hue": 0,
            "saturation": 50
        },
        "interfaceId": 0,
        "interfaceType": 17,
        "modelId": 31562,
        "outputId": 4,
        "resolution": {
            "direction": 0,
            "height": 2160,
            "isInterlace": 0,
            "outputCount": 4,
            "refresh": 60,
            "width": 7680
        },
        "slotId": 11,
        "testPattern": {
            "bright": 2,
            "grid": 3,
            "speed": 2,
            "testPattern": 65535
        },
        "timing": {
            "horizontal": {
                "addrTime": 1920,
                "frontPorch": 88,
                "sync": 44,
                "syncPolarity": 0,
                "totalTime": 2200
            },
            "isInterlace": 0,
            "refreshRate": 60,
            "vertical": {
                "addrTime": 2160,
                "frontPorch": 20,
                "sync": 10,
                "syncPolarity": 1,
                "totalTime": 2250
            }
        }
    },
    "msg": "",
    "sign": "",
    "status": 0
}
Modified at 2025-10-23 10:16:41
Previous
Set Timing for 4K Output Card
Next
Read Output List
Built with