# Get Input Video Signal Information
This API endpoint retrieves the input video signal information from a specified device.
# Request Path
{CLTPlatform-ip}:8086/processor/getInputVideoInfo
- Replace
{CLTPlatform-ip}with the corresponding IP address. - The request port is
8086.
# Protocol
HTTP
# Method
POST
# Request Parameters
- Set the
Content-Typeof the request body toapplication/json.
| Parameter Name | Description | Required | Type | Data Dictionary | Restriction | Example |
|---|---|---|---|---|---|---|
| command | Command type | Yes | string | - | - | processor/getInputVideoInfo |
| data | Data | Yes | object | - | - | - |
| data >> index | Sender index (starts from 0; -1 for broadcast) | Yes | int | - | - | - |
# Request Example
{
"command": "processor/getInputVideoInfo",
"data": {
"index": 0
}
}
# Response
| Parameter Name | Description | Required | Type | Data Dictionary | Restriction | Example |
|---|---|---|---|---|---|---|
| command | Command type | Yes | string | - | - | processor/getInputVideoInfo |
| code | Status code | Yes | int | - | - | - |
| message | Message | Yes | string | - | - | - |
| data | Data | Yes | object | - | - | - |
| data >> videoInfoList | List of input video signals | Yes | array | - | - | - |
| data >> videoInfoList >> bConnected | Whether the signal is connected | Yes | boolean | - | - | true |
| data >> videoInfoList >> videoMark | Signal identifier | Yes | object | - | - | - |
| data >> videoInfoList >> videoMark >> slotNum | Expansion slot number | Yes | int | - | - | - |
| data >> videoInfoList >> videoMark >> sourceType | Signal type | Yes | string | - | - | HDMI2.0 |
| data >> videoInfoList >> videoMark >> sourceIndex | Signal index (starts from 0 on the same board) | Yes | int | - | - | - |
| data >> videoInfoList >> videoMark >> sourceId | Signal ID (signal sequence on the same board) | Yes | int | - | - | - |
| data >> videoInfoList >> videoFormat | Video format | Yes | object | - | - | - |
| data >> videoInfoList >> videoFormat >> width | Width | Yes | int | - | - | 1920 |
| data >> videoInfoList >> videoFormat >> height | Height | Yes | int | - | - | 1080 |
| data >> videoInfoList >> videoFormat >> freq | Frame rate | Yes | int | - | - | 60 |
| data >> videoInfoList >> videoFormat >> colorDepth | Color depth | Yes | string | - | - | 8bit |
| data >> videoInfoList >> videoFormat >> colorType | Color format | Yes | string | - | - | RGB |
| data >> videoInfoList >> videoFormat >> bHDR | Whether HDR | Yes | boolean | - | - | - |
# Response Example
DETAILS
{
"code": 20000,
"command": "processor/getInputVideoInfo",
"data": {
"videoInfoList": [{
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "RGB",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 16,
"sourceId": 0,
"sourceIndex": 0,
"sourceType": "SDI"
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "RGB",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 16,
"sourceId": 1,
"sourceIndex": 1,
"sourceType": "SDI"
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "RGB",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 16,
"sourceId": 2,
"sourceIndex": 2,
"sourceType": "SDI"
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "RGB",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 16,
"sourceId": 3,
"sourceIndex": 3,
"sourceType": "SDI"
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "RGB",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 18,
"sourceId": 0,
"sourceIndex": 0,
"sourceType": "HDMI"
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "RGB",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 18,
"sourceId": 1,
"sourceIndex": 1,
"sourceType": "HDMI"
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "RGB",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 18,
"sourceId": 2,
"sourceIndex": 2,
"sourceType": "HDMI"
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "RGB",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 18,
"sourceId": 3,
"sourceIndex": 3,
"sourceType": "HDMI"
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "YCbCr422",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 21,
"sourceId": 0,
"sourceIndex": 0,
"sourceType": "SDI"
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "RGB",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 24,
"sourceId": 0,
"sourceIndex": 0,
"sourceType": ""
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "RGB",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 24,
"sourceId": 1,
"sourceIndex": 1,
"sourceType": ""
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "RGB",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 24,
"sourceId": 2,
"sourceIndex": 0,
"sourceType": ""
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "RGB",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 24,
"sourceId": 3,
"sourceIndex": 1,
"sourceType": ""
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "RGB",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 26,
"sourceId": 0,
"sourceIndex": 0,
"sourceType": "SDI"
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "RGB",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 26,
"sourceId": 1,
"sourceIndex": 1,
"sourceType": "SDI"
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "RGB",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 26,
"sourceId": 2,
"sourceIndex": 2,
"sourceType": "SDI"
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "RGB",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 26,
"sourceId": 3,
"sourceIndex": 3,
"sourceType": "SDI"
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "RGB",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 27,
"sourceId": 0,
"sourceIndex": 0,
"sourceType": "DP"
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "RGB",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 29,
"sourceId": 0,
"sourceIndex": 0,
"sourceType": "DP"
}
}, {
"bConnected": false,
"videoFormat": {
"bHDR": false,
"colorDepth": "8bit",
"colorType": "YCbCr422",
"freq": 0.0,
"height": 0,
"width": 0
},
"videoMark": {
"slotNum": 30,
"sourceId": 0,
"sourceIndex": 0,
"sourceType": "SDI"
}
}]
},
"message": "Common_Success"
}