1. Screen
影院
English
  • 简体中文
  • English
  • V1.3.0
    • Common APIs
      • Adjust cabinet color temperature
      • Set Screen Brightness
      • Switch Source for Layer
      • Enable Cabinet Mapping
      • Set Screen Gamma
    • Cinema
      • Electronic Mask
        • Get Electronic Shutter On/Off Status
        • Set Electronic Shutter On/Off Status
      • 3D Information
        • Get 3D Information
        • Activate 3D Information
        • Activate 3D Information - Name
      • Color Calibration
        • Get Color Calibration Information
        • Activate Color Calibration Information
      • Image
        • Get Image Information
        • Update Image Information
        • Create Image Information
        • Activate Image Information
      • Input
        • Activate Input Information
        • Get Input Information
      • Preset
        • Activate Preset Information
        • Get Preset Information
      • Test Pattern
        • Turn on/Turn off Test Pattern
        • Get Current Test Pattern
        • Get Custom Test Pattern
        • Delete Custom Test Pattern
      • Internal Clock
        • Get Sync Clock Information
      • Source Mode
        • Get Source Mode
        • Set Source Mode
      • Display Power
        • Set Display Power On/Off Status
        • Get Display Power On/Off Status
    • Factory Reset
      • Delete User Data
    • Controller Program Upgrade
      • Web Program Upload
      • Web Program Upgrade
      • Program Upgrade
    • Built-in Source
      • Set Cinema Test Pattern
    • Color Temperature Adjustment
      • Set Color Temperature for Multiple Cabinets
    • Cabinet
      • Module
        • Get Module Flash Information
        • Read Back Module Flash
        • Burn Module Flash
      • Get All Cabinet Basic Information
    • Monitoring
      • Monitoring Exception Handling
      • Get Monitor History
    • Device
      • Set Blackout/freeze Screen
    • Output
      • Get Display Status
    • Input
      • Get Input Information
        • Get Input Source List
    • Screen
      • Image Quality
        • Set Screen Color Temperature
      • Canvas
        • Set Canvas Mapping
      • Get Screen Information
        GET
    • Diagnostic Notification
      • Get Diagnostic Notification Information
    • Security
      • Get Security Code Information
      • Verify Security Code
      • Get Security Status Flag
      • Manual Clear
    • Preset (COEX)
      • Get Preset Information
      • Apply Preset
  • V1.2.1
    • Software
      • Get Current Software Version
    • Monitoring
      • Get Real-time Monitoring Data
      • Get Active Error, Warning, and Notification Info
      • Get PIN Code
      • Verify PIN Code
      • Clear Error Warnings
  • 数据模型
    • Pet
    • Category
    • Tag
  1. Screen

Get Screen Information

GET
/api/v1/screen
提示
Retrieve all basic information of screens (screen ID, screen name, etc.), cabinet information, canvas information, layer information, etc.

请求参数

Query 参数

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location '/api/v1/screen?isNeedCabinetInfo=0%3A%20Yes%2C%201%3A%20No.%20Default%3A%200'

返回响应

🟢200Success
application/json
Bodyapplication/json

示例
{
    "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,
                                "IrregularFlag": "string"
                            }
                        ],
                        "groups": [
                            {
                                "groupID": "string",
                                "groupName": "string",
                                "groupColor": {
                                    "r": 0,
                                    "g": 0,
                                    "b": 0
                                },
                                "cabinetIDs": [
                                    0
                                ],
                                "angle": 0
                            }
                        ],
                        "maxFrameRate": 0,
                        "layoutLines": [
                            "string"
                        ],
                        "zorder": 0,
                        "frequencyPhaseStatus": 0,
                        "topoStartPosition": {
                            "x": 0,
                            "y": 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"
}
修改于 2026-08-03 02:30:21
上一页
Set Canvas Mapping
下一页
Get Diagnostic Notification Information
Built with