PIXELHUE
us English
  • us English
  • 简体中文
  1. 5 Layer
PIXELHUE
us English
  • us English
  • 简体中文
  • API User Guide
  • 1 Authentication
    • 1.1 User Login
      POST
    • 1.2 Read Node Public Information
      GET
  • 2 Device
    • 2.1 Read Node Information
      GET
    • 2.2 Factory Reset
      PUT
    • 2.3 Set Transition Effect
      PUT
    • 2.4 Set Swap
      PUT
    • 2.5 Read Node Monitoring Status
      GET
  • 3 Connector
    • 3.1 Read Connector Details
      GET
    • 3.2 Set Output Mapping
      PUT
    • 3.3 Set Image Quality
      PUT
  • 4 Screen
    • 4.1 v1
      • 4.1.1 FTB
      • 4.1.2 Freeze
      • 4.1.3 Take
      • 4.1.4 Cut
    • 4.2 v2
      • 4.2.1 Retrieve Screen Information
      • 4.2.2 Freeze
      • 4.2.3 FTB
      • 4.2.4 Cut
      • 4.2.5 Take
  • 5 Layer
    • 5.1 Retrieve Layer Information
      GET
    • 5.2 Retrieve Layer Templates
      GET
    • 5.3 Apply Layer Templates
      PUT
    • 5.4 Set Layer Source
      PUT
    • 5.5 Select Layer
      PUT
  • 6. Preset
    • 6.1 v1
      • 6.1.1 Edit Preset
      • 6.1.2 Save Preset
      • 6.1.3 Load Preset
    • 6.2 v2
      • 6.2.1 Retrieve Preset Details
      • 6.2.2 Create Preset
      • 6.2.3 Load Preset
      • 6.2.4 Rename Preset
      • 6.2.5 Delete Preset
  • 7 Gallery
    • 7.1 Retrieve Image Details
      GET
  • 数据模型
    • Schemas
    • Root
  1. 5 Layer

5.1 Retrieve Layer Information

GET
/v1/layers/list-detail

请求参数

Query 参数

Header 参数

Body 参数application/json

示例
{}

请求示例代码

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?limit=&page=&layerId=&id=&type=&attachScreenId=&attachScreenType=&sceneType=' \
--header 'Content-Type: application/json' \
--data-raw '{}'

返回响应

🟢200OK
application/json
Body

示例
{
    "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
                    },
                    "primary": {
                        "sourceId": 0,
                        "sourceType": 0
                    },
                    "actual": {
                        "sourceId": 0,
                        "sourceType": 0,
                        "connectorType": 0,
                        "sourceName": "string",
                        "connectCapacityNum": 0,
                        "relationId": 0
                    }
                },
                "transitionFollow": {
                    "enable": 0
                },
                "window": {
                    "width": 0,
                    "height": 0,
                    "x": 0,
                    "y": 0
                },
                "virtualWindow": {
                    "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
                        },
                        "pos": {
                            "x": 0,
                            "y": 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,
                                    "horizontalAlign": 0,
                                    "verticalAlign": 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,
                                        "isDisplayDate": 0,
                                        "isDisplayTime": 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-11-03 02:11:49
上一页
4.2.5 Take
下一页
5.2 Retrieve Layer Templates
Built with