PUXELHUE
简体中文
  • 简体中文
  • English
  1. 3 接口
PUXELHUE
简体中文
  • 简体中文
  • 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.3 应用图层模板
      PUT
    • 5.4 设置图层换源信息
      PUT
    • 5.5 设置图层选中信息
      PUT
  • 6. 场景
    • v1
    • v2
      • 6.1 获取场景详细信息列表
      • 6.2 场景创建
      • 6.3 单场景应用
      • 6.4 场景名称修改
      • 6.5 场景删除
  • 7 图库
    • 7.1 图片信息列表
  1. 3 接口

3.1 读取详细信息列表

GET
/v1/interface/list-detail
1.splitId  !=0 时,该interfaceId标识的主源的分割源的唯一ID
2.query的可选参数,无任何参数则返回所有数据,多个参数传入,则必须满足&的关系

请求参数

Query 参数

请求示例代码

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/interface/list-detail'

返回响应

🟢200成功
application/json
Body

示例
{
    "code": 0,
    "message": "string",
    "data": {
        "list": [
            {
                "interfaceId": 2,
                "state": 0,
                "interfaceIdObj": {
                    "nodeId": 0,
                    "slotId": 0,
                    "connectorId": 0,
                    "splitId": 0
                },
                "auxiliaryInfo": {
                    "online": 0,
                    "connectorInfo": {
                        "interfaceType": 0,
                        "type": 0,
                        "workMode": 0,
                        "copyInfo": {
                            "type": 0,
                            "id": 0
                        },
                        "capacity": 0
                    },
                    "screenInfo": {
                        "name": "string"
                    },
                    "group": {
                        "id": 0,
                        "name": "string",
                        "physicalGroupId": 0
                    },
                    "alias": "string"
                },
                "general": {
                    "name": "string"
                },
                "presetThumbTiming": {
                    "interlaced": 0,
                    "frame": 0,
                    "width": 0,
                    "height": 0,
                    "standardType": 0
                },
                "actualThumbTiming": {
                    "interlaced": 0,
                    "frame": 0,
                    "width": 0,
                    "height": 0,
                    "standardType": 0
                },
                "presetTiming": {
                    "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
                    },
                    "standardType": 0
                },
                "actualTiming": {
                    "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
                    },
                    "standardType": "string"
                },
                "timingSelect": {
                    "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
                        }
                    },
                    "isMonochrome": 0,
                    "isInverse": 0
                },
                "crop": {
                    "enable": 0,
                    "widthRatio": 0,
                    "heightRatio": 0,
                    "xRatio": 0,
                    "yRatio": 0
                },
                "hdcp": {
                    "enable": 0,
                    "preset": 0,
                    "actual": 0
                },
                "colorSpace": {
                    "actual": 0,
                    "preset": 0
                },
                "colorDepth": {
                    "actual": 8,
                    "preset": 8
                },
                "colorRange": {
                    "actual": 0,
                    "preset": 0
                },
                "colorGamut": {
                    "actual": 0,
                    "preset": 0
                },
                "colorDynamicRange": {
                    "actual": 0,
                    "preset": 0
                },
                "testPattern": {
                    "enable": 0,
                    "type": 0,
                    "bright": 0,
                    "grid": 0,
                    "gridType": 0,
                    "gridLineWidth": 0,
                    "speed": 0
                },
                "smpteMapping": {
                    "actual": 0,
                    "preset": 0
                },
                "removeInterlace": {
                    "enable": 0
                },
                "cutout": {
                    "enable": 0,
                    "cursor": {
                        "enable": 0,
                        "pos": {
                            "x": 0,
                            "y": 0
                        },
                        "color": {
                            "R": 0,
                            "G": 0,
                            "B": 0
                        }
                    },
                    "type": 0,
                    "brightness": {
                        "threshold": 1,
                        "gain": 1,
                        "foregroundColor": {
                            "enable": 0,
                            "R": 0,
                            "G": 0,
                            "B": 0
                        }
                    },
                    "hue": {
                        "color": {
                            "R": 0,
                            "G": 0,
                            "B": 0
                        },
                        "pos": {
                            "x": 0,
                            "y": 0
                        },
                        "hueClip": 6,
                        "hueRamp": 6,
                        "saturationClip": 6,
                        "saturationGain": 6,
                        "spill": 6,
                        "shadow": 6,
                        "highLigh": 6,
                        "edgeSmooth": 0
                    },
                    "intelligence": {
                        "color": {
                            "R": "string",
                            "G": "string",
                            "B": "string"
                        },
                        "pos": {
                            "x": 0,
                            "y": 0
                        },
                        "mattingStrength": 0,
                        "gainAdjust": 0
                    }
                },
                "hdr": {
                    "sdr": {
                        "gamma": 2
                    },
                    "hdr10": {
                        "peakLuminance": 1,
                        "envLuminance": 1,
                        "pqMode": 0,
                        "toneMapping": 0,
                        "maxcll": {
                            "enable": 0,
                            "presetMaxcll": 1
                        }
                    },
                    "hlg": {
                        "peakLuminance": 1,
                        "envLuminance": 1
                    }
                },
                "keyPosition": [
                    0
                ],
                "metadata": [
                    {
                        "type": 0,
                        "para": 0
                    }
                ],
                "ledHdr": {
                    "dynamicRange": 0,
                    "pqMode": 0,
                    "maxcllOverWrite": 0,
                    "maxCll": 0
                },
                "streamInfo": {
                    "destIp": "string",
                    "port": 0,
                    "srcIp": "string",
                    "colorSpace": 0,
                    "colorDepth": 0
                },
                "netInfo": {
                    "dhcp": 0,
                    "ip": "string",
                    "netmask": "string",
                    "gateway": "string",
                    "mac": "string"
                },
                "fileInfo": {
                    "fileName": "string",
                    "edidFileName": "string"
                },
                "reverseControl": {
                    "ip": "string",
                    "port": 0,
                    "enable": 0
                },
                "compatibilityMode": 0,
                "audio": {
                    "isAudioSource": 0,
                    "audioType": 0,
                    "sampling": 0,
                    "presetChannelNum": 0,
                    "actualChannelNum": 0,
                    "sourceId": 0,
                    "channelInfo": [
                        {
                            "channelId": 0,
                            "channelIndex": 0,
                            "channelType": 0,
                            "channelLabel": "string",
                            "connectLabel": "string",
                            "isMute": 0,
                            "testAudioEnable": 0,
                            "state": 0,
                            "isValid": 0
                        }
                    ]
                },
                "display": {
                    "sourceType": 0,
                    "sourceName": "string",
                    "sourceId": 0
                },
                "relation": {
                    "type": 0,
                    "enable": 0,
                    "destinationId": 0,
                    "property": [
                        0
                    ]
                },
                "hpd": 0,
                "threeD": {
                    "actualSource": {
                        "sourceFormat": 0
                    },
                    "presetSource": {
                        "sourceFormat": 0,
                        "eyePriority": 0,
                        "threeDEnable": 0,
                        "rightEyeOffset": 0,
                        "thirdEmitterEnable": 0,
                        "emitterDelay": "string"
                    }
                },
                "linkInfo": {
                    "isLink": 0,
                    "shared": 0,
                    "sourceInfo": {
                        "identify": "string",
                        "sourceId": 0,
                        "sourceType": 0
                    }
                }
            },
            {
                "interfaceId": 2,
                "state": 0,
                "interfaceIdObj": {
                    "nodeId": 0,
                    "slotId": 0,
                    "connectorId": 0,
                    "splitId": 0
                },
                "auxiliaryInfo": {
                    "online": 0,
                    "connectorInfo": {
                        "interfaceType": 0,
                        "type": 0,
                        "workMode": 0,
                        "copyInfo": {
                            "type": 0,
                            "id": 0
                        },
                        "capacity": 0
                    },
                    "screenInfo": {
                        "name": "string"
                    },
                    "group": {
                        "id": 0,
                        "name": "string",
                        "physicalGroupId": 0
                    },
                    "alias": "string"
                },
                "general": {
                    "name": "string"
                },
                "presetThumbTiming": {
                    "interlaced": 0,
                    "frame": 0,
                    "width": 0,
                    "height": 0,
                    "standardType": 0
                },
                "actualThumbTiming": {
                    "interlaced": 0,
                    "frame": 0,
                    "width": 0,
                    "height": 0,
                    "standardType": 0
                },
                "presetTiming": {
                    "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
                    },
                    "standardType": 0
                },
                "actualTiming": {
                    "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
                    },
                    "standardType": "string"
                },
                "timingSelect": {
                    "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
                        }
                    },
                    "isMonochrome": 0,
                    "isInverse": 0
                },
                "crop": {
                    "enable": 0,
                    "widthRatio": 0,
                    "heightRatio": 0,
                    "xRatio": 0,
                    "yRatio": 0
                },
                "hdcp": {
                    "enable": 0,
                    "preset": 0,
                    "actual": 0
                },
                "colorSpace": {
                    "actual": 0,
                    "preset": 0
                },
                "colorDepth": {
                    "actual": 8,
                    "preset": 8
                },
                "colorRange": {
                    "actual": 0,
                    "preset": 0
                },
                "colorGamut": {
                    "actual": 0,
                    "preset": 0
                },
                "colorDynamicRange": {
                    "actual": 0,
                    "preset": 0
                },
                "testPattern": {
                    "enable": 0,
                    "type": 0,
                    "bright": 0,
                    "grid": 0,
                    "gridType": 0,
                    "gridLineWidth": 0,
                    "speed": 0
                },
                "smpteMapping": {
                    "actual": 0,
                    "preset": 0
                },
                "removeInterlace": {
                    "enable": 0
                },
                "cutout": {
                    "enable": 0,
                    "cursor": {
                        "enable": 0,
                        "pos": {
                            "x": 0,
                            "y": 0
                        },
                        "color": {
                            "R": 0,
                            "G": 0,
                            "B": 0
                        }
                    },
                    "type": 0,
                    "brightness": {
                        "threshold": 1,
                        "gain": 1,
                        "foregroundColor": {
                            "enable": 0,
                            "R": 0,
                            "G": 0,
                            "B": 0
                        }
                    },
                    "hue": {
                        "color": {
                            "R": 0,
                            "G": 0,
                            "B": 0
                        },
                        "pos": {
                            "x": 0,
                            "y": 0
                        },
                        "hueClip": 6,
                        "hueRamp": 6,
                        "saturationClip": 6,
                        "saturationGain": 6,
                        "spill": 6,
                        "shadow": 6,
                        "highLigh": 6,
                        "edgeSmooth": 0
                    },
                    "intelligence": {
                        "color": {
                            "R": "string",
                            "G": "string",
                            "B": "string"
                        },
                        "pos": {
                            "x": 0,
                            "y": 0
                        },
                        "mattingStrength": 0,
                        "gainAdjust": 0
                    }
                },
                "hdr": {
                    "sdr": {
                        "gamma": 2
                    },
                    "hdr10": {
                        "peakLuminance": 1,
                        "envLuminance": 1,
                        "pqMode": 0,
                        "toneMapping": 0,
                        "maxcll": {
                            "enable": 0,
                            "presetMaxcll": 1
                        }
                    },
                    "hlg": {
                        "peakLuminance": 1,
                        "envLuminance": 1
                    }
                },
                "keyPosition": [
                    0
                ],
                "metadata": [
                    {
                        "type": 0,
                        "para": 0
                    }
                ],
                "ledHdr": {
                    "dynamicRange": 0,
                    "pqMode": 0,
                    "maxcllOverWrite": 0,
                    "maxCll": 0
                },
                "streamInfo": {
                    "destIp": "string",
                    "port": 0,
                    "srcIp": "string",
                    "colorSpace": 0,
                    "colorDepth": 0
                },
                "netInfo": {
                    "dhcp": 0,
                    "ip": "string",
                    "netmask": "string",
                    "gateway": "string",
                    "mac": "string"
                },
                "fileInfo": {
                    "fileName": "string",
                    "edidFileName": "string"
                },
                "reverseControl": {
                    "ip": "string",
                    "port": 0,
                    "enable": 0
                },
                "compatibilityMode": 0,
                "audio": {
                    "isAudioSource": 0,
                    "audioType": 0,
                    "sampling": 0,
                    "presetChannelNum": 0,
                    "actualChannelNum": 0,
                    "sourceId": 0,
                    "channelInfo": [
                        {
                            "channelId": 0,
                            "channelIndex": 0,
                            "channelType": 0,
                            "channelLabel": "string",
                            "connectLabel": "string",
                            "isMute": 0,
                            "testAudioEnable": 0,
                            "state": 0,
                            "isValid": 0
                        }
                    ]
                },
                "display": {
                    "sourceType": 0,
                    "sourceName": "string",
                    "sourceId": 0
                },
                "relation": {
                    "type": 0,
                    "enable": 0,
                    "destinationId": 0,
                    "property": [
                        0
                    ]
                },
                "hpd": 0,
                "threeD": {
                    "actualSource": {
                        "sourceFormat": 0
                    },
                    "presetSource": {
                        "sourceFormat": 0,
                        "eyePriority": 0,
                        "threeDEnable": 0,
                        "rightEyeOffset": 0,
                        "thirdEmitterEnable": 0,
                        "emitterDelay": "string"
                    }
                },
                "linkInfo": {
                    "isLink": 0,
                    "shared": 0,
                    "sourceInfo": {
                        "identify": "string",
                        "sourceId": 0,
                        "sourceType": 0
                    }
                }
            }
        ],
        "count": 0,
        "page": 0,
        "totalCount": 0,
        "totalPage": 0
    }
}
修改于 2025-07-30 01:59:20
上一页
2.5 读取节点监测状态
下一页
3.2 设置输出定位
Built with