Read Back Mapping as JSON
# Read Back Mapping as JSON
Path:
/api/rcv_layout.json
Method: GET
Content-type: application/json; charset=utf-8
API Description: This can be used to read back the mapping as JSON.
Request Body
Name | Type | Example | Description |
---|---|---|---|
portIndex | int | 0 | Port number. |
Response
Name | Type | Example | Description |
---|---|---|---|
errorCode | int | yes | Error code. |
rcvCount | int | yes | Receiving card count. |
rcvRegions | List | yes | Receiving card parameter array. |
rcvRegion
Name | Type | Example | Description |
---|---|---|---|
portIndex | int | 0 | Port number, starting from 0. |
rcvIndex | int | 0 | Required by the receiving card, starting from 0. |
x | int | 0 | X-coordinate. |
y | int | 0 | Y-coordinate. |
width | int | 100 | Width. |
height | int | 100 | Height. |
Response Example
{
"rcvCount": 2,
"rcvRegions": [{
"portIndex": 0,
"rcvIndex": 0,
"x": 0,
"y": 0,
"width": 220,
"height": 248
}, {
"errorCode": -1,
"portIndex": 0,
"rcvIndex": 1,
"x": 220,
"y": 0,
"width": 220,
"height": 248
}]
}