新增大屏

功能介绍

新增一个大屏，大屏的内容来自模板。

URI

● URI格式

POST /v1/{project_id}/screens

● 参数说明

表5-1 URI 参数说明

参数 是否

必选

参数类型 描述

project_i

d 是 String 项目编号，获取方法请参见获取项目ID。

请求消息

参数说明：如表5-2所示。

表5-2 请求参数

参数 是否必

选

参数类 型

描述

name 是 String 大屏名称，由数字、字母和中文组成，长度为1~32 个字符。

API 参考 5 API

参数 是否必 选

参数类 型

描述

alias 否 String 大屏别名，缺省值为空，长度为1~255个字符。

description 否 String 大屏的描述信息，缺省值为空，长度为0~512个字 符。

templateId 是 String 大屏的模板ID，获取方法请参见查询模板列表。

workspace

Id 是 String 工作空间ID，长度为32个字符，获取方法请参见获 取workspaceId。

响应消息

参数说明：如表5-3所示。

表5-3 响应参数

参数 参数类型 描述

id String 大屏ID

name String 大屏名称 alias String 大屏别名 description String 大屏的描述信息

status Integer 大屏状态：0-created，1- deleted，2-shared projectId String 项目编号，即project_id

createUser String 大屏的创建者 createDate Integer 大屏的创建时间戳 updateUser String 大屏的更新者 updateDate Integer 大屏的更新时间戳 templateId String 大屏创建时使用的模板ID snapshotId String 大屏快照的ID

share String 大屏分享的UUID标识 thumbnail String 大屏缩略图的访问地址 config config object 大屏的配置内容

API 参考 5 API

表5-4 config 数据结构

参数 参数类型 描述

scenes Array of scene

objects 场景信息 config Array of

config objects 配置详情

表5-5 scene

参数 参数类型 描述

name String 场景名称 layers Array of layer

objects 分层

表5-6 layer

参数 参数类型 描述

id String 分层的ID

name String 分层的名称

coms Array 组件列表

表5-7 config

参数 参数类型 描述

id String 大屏配置唯一标识

screenId String 大屏ID

grid Integer 栅格间距，单位为像素 backgroundI

mage String 背景图片OBS链接 background

Color String 背景颜色

width Integer 屏幕宽度，单位为像素 height Integer 屏幕高度，单位为像素

whLinkage Integer 大屏宽度和高度联动配置状态；0：关闭；1：开启 comList String 组件列表

API 参考 5 API

参数 参数类型 描述 screenshot String 封面图 display Integer 缩放方式：

● 1：按宽度等比缩放铺满

● 2：按高度等比缩放铺满

● 3：等比缩放自适应

● 4：全屏拉铺满 watermarkF

lag Integer 是否有水印 rulerLines rulerLines

object 坐标 variables variables

object 交互信息 workspaceId String 工作空间ID。

表5-8 rulerLines

参数 参数类型 描述

h String 水平标尺线坐标，单位为像素

v String 垂直标尺线坐标，单位为像素

show Boolean 是否显示，true：显示，false：不显示

表5-9 variables

参数 参数类型 描述

publishersVi

ew String 发送组件交互参数列表

subscribersV

iew String 接收组件交互参数列表

示例

创建一个名称为screen_01的大屏，使用的模板ID为32546212564。

● 请求示例

POST https://{dlv_endpoint}/v1/{project_id}/screens {请求消息头}

{ "name":"screen_01",

API 参考 5 API

"alias":"test_screen_01", "description":"for test", "templateId":"32546212564",

"workspaceId":"86ce107974ce4f93b618acb232863027"

}

● 成功响应示例

{ "id": "ff80808167813a360167819d5b640045", "name": "screen_01",

"alias": "test_screen_01", "description": "for test", "status": 0,

"projectId": "abcdefghijk0123456", "createUser": "a1b2c2d3e4f5g6h5j6k6", "createDate": 1544067832676, "updateUser": null,

"updateDate": null,

"templateId": "2a8281f9678bb29f01678bb9b2d60001", "snapshotId": null,

"share": null,

"screenId": "ff80808167813a360167819d5b640045", "grid": null,