编辑窗口布局

开发中

POST

http://test-cn.your-api-server.com/layout/editLayout

请求参数

Body 参数application/json

videoLayout

array[object (VideoWindow) {15}]

可选

name

string

窗口名字

必需

sourceType

string

必需

播放的类型(video/hdmi/ndi/livestream/push)

player

string

必需

使用的播放器名字（视频窗口必须选择一个）

url

string

直播链接地址

可选

coordinates

string

必需

窗口坐标（x,y,w,h），以逗号分隔

translucent

boolean

是否半透明

可选

xMirror

boolean

是否水平否镜像

可选

yMirror

string

是否垂直否镜像

必需

angle

integer

窗口旋转角度

可选

borderSize

integer

边框大小

可选

borderColor

string

边框颜色

可选

crop2k

string

可选

素材裁剪区域, 四个或三个点组成([[0,0],[1920,0],[1920,1080],[0,1080]])

crop4k

string

可选

素材裁剪区域, 四个或三个点组成([[0,0],[3840,0],[3840,2160],[0,2160]])

is5D

string

是否是5D窗口

可选

radius

integer

圆角半径

可选

textLayout

array[object (TextWindow) {21}]

可选

name

string

窗口名字

必需

text

string

必需

文本内容（不超过1400字）

coordinates

string

必需

窗口坐标（x,y,w,h），以逗号分隔

textOrientation

string

必需

横向/纵向 (hor/vert)

font

string

必需

字体(Arial/宋体/黑体/楷体/微软雅黑)

fontSize

integer

字号

必需

fontColor

string

字体颜色

必需

letterSpacing

integer

必需

文字间距，默认5(-100,100)

bold

boolean

粗体

必需

italic

boolean

斜体

必需

underline

boolean

下划线

必需

horAlign

string

必需

水平对齐方式（左对齐，居中，右对齐） left/center/right

vertAlign

string

必需

垂直对齐方式（上对齐，居中，下对齐） top/center/bottom

bgColor

string

必需

背景颜色 (默认透明#FFFFFFFF)

scrollDirection

string

必需

滚东方向，不滚动时传空字符串,（水平时：向左，向右，垂直时:向下，向上 (tl/tr/tb/tt))

scrollSpeed

integer

必需

滚动速度（0-20）

borderSize

integer

窗口边框大小

可选

borderColor

string

窗口边框颜色

可选

duration

integer

必需

显示时间,单位毫秒，默认0一直显示

scrollCount

integer

必需

滚动次数,默认0一直滚动

translucent

boolean

半透明

可选

示例

{
    "videoLayout": [
        {
            "name": "string",
            "sourceType": "string",
            "player": "string",
            "url": "string",
            "coordinates": "string",
            "translucent": true,
            "xMirror": true,
            "yMirror": "string",
            "angle": 0,
            "borderSize": 0,
            "borderColor": "string",
            "crop2k": "string",
            "crop4k": "string",
            "is5D": "string",
            "radius": 0
        }
    ],
    "textLayout": [
        {
            "name": "string",
            "text": "string",
            "coordinates": "string",
            "textOrientation": "string",
            "font": "string",
            "fontSize": 0,
            "fontColor": "string",
            "letterSpacing": 0,
            "bold": true,
            "italic": true,
            "underline": true,
            "horAlign": "string",
            "vertAlign": "string",
            "bgColor": "string",
            "scrollDirection": "string",
            "scrollSpeed": 0,
            "borderSize": 0,
            "borderColor": "string",
            "duration": 0,
            "scrollCount": 0,
            "translucent": true
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://test-cn.your-api-server.com/layout/editLayout' \
--header 'Content-Type: application/json' \
--data-raw '{
    "videoLayout": [
        {
            "name": "string",
            "sourceType": "string",
            "player": "string",
            "url": "string",
            "coordinates": "string",
            "translucent": true,
            "xMirror": true,
            "yMirror": "string",
            "angle": 0,
            "borderSize": 0,
            "borderColor": "string",
            "crop2k": "string",
            "crop4k": "string",
            "is5D": "string",
            "radius": 0
        }
    ],
    "textLayout": [
        {
            "name": "string",
            "text": "string",
            "coordinates": "string",
            "textOrientation": "string",
            "font": "string",
            "fontSize": 0,
            "fontColor": "string",
            "letterSpacing": 0,
            "bold": true,
            "italic": true,
            "underline": true,
            "horAlign": "string",
            "vertAlign": "string",
            "bgColor": "string",
            "scrollDirection": "string",
            "scrollSpeed": 0,
            "borderSize": 0,
            "borderColor": "string",
            "duration": 0,
            "scrollCount": 0,
            "translucent": true
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

data

string

返回值

必需

errorMessage

string

可选

errorCode

integer

200

必需

isSuccess

boolean

true

必需

示例

{
    "data": "string",
    "errorMessage": "string",
    "errorCode": 0,
    "isSuccess": true
}

🟠400请求有误

保存窗口布局

设置跑屏窗口