PUXELHUE
English
  • 简体中文
  • English
  1. 5 图层
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. 5 图层

5.1 获取图层完整信息

GET
/v1/layers/list-detail

请求参数

Query 参数
limit
string 
可选
单page页最大条目数量
page
string 
查询第page页
可选
layerId
string 
可选
图层唯一Id, 如无该字段,则表示所有图层Id。
id
string 
可选
指定图层类型下的图层id,如无该字段,则忽略。
type
string 
可选
指定图层类型,如无该字段,则忽略。
attachScreenId
string 
可选
图层所附着屏幕的ID ,如无该字段,则忽略。
attachScreenType
string 
可选
图层所附着的屏幕类型 ,如无该字段,则忽略。
sceneType
string 
可选
图层所属类型, 如无该字段,则忽略。
Header 参数
Content-Type
string 
必需
示例值:
application/json
Body 参数application/json
object {0}
示例
{}

示例代码

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/layers/list-detail' \
--header 'Content-Type: application/json' \
--data-raw '{}'

返回响应

🟢200成功
application/json
Body
code
integer 
状态码
必需
错误码
message
string 
结果信息
必需
错误描述
data
object 
图层数据
必需
list
array [object {34}] 
必需
count
integer 
当前页数据条数
必需
page
integer 
当前页码
必需
totalCount
integer 
数据总条数
必需
totalPage
integer 
总页数
必需
示例
{
    "code": 0,
    "message": "string",
    "data": {
        "list": [
            {
                "layerId": 0,
                "layerIdObj": {
                    "id": 0,
                    "type": 0,
                    "sceneType": 0,
                    "attachScreenId": 0,
                    "attachScreenType": 0,
                    "screenGuid": "string"
                },
                "enable": 0,
                "selected": 0,
                "zorder": 0,
                "covered": 0,
                "isLock": 0,
                "opacity": 0,
                "threeD": {
                    "enable": 0
                },
                "aspectRatio": {
                    "aspectRatio": 0,
                    "locked": 0
                },
                "scale": {
                    "mode": 0
                },
                "general": {
                    "name": "string",
                    "isBackground": 0,
                    "isFreeze": 0,
                    "isMonochrome": 0,
                    "isInverse": 0,
                    "flipType": 0,
                    "capacity": 0,
                    "resource": 0,
                    "interfaces": [
                        {
                            "interfaceId": 0
                        }
                    ]
                },
                "source": {
                    "general": {
                        "sourceId": 0,
                        "sourceType": 0,
                        "connectorType": 0,
                        "sourceName": "string",
                        "connectCapacityNum": 0,
                        "relationId": 0
                    }
                },
                "window": {
                    "width": 0,
                    "height": 0,
                    "x": 0,
                    "y": 0
                },
                "mask": {
                    "enable": 0,
                    "left": 0,
                    "leftRatio": 0,
                    "right": 0,
                    "rightRatio": 0,
                    "top": 0,
                    "topRatio": 0,
                    "buttom": 0,
                    "buttomRatio": 0
                },
                "testColor": {
                    "enable": 0,
                    "R": 0,
                    "G": 0,
                    "B": 0
                },
                "imageQuality": {
                    "imageQualityMode": 0,
                    "eyeCare": 0,
                    "hue": 0,
                    "saturation": 0,
                    "gamma": 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
                        }
                    }
                },
                "shadow": {
                    "general": {
                        "enable": 0,
                        "feather": 0
                    },
                    "window": {
                        "width": 0,
                        "height": 0,
                        "x": 0,
                        "y": 0
                    },
                    "color": {
                        "R": 0,
                        "G": 0,
                        "B": 0,
                        "opacity": 0
                    }
                },
                "crop": {
                    "enable": 0,
                    "widthRatio": 0,
                    "heightRatio": 0,
                    "xRatio": 0,
                    "yRatio": 0
                },
                "cutout": {
                    "enable": 0,
                    "cursor": {
                        "enable": 0,
                        "pos": {
                            "x": 0,
                            "y": 0
                        },
                        "color": {
                            "R": 0,
                            "G": 0,
                            "B": 0
                        }
                    },
                    "type": 0,
                    "brightness": {
                        "threshold": 0,
                        "gain": 0,
                        "keyInverse": 0,
                        "foregroundColor": {
                            "enable": 0,
                            "R": 0,
                            "G": 0,
                            "B": 0
                        },
                        "keySource": {
                            "followInput": 0,
                            "sourceType": 0,
                            "sourceId": 0
                        }
                    },
                    "hue": {
                        "color": {
                            "R": 0,
                            "G": 0,
                            "B": 0
                        },
                        "hueClip": 0,
                        "hueRamp": 0,
                        "saturationClip": 0,
                        "saturationGain": 0,
                        "spill": 0,
                        "shadow": 0,
                        "highLigh": 0,
                        "edgeSmooth": 0
                    },
                    "intelligence": {
                        "color": {
                            "R": 0,
                            "G": 0,
                            "B": 0
                        },
                        "pos": {
                            "x": 0,
                            "y": 0
                        },
                        "mattingStrength": 0,
                        "gainAdjust": 0
                    }
                },
                "border": {
                    "enable": 0,
                    "type": 0,
                    "size": {
                        "hWidth": 0,
                        "vWidth": 0
                    },
                    "color": {
                        "R": 0,
                        "G": 0,
                        "B": 0,
                        "opacity": 0
                    }
                },
                "UMD": [
                    {
                        "enable": 0,
                        "area": 0,
                        "type": 0,
                        "name": "string",
                        "color": {
                            "foregroundColor": {
                                "R": 0,
                                "G": 0,
                                "B": 0,
                                "opacity": 0
                            },
                            "backgroundColor": {
                                "R": 0,
                                "G": 0,
                                "B": 0,
                                "opacity": 0
                            }
                        }
                    }
                ],
                "audio": {
                    "enable": 0,
                    "volume": 0,
                    "isMute": 0
                },
                "qualityEnhance": {
                    "enable": 0,
                    "mode": 0,
                    "level": 0
                },
                "cutFill": {
                    "enable": 0,
                    "curve": {
                        "start": {
                            "x": 0,
                            "y": 0
                        },
                        "end": {
                            "x": 0,
                            "y": 0
                        }
                    },
                    "relative": {
                        "x": 0,
                        "y": 0,
                        "width": 0,
                        "height": 0
                    }
                },
                "keyPosition": [
                    0
                ],
                "fillId": 0,
                "cutId": 0,
                "osdId": 0,
                "screenMode": 0,
                "serial": 0,
                "keyFrame": {
                    "enable": 0,
                    "speedType": 0,
                    "startTime": 0,
                    "animationTime": 0
                },
                "safeFrames": [
                    {
                        "aspectRatio": 0,
                        "id": 0
                    }
                ],
                "osd": {
                    "osdType": 0,
                    "preset": {
                        "isUsed": 0,
                        "id": 0
                    },
                    "osdInfo": {
                        "text": {
                            "components": [
                                {
                                    "background": {
                                        "color": {
                                            "Alpha": 0,
                                            "R": 0,
                                            "G": 0,
                                            "B": 0
                                        },
                                        "enable": 0
                                    },
                                    "font": {
                                        "color": {
                                            "Alpha": 0,
                                            "R": 0,
                                            "G": 0,
                                            "B": 0
                                        },
                                        "stroke": {
                                            "color": {
                                                "Alpha": 0,
                                                "R": 0,
                                                "G": 0,
                                                "B": 0
                                            },
                                            "enable": 0
                                        }
                                    },
                                    "language": 0,
                                    "componentId": "string",
                                    "componentType": 0,
                                    "fontId": "string",
                                    "fontSize": 0,
                                    "wordSpace": 0,
                                    "lineSpace": 0,
                                    "italic": 0,
                                    "bold": 0,
                                    "underline": 0,
                                    "verticalAlign": 0,
                                    "horizontalAlign": 0,
                                    "position": {
                                        "x": 0,
                                        "y": 0,
                                        "width": 0,
                                        "height": 0
                                    },
                                    "staticText": {
                                        "direction": 0,
                                        "word": "string"
                                    },
                                    "dynamicText": {
                                        "direction": 0,
                                        "speed": 0,
                                        "word": "string"
                                    },
                                    "date": {
                                        "timeZone": 0,
                                        "timeType": 0,
                                        "timeOffset": 0,
                                        "isMultiLine": 0,
                                        "componentSpace": 0,
                                        "yearFormat": 0,
                                        "dateFormat": 0,
                                        "isDisplayWeek": 0,
                                        "hourly": 0,
                                        "timeFormat": 0,
                                        "isDisplayAm": 0,
                                        "url": "string"
                                    },
                                    "weather": {
                                        "location": "string",
                                        "refreshTime": 0,
                                        "isMultiLine": 0,
                                        "componentSpace": 0,
                                        "temperatureUnit": 0,
                                        "weather": {
                                            "enable": 0,
                                            "label": "string",
                                            "value": "string"
                                        },
                                        "temp": {
                                            "enable": 0,
                                            "label": "string",
                                            "value": "string"
                                        },
                                        "tempNow": {
                                            "enable": 0,
                                            "label": "string",
                                            "value": "string"
                                        },
                                        "wind": {
                                            "enable": 0,
                                            "label": "string",
                                            "value": "string"
                                        },
                                        "humidity": {
                                            "enable": 0,
                                            "label": "string",
                                            "value": "string"
                                        }
                                    }
                                }
                            ]
                        },
                        "picture": {
                            "pictureId": 0,
                            "componentId": "string",
                            "opacity": 0,
                            "position": {
                                "x": 0,
                                "y": 0,
                                "width": 0,
                                "height": 0
                            }
                        }
                    }
                }
            }
        ],
        "count": 0,
        "page": 0,
        "totalCount": 0,
        "totalPage": 0
    }
}
修改于 2025-04-22 02:48:20
上一页
4.5 操作屏幕take
下一页
5.2 获取图层模板列表
Built with