6.3 单场景应用

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

presetId

string

场景guid

可选

serial

integer

场景坑位

可选

targetRegion

integer

要应用的区域

必需

2: PGM, 4: PVW, 0:Auto(切换器为 PVW，拼接器、控制器为 PGM)

auxiliary

object

辅助信息

必需

keyFrame

object

必需

加载场景时候携带的kf信息

effect

object

场景播放特效开关

必需

switchEffect

object

全局切换特效设置

必需

swapEnable

number

必需

Swap配置【0：swap未启用，1：swap启用；】

screens

array [object {1}]

可选

场景指定加载的目标屏幕列表

示例

{
    "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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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"
            }
        ]
    }
}'

application/json

Body

code

number

响应码

必需

message

string

响应消息内容

必需

data

object

必需

示例

{
    "code": 0,
    "message": "string",
    "data": {}
}

6.3 单场景应用

请求参数

示例代码

返回响应