Skip to content

通用拼接器控制系统_接口文档_V01

1.1 用户登录

URL 地址:/v1/user/login

请求方式:POST

功能描述:用户登录

参数:

键名类型参数说明备注
usernamestring登录名
passwordstring密码

返回值:

键名类型参数说明备注
datastring返回token编码
messagestring返回消息正确错误都返回
statusnumber返回状态码0:正确

1.2 用户登出

URL 地址:/v1/user/logout

请求方式:GET

功能描述:用户登出

参数:

键名类型参数说明备注
tokenstringtoken编码

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误都返回
statusnumber返回状态码0:正确

1.3 修改密码

URL地址:/v1/user/password/update

请求方式:POST

功能描述:修改密码

参数:

键名类型参数说明备注
tokenstringtoken编码
new_passwordstring新密码
old_passwordstring旧密码
usernamestring用户名

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.1 拼接器基础信息

URL地址:/v1/splicer/info

请求方式:GET

功能描述:返回拼接器信息,包括IP地址、端口、支持功能等

参数:

键名类型参数说明备注
tokenstringtoken编码

返回值:

键名类型参数说明备注
dataobject
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

data:

键名类型参数说明备注
brandobject 品牌
echo_modenumber回显模式0无回显,1模式1,2-模式2
has_wallsboolean是否有屏幕墙列表是否支持获取屏幕墙列表
ipstringIP设备IP
portnumber端口设备端口
scene_deleteboolean是否能删场景
scene_newboolean是否能新建场景
scene_switchboolean是否能切换场景
signal_groupboolean信号源是否有分组
switch_wallboolean是否能切换屏幕墙
versionstring版本
walls_settingboolean是否能进行屏幕墙设置
window_closeboolean是否能删除窗口
window_openboolean是否能新建窗口
window_signal_changeboolean是否能切换窗口的信号
window_size_changeboolean是能改变窗口的大小

2.2 获取拼接器模式1回显画面

URL地址:/v1/splicer/echoscreen/mode1

请求方式:GET

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码

返回值:

键名类型参数说明备注
dataobject
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

data:

键名类型参数说明备注
listobject
picstring回显画面拼接图Base64,需加前缀,如:`data:image/png; base64,${pic}`
typenumber切图方式4:通过接口坐标切图

list:

键名类型参数说明备注
columnnumber
linenumber
pos_infoarray信号源对应回显画面的坐标

pos_info[0]:

键名类型参数说明备注
channelnumber信号源ID
modenumber模式
posarray信号源对应回显画面的坐标每个窗口对应信号源
pos_exarray

pos[0]:

键名类型参数说明备注

pos_ex[0]:

键名类型参数说明备注
x0number左上角x坐标
x1number右下角x坐标
y0number左上角y坐标
y1number右下角y坐标

2.3 获取拼接器模式2回显画面

URL地址:/v1/splicer/echoscreen/mode2

请求方式:GET

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码
signal_idnumber屏幕墙ID

返回值:

【回显画面图的实际片地址】


2.4 获取逻辑槽位模板

URL地址:/v1/splicer/logicslot/template

请求方式:GET

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码
wall_idnumber屏幕墙ID

返回值:

键名类型参数说明备注
dataobject
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

data:

键名类型参数说明备注
idstring槽位模版ID
posarray返回消息

pos[0]

键名类型参数说明备注
x0number左上角x坐标
x1number右下角x坐标
y0number左上角y坐标
y1number右下角y坐标

2.4 更新逻辑槽位模板

URL地址:/v1/splicer/logicslot/template

请求方式:PUT

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码
wall_idnumber屏幕墙ID
enable_logic_slotboolean虚拟槽位开启
logic_slot_infoarray槽位列表

logic_slot_info[0]:

键名类型参数说明备注
x0number左上角x坐标
x1number右下角x坐标
y0number左上角y坐标
y1number右下角y坐标

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.5 保存逻辑槽位模板

URL地址:/v1/splicer/logicslot/template

请求方式:POST

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码
posarray虚拟槽位列表

pos[0]

键名类型参数说明备注
x0number左上角x坐标
x1number右下角x坐标
y0number左上角y坐标
y1number右下角y坐标

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.6 删除逻辑槽位模板

URL地址:/v1/splicer/logicslot/template

请求方式:POST

功能描述:

参数:


键名类型参数说明备注
tokenstringtoken编码
wall_idnumber屏幕墙ID
logic_template_idstring模版ID

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.7 获取逻辑端口物理端口映射关系

URL地址:/v1/splicer/portmap

请求方式:GET

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码

返回值:

键名类型参数说明备注
dataobject
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

data:

键名类型参数说明备注
outputarray
port_maparray

port_map[0]:

键名类型参数说明备注
portarray端口
wall_idnumber屏幕墙ID

port[0]:

键名类型参数说明备注
logic_portnumber逻辑端口
phy_portnumber物理端口

2.8 绑定端口

URL地址:/v1/splicer/portmap

请求方式:POST

功能描述:

参数:

键名类型参数说明备注
tokenstring
portarray绑定端口列表
wall_idnumber"wall_id": 0

Port[0]:

键名类型参数说明备注
logic_portnumber逻辑端口
phy_portnumber物理端口

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.9 清除逻辑端口物理端口映射关系

URL地址:/v1/splicer/portmap

请求方式:DELETE

功能描述:

参数:

键名类型参数说明备注
tokenstring

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.10 与硬件同步

URL地址:/v1/splicer/refresh/all

请求方式:GET

功能描述:

参数:

键名类型参数说明备注
tokenstring

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.11 删除场景

URL地址:/v1/splicer/scene

请求方式:DELETE

功能描述:删除某一屏幕墙下的场景

参数:

键名类型参数说明备注
tokenstring
wall_idnumber屏幕墙ID
scene_idnumber场景ID

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.12 场景列表

URL地址:/v1/splicer/scene/list

请求方式:GET

功能描述:获取某一屏幕墙下的所有场景

参数:

键名类型参数说明备注
tokenstringtoken编码
wall_idnumber屏幕墙ID

返回值:

键名类型参数说明备注
dataobject
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

data:

键名类型参数说明备注
active_scene_idnumber当前活动的场景
scenesarray场景列表

scenes[0]:

键名类型参数说明备注
enablenumber
enable_logic_slotboolean是否开启虚拟槽位
idnumber场景ID
indexnumber场景序列
logic_slot_infoarray虚拟槽位列表
main_voice_modenumber音频模式
namestring场景名称
windowsarray场景里的窗口列表 windows数组(场景下窗口列表)可能为空

logic_slot_info[0]:

键名类型参数说明备注
x0number左上角x坐标
x1number右下角x坐标
y0number左上角y坐标
y1number右下角y坐标

windows[0]:

键名类型参数说明备注
enableboolean是否可用(是否显示)
idnumber窗口ID
is_muteboolean是否静音
source_idnumber窗口绑定的信号源ID
volumenumber音量
win_blend_coefnumber
win_levelnumber窗口排列时的层级
x0number左上角x坐标
x1number右下角x坐标
y0number左上角y坐标
y1number右下角y坐标

2.13 新建场景

URL地址:/v1/splicer/scene/new

请求方式:POST

功能描述:在屏幕墙下新建场景

参数:

键名类型参数说明备注
tokenstringtoken编码
new_namestring新场景名称
wall_idnumber屏幕墙ID

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.14 场景重命名

URL地址:/v1/splicer/scene/rename

请求方式:POST

功能描述:场景的重命名

参数:

键名类型参数说明备注
tokenstringtoken编码
wall_idnumber屏幕墙ID
scene_idnumber场景ID
new_namestring场景新名称

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.15 保存场景

URL地址:/v1/splicer/scene/save

请求方式:GET

功能描述:场景变化后保存场景

参数:

键名类型参数说明备注
tokenstringtoken编码
wall_idnumber
scene_idnumber

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.16 场景排序

URL地址:/v1/splicer/scene/sort

请求方式:POST

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码
wall_idnumber屏幕墙ID
scene_sort_infoarray场景排序信息

scene_sort_info[0]:

键名类型参数说明备注
scene_idnumber场景ID
sortindexnumber场景排序序列

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.17 场景切换

URL地址:/v1/splicer/scene/switch

请求方式:GET

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码
wall_idnumber
scene_idnumber

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.18 设置窗口音频

URL地址:/v1/splicer/scene/window/audio

请求方式:PUT

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码
wall_idnumber屏幕墙ID
scene_idnumber场景ID
window_infoobject窗口信息

window_info:

键名类型参数说明备注
enableboolean是否可用(是否显示)
idnumber窗口ID
is_muteboolean是否静音
source_idnumber窗口关联的信号源ID
volumenumber音量
win_blend_coefnumber
win_levelnumber窗口排列时的层级
x0number左上角x坐标
x1number右下角x坐标
y0number左上角y坐标
y1number右下角y坐标

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.19 关闭窗口

URL地址:/v1/splicer/scene/window/close

请求方式:GET

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码
wall_idnumber屏幕墙ID
scene_idnumber场景ID
win_idnumber窗口ID

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.20 改变窗口层级

URL地址:/v1/splicer/scene/window/level

请求方式:GET

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码
wall_idnumber屏幕墙ID
scene_idnumber场景ID
win_idnumber窗口ID
sourcenumber信号源ID
levelnumber窗口层级-1置顶,0置底,1-n层级,n越大越上层

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.21 获取屏幕墙下场景窗口列表

URL地址:/v1/splicer/scene/window/list

请求方式:GET

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码
wall_idnumber屏幕墙ID
scene_idnumber场景ID
win_idnumber窗口ID

返回值:

键名类型参数说明备注
dataobject
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

data:

键名类型参数说明备注
enableboolean窗口是否显示
idnumber窗口ID
is_muteboolean窗口是否静音
source_idnumber信号源ID
volumenumber音量
win_blend_coefnumber
win_levelnumber窗口层级
x0number左上角x坐标
x1number右下角x坐标
y0number左上角y坐标
y1number右下角y坐标

2.22 窗口移动

URL地址:/v1/splicer/scene/window/move

请求方式:GET

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码
wall_idnumber屏幕墙ID
scene_idnumber场景ID
win_idnumber窗口ID
sourcenumber信号源ID
x0number左上角x坐标
x1number右下角x坐标
y0number左上角y坐标
y1number右下角y坐标

返回值:

键名类型参数说明备注
data string
message string返回消息正确错误时都返回
status number返回状态码0:正确

2.23 新建窗口

URL地址:/v1/splicer/scene/window/open

请求方式:GET

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码
wall_idnumber屏幕墙ID
scene_idnumber场景ID
win_idnumber窗口ID
sourcenumber信号源ID
x0number左上角x坐标
x1number右下角x坐标
y0number左上角y坐标
y1number右下角y坐标

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.24 切换窗口信号源

URL地址:/v1/splicer/scene/window/source

请求方式:GET

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码
wall_idnumber屏幕墙ID
scene_idnumber场景ID
win_idnumber窗口ID
sourcenumber信号源ID
x0number左上角x坐标
x1number右下角x坐标
y0number左上角y坐标
y1number右下角y坐标

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.25 信号列表

URL地址:/v1/splicer/signal/list

请求方式:GET

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码

返回值:

键名类型参数说明备注
dataobject
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

data:

键名类型参数说明备注
signalsarray信号源列表

signals[0]:

键名类型参数说明备注
HZnumber刷新率
channelnumber
connect_channelnumber
enableboolean是否可见
extstring
heightnumber
idstring信号源ID
ipstringIP
namestring信号源名称
typenumber
widthnumber

2.26 信号源重命名

URL地址:/v1/splicer/signal/rename

请求方式:POST

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码
new_namestring新的信号源名称
sourceobject信号源

source:

键名类型参数说明备注
HZnumber刷新率
channelnumber
connect_channelnumber
enableboolean是否可见
extstring
heightnumber
idstring信号源ID
ipstringIP
namestring信号源名称
typenumber
widthnumber

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.27 编辑屏幕墙

URL地址:/v1/splicer/wall

请求方式:POST

功能描述:

参数:

键名类型参数说明备注
tokenstring token编码
comb_columnnumber垂直数量
comb_linenumber水平数量
heightnumber高度
widthnumber宽度
enableboolean是否可用
led_modenumberled模式
modenumber模式
namestring名称
hznumber刷新率
screen_infoobjectled设置
vmode_hnumnumber虚拟槽 水平分割
vmode_vnumnumber虚拟槽 垂直分割
wall_idstring屏幕墙ID
sub_columnnumber
sub_linenumber
dis_hsizenumber分辨率的宽
dis_vsizenumber分辨率的高

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.28 删除屏幕墙

URL地址:/v1/splicer/wall

请求方式:DELETE

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码
comb_columnnumber垂直数量
comb_linenumber水平数量
heightnumber高度
widthnumber宽度
enableboolean是否可用
led_modenumberled模式
modenumber模式
namestring名称
hznumber刷新率
screen_infoobjectled设置
vmode_hnumnumber虚拟槽 水平分割
vmode_vnumnumber虚拟槽 垂直分割
wall_idnumber屏幕墙ID
sub_columnnumber
sub_linenumber
dis_hsizenumber分辨率的宽
dis_vsizenumber分辨率的高

返回值:

键名类型参数说明备注
datastring
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

2.29 屏幕墙列表

URL地址:/v1/splicer/wall/list

请求方式:GET

功能描述:

参数:

键名类型参数说明备注
tokenstringtoken编码

返回值:

键名类型参数说明备注
dataobject
messagestring返回消息正确错误时都返回
statusnumber返回状态码0:正确

data:

键名类型参数说明备注
active_wall_idnumber当前活动的屏幕墙
wallsarray [object]屏幕墙列表

Walls[0]:

键名类型参数说明备注
comb_columnnumber
comb_linenumber
dis_hsizenumber
dis_vsizenumber
enableboolean是否可见
heightnumber
hznumber屏幕刷新率
led_modebooleanLED模式
modenumber模式
namestring屏幕名称
screen_infoobject屏幕信息
sub_columnnumber
sub_linenumber
vmode_hnumnumber
vmode_vnumnumber
wall_idnumber屏幕ID
widthnumber

screen_info:

键名类型参数说明备注
screen_heightnumber屏幕宽
screen_widthnumber屏幕高
x_offsetnumberX偏移
y_offsetnumberY偏移