6.2 场景创建 - PUXELHUE

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

serial

integer

场景坑位序号

必需

name

string

场景名称

必需

64字节内（汉字占用2字节）

loadType

integer

场景加载方式

必需

1：绝对 2：相对

type

integer

场景类型

必需

1：全局场景 2：单屏场景 3：多屏场景 4:屏幕场景（屏幕模板）

sourceRegion

integer

场景来源

必需

源自PVW或PGM（2: PGM, 4: PVW）

switchEffect

object

全局切换特效设置

必需

time

number

必需

特效持续时间(单位:ms)

type

number

特效切换方式

必需

0:CUT(直切) 1:FADE（黑屏过度）2:dip(浸入) 3:wipe(划像) 4:Stinger 5:dve

wipe

object

划像

可选

dve

object

dve

可选

stinger

object

stinger

可选

dip

object

浸入

可选

createDefault

integer

是否创建默认预设数据(中控、液晶使用)

可选

0:否 1:是

params

array[string]

场景参数功能枚举

必需

screens

array[object (场景下屏幕参数) {2}]

场景下屏幕数据

必需

guid

string

屏幕ID

必需

layers

array[object (场景下图层参数) {2}]

场景下图层参数

必需

interfaces

array[integer]

接口id

可选

示例

{
    "serial": 0,
    "name": "string",
    "loadType": 0,
    "type": 0,
    "sourceRegion": 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
                }
            }
        }
    },
    "createDefault": 0,
    "params": [
        "string"
    ],
    "screens": [
        {
            "guid": "string",
            "layers": [
                {
                    "serial": 0,
                    "type": 0
                }
            ]
        }
    ],
    "interfaces": [
        0
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://prod-cn.your-api-server.com/v1/preset/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "serial": 0,
    "name": "string",
    "loadType": 0,
    "type": 0,
    "sourceRegion": 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
                }
            }
        }
    },
    "createDefault": 0,
    "params": [
        "string"
    ],
    "screens": [
        {
            "guid": "string",
            "layers": [
                {
                    "serial": 0,
                    "type": 0
                }
            ]
        }
    ],
    "interfaces": [
        0
    ]
}'

返回响应

🟢200成功

application/json

Body

code

number

响应码

可选

message

string

响应消息内容

可选

data

object

可选

guid

string

场景ID

必需

serial

integer

场景坑位序号

必需

name

string

场景名称

必需

64字节内（汉字占用2字节）

loadType

integer

场景加载方式

必需

1：绝对 2：相对

type

integer

场景类型

必需

1：全局场景 2：单屏场景 3：多屏场景

sourceRegion

integer

场景来源

必需

源自PVW或PGM（2: PGM, 4: PVW）

effectType

integer

场景播放特效

必需

0:直切 1：淡入淡出

params

array[string]

场景参数功能枚举

必需

screens

array[object (场景下屏幕参数) {2}]

场景下屏幕数据

必需

interfaces

array[integer]

接口id

可选

示例

{
    "code": 0,
    "message": "string",
    "data": {
        "guid": "string",
        "serial": 0,
        "name": "string",
        "loadType": 0,
        "type": 0,
        "sourceRegion": 0,
        "effectType": 0,
        "params": [
            "string"
        ],
        "screens": [
            {
                "guid": "string",
                "layers": [
                    {
                        "serial": 0,
                        "type": 0
                    }
                ]
            }
        ],
        "interfaces": [
            0
        ]
    }
}