PUXELHUE
English
  • 简体中文
  • English
  1. 4 屏幕
PUXELHUE
English
  • 简体中文
  • English
  • API使用说明
  • 1 鉴权
    • 1.1 用户登录
      POST
    • 1.2 读取节点公开信息
      GET
  • 2 设备
    • 2.1 读取节点信息
      GET
    • 2.2 执行系统恢复出厂
      PUT
    • 2.3 设置切换特效
      PUT
    • 2.4 设置swap
      PUT
    • 2.5 读取节点监测状态
      GET
  • 3 接口
    • 3.1 读取详细信息列表
      GET
    • 3.2 设置输出定位
      PUT
    • 3.3 设置画质
      PUT
  • 4 屏幕
    • 4.1 获取屏幕信息
      GET
    • 4.2 设置屏幕冻结
      PUT
    • 4.3 设置屏幕ftb
      PUT
    • 4.4 操作屏幕cut
      PUT
    • 4.5 操作屏幕take
      PUT
  • 5 图层
    • 5.1 获取图层完整信息
      GET
    • 5.2 获取图层模板列表
      GET
    • 5.4 设置图层换源信息
      PUT
    • 5.3 应用图层模板
      PUT
    • 5.5 设置图层选中信息
      PUT
  • 6. 场景
    • 6.1 获取场景详细信息列表
      GET
    • 6.2 场景创建
      POST
    • 6.3 单场景应用
      POST
    • 6.4 场景名称修改
      POST
    • 6.5 场景删除
      POST
  • 7 图库
    • 7.1 图片信息列表
  1. 4 屏幕

4.1 获取屏幕信息

GET
/v1/screen/list-detail

请求参数

Query 参数
limit
string 
单页数量
可选
page
string 
查询page页
可选
screenId
string 
可选
屏幕ID,如无该参数,表示不关注
presetId
string 
可选
场景id,配合sceneType使用,无此参数则不查询能查询到指定场景的屏幕数据
presetType
string 
可选
场景类型,无此参数则不查询场景中的屏幕信息。
screenType
string 
可选
屏幕类型,如无该参数,表示不关注

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://prod-cn.your-api-server.com/v1/screen/list-detail'

返回响应

🟢200成功
application/json
Body
code
integer 
响应码
必需
message
string 
响应消息内容
必需
data
object 
必需
list
array [object {68}] 
必需
count
integer 
当前页数据条数
必需
page
integer 
当前页码
必需
totalCount
integer 
数据总条数
必需
totalPage
integer 
总页数
必需
示例
{
    "code": 0,
    "message": "string",
    "data": {
        "list": [
            {
                "screenId": 0,
                "screenIdObj": {
                    "id": 0,
                    "type": 0
                },
                "general": {
                    "name": "string",
                    "area": {
                        "areaId": 0,
                        "areaName": "string"
                    }
                },
                "mosaic": {
                    "type": 0,
                    "splice": {
                        "row": 0,
                        "column": 0
                    },
                    "window": {
                        "x": 0,
                        "y": 0,
                        "width": 0,
                        "height": 0
                    },
                    "outputs": [
                        {
                            "interfaceId": 0,
                            "interfaceOnline": 0,
                            "name": "string",
                            "pos": {
                                "x": 0,
                                "y": 0,
                                "width": 0,
                                "height": 0
                            },
                            "crop": {
                                "x": 0,
                                "y": 0,
                                "width": 0,
                                "height": 0
                            },
                            "rotate": {
                                "enable": "string",
                                "angle": "string"
                            },
                            "": [
                                {
                                    "x": 0,
                                    "y": 0,
                                    "width": 0,
                                    "height": 0,
                                    "enable": 0,
                                    "index": 0
                                }
                            ],
                            "feather": [
                                {
                                    "enable": 0,
                                    "type": 0,
                                    "gamma": 0,
                                    "width": 0,
                                    "areaIndex": 0
                                }
                            ],
                            "area": [
                                {
                                    "x": 0,
                                    "y": 0,
                                    "width": 0,
                                    "height": 0,
                                    "enable": 0,
                                    "index": 0
                                }
                            ]
                        }
                    ],
                    "isShowRect": 0
                },
                "colorDepth": {
                    "preset": 0,
                    "actual": 0
                },
                "colorSpace": {
                    "preset": 0
                },
                "colorRange": {
                    "preset": 0
                },
                "colorGamut": {
                    "preset": 0
                },
                "dynamicRange": {
                    "preset": 0,
                    "actual": 0
                },
                "smpteMapping": {
                    "preset": 0
                },
                "timing": {
                    "interlaced": 0,
                    "refresh": 0,
                    "horizontal": {
                        "addTime": 0,
                        "frontPorch": 0,
                        "sync": 0,
                        "syncPolarity": 0,
                        "totalTime": 0
                    },
                    "vertical": {
                        "addTime": 0,
                        "frontPorch": 0,
                        "sync": 0,
                        "syncPolarity": 0,
                        "totalTime": 0
                    }
                },
                "thumbTiming": {
                    "interlaced": 0,
                    "frame": 0,
                    "width": 0,
                    "height": 0
                },
                "timingSelect": {
                    "select": 0
                },
                "backgroundColor": {
                    "R": 0,
                    "G": 0,
                    "B": 0
                },
                "layout": {
                    "x": 0,
                    "y": 0
                },
                "physicalSize": {
                    "dotPitch": 0,
                    "unit": 0,
                    "width": 0,
                    "height": 0,
                    "enable": 0
                },
                "pgmEdit": 0,
                "select": 0,
                "imageQuality": {
                    "imageQualityMode": 0,
                    "eyeCare": 0,
                    "hue": 0,
                    "saturation": 0,
                    "gamma": 0,
                    "gammaScale": 0,
                    "contrast": {
                        "R": 0,
                        "G": 0,
                        "B": 0,
                        "coefficient": 0
                    },
                    "brightness": {
                        "R": 0,
                        "G": 0,
                        "B": 0,
                        "coefficient": 0
                    },
                    "shadow": {
                        "R": 0,
                        "G": 0,
                        "B": 0,
                        "W": 0
                    },
                    "highLight": {
                        "R": 0,
                        "G": 0,
                        "B": 0,
                        "W": 0
                    },
                    "colorTemperature": {
                        "mode": 0,
                        "quickAdjust": {
                            "value": 0
                        },
                        "advanceAdjust": {
                            "R": 0,
                            "G": 0,
                            "B": 0
                        }
                    }
                },
                "freeze": 0,
                "ftb": {
                    "enable": 0,
                    "time": 0
                },
                "testPattern": {
                    "enable": 0,
                    "type": 0,
                    "bright": 0,
                    "grid": 0,
                    "gridType": 0,
                    "gridLineWidth": 0,
                    "speed": 0
                },
                "hdr": {
                    "sdr": {
                        "gamma": 0
                    },
                    "hdr10": {
                        "peakLuminance": 0,
                        "envLuminance": 0,
                        "pqMode": 0,
                        "toneMapping": 0,
                        "maxcll": {
                            "enable": true,
                            "presetMaxcll": 0
                        }
                    },
                    "hlg": {
                        "peakLuminance": 0,
                        "envLuminance": 0
                    }
                },
                "hdcp": {
                    "enable": 0,
                    "presetType": 0,
                    "actualType": 0
                },
                "genlock": {
                    "type": 0,
                    "frameRate": 0,
                    "frameRateScale": 0,
                    "frameRateMode": 0,
                    "phase": {
                        "enable": 0,
                        "offset": 0,
                        "phaseOffsetType": 0,
                        "angle": 0,
                        "angleScale": 0,
                        "percentage": 0,
                        "percentageScale": 0,
                        "lineCount": 0,
                        "pixel": 0
                    },
                    "sourceId": 0
                },
                "genlockStatus": {
                    "status": 0
                },
                "edge": {
                    "enable": 0,
                    "width": 0,
                    "height": 0
                },
                "threeD": {
                    "threeDEnable": 0,
                    "sourceFormat": 0,
                    "rightEyeOffset": 0,
                    "eyePriority": 0,
                    "thirdEmitterEnable": 0,
                    "emitterDelay": 0
                },
                "audio": {
                    "isMute": 0,
                    "volume": 0,
                    "source": [
                        {
                            "type": 0,
                            "id": 0
                        }
                    ]
                },
                "presetPoll": {
                    "enable": 0,
                    "presetGroupId": 0
                },
                "tbar": {
                    "percent": 0
                },
                "novs": {
                    "enable": 0,
                    "status": 0
                },
                "threeDLut": {
                    "fileName": "string",
                    "fileTitle": "string",
                    "enable": 0,
                    "intensity": 0
                },
                "curves": [
                    {
                        "point": {
                            "input": 0,
                            "output": 0
                        },
                        "type": 0,
                        "selectType": 0,
                        "enable": "string",
                        "index": "string"
                    }
                ],
                "colorReplace": {
                    "colorReplaceEnable": 0,
                    "skinProtectEnable": 0,
                    "srcColor": {
                        "r": 0,
                        "g": 0,
                        "b": 0
                    },
                    "dstColor": {
                        "r": 0,
                        "g": 0,
                        "b": 0
                    },
                    "tolerance": 0,
                    "softness": 0,
                    "shadow": 0
                },
                "colorCorrect": {
                    "enable": 0,
                    "colorCorrectParams": [
                        {
                            "colorCorrectType": 0,
                            "rgb": {
                                "r": 0,
                                "Scale": "string",
                                "g": 0,
                                "gScale": "string",
                                "b": 0,
                                "bScale": "string"
                            },
                            "hsv": {
                                "h": 0,
                                "hScale": "string",
                                "s": 0,
                                "sScale": "string",
                                "v": 0,
                                "vScale": "string"
                            }
                        }
                    ]
                },
                "dynamicBooster": {
                    "enable": 0,
                    "level": "string"
                },
                "magicGray": {
                    "xbitEnable": 0,
                    "preciseGrayscaleEnable": 0
                },
                "functionList": {
                    "isSupportPreciseGrayscale": 0,
                    "isSupport22BitPlus": 0,
                    "isSupportDynamicBooster": 0,
                    "isSupportGamut": 0
                },
                "cabinetOverwriteInfo": {
                    "overwrite": 0,
                    "moduleRow": 0,
                    "moduleCol": 0
                },
                "multiModeInfo": {
                    "currentModeId": 0,
                    "modeList": [
                        {
                            "modeId": 0,
                            "modeName": "string"
                        }
                    ]
                },
                "netportBackup": {
                    "backupType": 0,
                    "enableType": 0,
                    "netportIds": [
                        {
                            "masterNetportId": 0,
                            "backupNetportId": 0
                        }
                    ]
                },
                "screenBoundRect": {
                    "width": 0,
                    "height": 0
                },
                "adjustment": {
                    "brightness": {
                        "ratio": 0,
                        "ratioScale": 0
                    },
                    "gamma": {
                        "value": 0,
                        "scale": 0
                    },
                    "colorTemperature": 0
                },
                "syncLock": {
                    "interfaceID": "string",
                    "syncLockType": 0,
                    "frameRate": 0,
                    "syncLockStatus": 0,
                    "phaseOffset": {
                        "phaseOffsetType": 0,
                        "angle": 0,
                        "percentage": 0,
                        "lineCount": 0,
                        "pixel": 0
                    }
                },
                "frameMultiplication": {
                    "frameMultiplicationEnable": 0,
                    "frameMultiplicationQuantity": 0,
                    "outputFrames": [
                        {
                            "frameIndex": 0,
                            "frameType": 0,
                            "offset": {
                                "x": 0,
                                "y": 0
                            },
                            "color": {
                                "R": 0,
                                "G": 0,
                                "B": 0
                            }
                        }
                    ]
                },
                "additionalFrameLatencyValue": 0,
                "layerLayout": 0,
                "screenWorkMode": 0,
                "lowDelayEnable": 0,
                "lockState": 0,
                "interfaceLocation": 0,
                "enable": 0,
                "keyPosition": [
                    0
                ],
                "state": 0,
                "order": 0,
                "template": {
                    "id": 0,
                    "moduleType": 0,
                    "type": 0
                },
                "customGamut": {
                    "name": "string",
                    "colorGamutInfo": {
                        "rLxy": {
                            "gamutType": 0,
                            "lum": 0,
                            "x": 0,
                            "y": 0
                        },
                        "gLxy": {
                            "gamutType": 0,
                            "lum": 0,
                            "x": 0,
                            "y": 0
                        },
                        "bLxy": {
                            "gamutType": 0,
                            "lum": 0,
                            "x": 0,
                            "y": 0
                        },
                        "wLxy": {
                            "gamutType": 0,
                            "lum": 0,
                            "x": 0,
                            "y": 0
                        },
                        "colorTemperature": 0,
                        "scale": 0
                    }
                },
                "originGamut": {
                    "rLxy": {
                        "gamutType": 0,
                        "lum": 0,
                        "x": 0,
                        "y": 0
                    },
                    "gLxy": {
                        "gamutType": 0,
                        "lum": 0,
                        "x": 0,
                        "y": 0
                    },
                    "bLxy": {
                        "gamutType": 0,
                        "lum": 0,
                        "x": 0,
                        "y": 0
                    },
                    "wLxy": {
                        "gamutType": 0,
                        "lum": 0,
                        "x": 0,
                        "y": 0
                    },
                    "colorTemperature": 0,
                    "scale": 0
                },
                "selectGamut": {
                    "presetGamut": 0,
                    "actualGamut": 0,
                    "colorTemperature": 0
                },
                "eotf": {
                    "shadowCompensation": 0,
                    "shadowCompensationCoefficient": 0,
                    "ambientLightCompensation": 0,
                    "clipLevel": 0
                },
                "groupOrder": 0,
                "group": {
                    "id": "string",
                    "order": 0,
                    "name": "string",
                    "updateTime": 0
                },
                "edgeFusion": {
                    "enable": 0,
                    "mode": "string"
                },
                "edgeFusionFlag": {
                    "enable": 0,
                    "color": {
                        "R": 0,
                        "G": 0,
                        "B": 0
                    }
                },
                "guid": "string",
                "combinationType": 0,
                "superScreenGUID": "string"
            }
        ],
        "count": 0,
        "page": 0,
        "totalCount": 0,
        "totalPage": 0
    }
}
修改于 2025-04-22 02:49:33
上一页
3.3 设置画质
下一页
4.2 设置屏幕冻结
Built with