- Contents
- API Instructions
- Error Code
- General
- Input
- Screen
- Image booster
- Layer
- Processing
- Canvas
- Preset
- Schedule
- Output
- Image Booster
- Retrieve Screen Properties InformationGET
- Retrieve the Number of Cabinets of the ScreenGET
- Retrieve Screen InformationGET
- Device
- Cabinet
Retrieve Screen Information
GET
/api/v1/screen
All
TIP
Request
Query Params
isNeedCabinetInfo
string
optional
Example:
0: Yes, 1: No. Default: 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 GET 'http://127.0.0.1:8001/api/v1/screen'
Responses
🟢200Successful
application/json
Body
code
number
Error code
data
object
Return Data
screens
array [object {14}]
Screen information
screenGroups
array [object {3}]
Screen group information
message
string
required
Example
{
"code": 0,
"data": {
"screens": [
{
"screenID": "string",
"screenName": "string",
"createTime": "string",
"workingMode": 0,
"lowLatency": true,
"layoutMode": 0,
"screenIndex": 0,
"screenGroupID": "string",
"ordinal": 0,
"position": {
"x": 0,
"y": 0
},
"canvases": [
{
"canvasID": 0,
"outputCardId": 0,
"canvasSerialNum": 0,
"ordinal": 0,
"size": {
"width": 0,
"height": 0
},
"isCustomSize": true,
"position": {
"x": 0,
"y": 0
},
"rectSize": {
"width": 0,
"height": 0
},
"cabinets": [
{
"cabinetID": 0,
"connectID": 0,
"outputID": 0,
"position": {
"x": 0,
"y": 0
},
"size": {
"width": 0,
"height": 0
},
"angle": 0,
"lockStatus": true
}
],
"groups": [
{
"groupID": "string",
"groupName": "string",
"groupColor": {
"r": 0,
"g": 0,
"b": 0
},
"cabinetIDs": [
0
],
"angle": 0
}
],
"maxFrameRate": 0,
"layoutLines": [
"string"
],
"zorder": 0,
"frequencyPhaseStatus": 0
}
],
"layersInWorkingMode": [
{
"workingMode": 0,
"layerLayoutMode": 0,
"layers": [
{
"id": 0,
"layerIndex": 0,
"source": 0,
"position": {
"x": 0,
"y": 0
},
"zOrder": 0,
"lock": true,
"border": {
"enable": true,
"width": 0,
"color": {
"r": 0,
"g": 0,
"b": 0
}
},
"cut": {
"enable": true,
"rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
}
},
"scaler": {
"width": 0,
"height": 0
},
"followState": true,
"layerInCanvasId": 0
}
]
}
],
"masterFrameRate": 0,
"pixToPixMode": 0
}
],
"screenGroups": [
{
"screenGroupID": "string",
"name": "string",
"ordinal": 0
}
]
},
"message": "string"
}
Modified at 2024-07-09 11:01:54