PIXELHUE
us English
  • us English
  • 简体中文
  1. 6.2 v2
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
        GET
      • 6.2.2 Create Preset
        POST
      • 6.2.3 Load Preset
        POST
      • 6.2.4 Rename Preset
        POST
      • 6.2.5 Delete Preset
        POST
  • 7 Gallery
    • 7.1 Retrieve Image Details
  • 数据模型
    • Schemas
    • Root
  1. 6.2 v2

6.2.3 Load Preset

POST
/v1/preset/apply

请求参数

Header 参数

Body 参数application/json

示例
{
    "presetId": "string",
    "serial": 0,
    "targetRegion": 0,
    "auxiliary": {
        "keyFrame": {
            "enable": 0
        },
        "effect": {
            "enable": 0
        },
        "switchEffect": {
            "time": 0,
            "type": 0,
            "wipe": {
                "image": 0,
                "symmetry": 0,
                "posX": 0,
                "posY": 0,
                "frameW": 0,
                "frameS": 0,
                "direction": 0,
                "source": {
                    "general": {
                        "sourceId": 0,
                        "sourceType": 0
                    }
                }
            },
            "dve": {
                "type": 0,
                "image": 0,
                "brightness": 0,
                "softness": 0,
                "directionDev": 0,
                "directionEffect": "string",
                "keySource": {
                    "general": {
                        "sourceId": 0,
                        "sourceType": 0
                    }
                },
                "KeySourceReverse": 0,
                "source": {
                    "general": {
                        "sourceId": 0,
                        "sourceType": 0
                    }
                }
            },
            "stinger": {
                "playStartTime": 0,
                "mixtureTime": 0,
                "mixtureStartTime": 0,
                "matting": 0,
                "brightness": 0,
                "softness": 0,
                "source": {
                    "general": {
                        "sourceId": 0,
                        "sourceType": 0
                    }
                }
            },
            "dip": {
                "source": {
                    "general": {
                        "sourceId": 0,
                        "sourceType": 0
                    }
                }
            }
        },
        "swapEnable": 0,
        "screens": [
            {
                "guid": "string"
            }
        ]
    }
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://prod-cn.your-api-server.com/v1/preset/apply' \
--header 'Content-Type: application/json' \
--data-raw '{
    "presetId": "string",
    "serial": 0,
    "targetRegion": 0,
    "auxiliary": {
        "keyFrame": {
            "enable": 0
        },
        "effect": {
            "enable": 0
        },
        "switchEffect": {
            "time": 0,
            "type": 0,
            "wipe": {
                "image": 0,
                "symmetry": 0,
                "posX": 0,
                "posY": 0,
                "frameW": 0,
                "frameS": 0,
                "direction": 0,
                "source": {
                    "general": {
                        "sourceId": 0,
                        "sourceType": 0
                    }
                }
            },
            "dve": {
                "type": 0,
                "image": 0,
                "brightness": 0,
                "softness": 0,
                "directionDev": 0,
                "directionEffect": "string",
                "keySource": {
                    "general": {
                        "sourceId": 0,
                        "sourceType": 0
                    }
                },
                "KeySourceReverse": 0,
                "source": {
                    "general": {
                        "sourceId": 0,
                        "sourceType": 0
                    }
                }
            },
            "stinger": {
                "playStartTime": 0,
                "mixtureTime": 0,
                "mixtureStartTime": 0,
                "matting": 0,
                "brightness": 0,
                "softness": 0,
                "source": {
                    "general": {
                        "sourceId": 0,
                        "sourceType": 0
                    }
                }
            },
            "dip": {
                "source": {
                    "general": {
                        "sourceId": 0,
                        "sourceType": 0
                    }
                }
            }
        },
        "swapEnable": 0,
        "screens": [
            {
                "guid": "string"
            }
        ]
    }
}'

返回响应

🟢200OK
application/json
Body

示例
{
    "code": 0,
    "message": "string",
    "data": {}
}
修改于 2025-11-03 02:12:07
上一页
6.2.2 Create Preset
下一页
6.2.4 Rename Preset
Built with