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

# 1.1 用户登录

URL 地址:/v1/user/login

请求方式:POST

功能描述:用户登录

参数:

键名 类型 参数说明 备注
username string 登录名
password string 密码

返回值:

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

# 1.2 用户登出

URL 地址:/v1/user/logout

请求方式:GET

功能描述:用户登出

参数:

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

返回值:

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

# 1.3 修改密码

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

请求方式:POST

功能描述:修改密码

参数:

键名 类型 参数说明 备注
token string token编码
new_password string 新密码
old_password string 旧密码
username string 用户名

返回值:

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

# 2.1 拼接器基础信息

URL地址:/v1/splicer/info

请求方式:GET

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

参数:

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

返回值:

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

data:

键名 类型 参数说明 备注
brand object 品牌
echo_mode number 回显模式 0无回显,1模式1,2-模式2
has_walls boolean 是否有屏幕墙列表 是否支持获取屏幕墙列表
ip string IP 设备IP
port number 端口 设备端口
scene_delete boolean 是否能删场景
scene_new boolean 是否能新建场景
scene_switch boolean 是否能切换场景
signal_group boolean 信号源是否有分组
switch_wall boolean 是否能切换屏幕墙
version string 版本
walls_setting boolean 是否能进行屏幕墙设置
window_close boolean 是否能删除窗口
window_open boolean 是否能新建窗口
window_signal_change boolean 是否能切换窗口的信号
window_size_change boolean 是能改变窗口的大小

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

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

请求方式:GET

功能描述:

参数:

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

返回值:

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

data:

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

list:

键名 类型 参数说明 备注
column number
line number
pos_info array 信号源对应回显画面的坐标

pos_info[0]:

键名 类型 参数说明 备注
channel number 信号源ID
mode number 模式
pos array 信号源对应回显画面的坐标 每个窗口对应信号源
pos_ex array

pos[0]:

键名 类型 参数说明 备注

pos_ex[0]:

键名 类型 参数说明 备注
x0 number 左上角x坐标
x1 number 右下角x坐标
y0 number 左上角y坐标
y1 number 右下角y坐标

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

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

请求方式:GET

功能描述:

参数:

键名 类型 参数说明 备注
token string token编码
signal_id number 屏幕墙ID

返回值:

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


# 2.4 获取逻辑槽位模板

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

请求方式:GET

功能描述:

参数:

键名 类型 参数说明 备注
token string token编码
wall_id number 屏幕墙ID

返回值:

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

data:

键名 类型 参数说明 备注
id string 槽位模版ID
pos array 返回消息

pos[0]

键名 类型 参数说明 备注
x0 number 左上角x坐标
x1 number 右下角x坐标
y0 number 左上角y坐标
y1 number 右下角y坐标

# 2.4 更新逻辑槽位模板

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

请求方式:PUT

功能描述:

参数:

键名 类型 参数说明 备注
token string token编码
wall_id number 屏幕墙ID
enable_logic_slot boolean 虚拟槽位开启
logic_slot_info array 槽位列表

logic_slot_info[0]:

键名 类型 参数说明 备注
x0 number 左上角x坐标
x1 number 右下角x坐标
y0 number 左上角y坐标
y1 number 右下角y坐标

返回值:

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

# 2.5 保存逻辑槽位模板

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

请求方式:POST

功能描述:

参数:

键名 类型 参数说明 备注
token string token编码
pos array 虚拟槽位列表

pos[0]

键名 类型 参数说明 备注
x0 number 左上角x坐标
x1 number 右下角x坐标
y0 number 左上角y坐标
y1 number 右下角y坐标

返回值:

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

# 2.6 删除逻辑槽位模板

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

请求方式:POST

功能描述:

参数:


键名 类型 参数说明 备注
token string token编码
wall_id number 屏幕墙ID
logic_template_id string 模版ID

返回值:

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

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

URL地址:/v1/splicer/portmap

请求方式:GET

功能描述:

参数:

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

返回值:

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

data:

键名 类型 参数说明 备注
output array
port_map array

port_map[0]:

键名 类型 参数说明 备注
port array 端口
wall_id number 屏幕墙ID

port[0]:

键名 类型 参数说明 备注
logic_port number 逻辑端口
phy_port number 物理端口

# 2.8 绑定端口

URL地址:/v1/splicer/portmap

请求方式:POST

功能描述:

参数:

键名 类型 参数说明 备注
token string
port array 绑定端口列表
wall_id number "wall_id": 0

Port[0]:

键名 类型 参数说明 备注
logic_port number 逻辑端口
phy_port number 物理端口

返回值:

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

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

URL地址:/v1/splicer/portmap

请求方式:DELETE

功能描述:

参数:

键名 类型 参数说明 备注
token string

返回值:

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

# 2.10 与硬件同步

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

请求方式:GET

功能描述:

参数:

键名 类型 参数说明 备注
token string

返回值:

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

# 2.11 删除场景

URL地址:/v1/splicer/scene

请求方式:DELETE

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

参数:

键名 类型 参数说明 备注
token string
wall_id number 屏幕墙ID
scene_id number 场景ID

返回值:

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

# 2.12 场景列表

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

请求方式:GET

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

参数:

键名 类型 参数说明 备注
token string token编码
wall_id number 屏幕墙ID

返回值:

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

data:

键名 类型 参数说明 备注
active_scene_id number 当前活动的场景
scenes array 场景列表

scenes[0]:

键名 类型 参数说明 备注
enable number
enable_logic_slot boolean 是否开启虚拟槽位
id number 场景ID
index number 场景序列
logic_slot_info array 虚拟槽位列表
main_voice_mode number 音频模式
name string 场景名称
windows array 场景里的窗口列表 windows数组(场景下窗口列表)可能为空

logic_slot_info[0]:

键名 类型 参数说明 备注
x0 number 左上角x坐标
x1 number 右下角x坐标
y0 number 左上角y坐标
y1 number 右下角y坐标

windows[0]:

键名 类型 参数说明 备注
enable boolean 是否可用(是否显示)
id number 窗口ID
is_mute boolean 是否静音
source_id number 窗口绑定的信号源ID
volume number 音量
win_blend_coef number
win_level number 窗口排列时的层级
x0 number 左上角x坐标
x1 number 右下角x坐标
y0 number 左上角y坐标
y1 number 右下角y坐标

# 2.13 新建场景

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

请求方式:POST

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

参数:

键名 类型 参数说明 备注
token string token编码
new_name string 新场景名称
wall_id number 屏幕墙ID

返回值:

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

# 2.14 场景重命名

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

请求方式:POST

功能描述:场景的重命名

参数:

键名 类型 参数说明 备注
token string token编码
wall_id number 屏幕墙ID
scene_id number 场景ID
new_name string 场景新名称

返回值:

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

# 2.15 保存场景

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

请求方式:GET

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

参数:

键名 类型 参数说明 备注
token string token编码
wall_id number
scene_id number

返回值:

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

# 2.16 场景排序

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

请求方式:POST

功能描述:

参数:

键名 类型 参数说明 备注
token string token编码
wall_id number 屏幕墙ID
scene_sort_info array 场景排序信息

scene_sort_info[0]:

键名 类型 参数说明 备注
scene_id number 场景ID
sortindex number 场景排序序列

返回值:

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

# 2.17 场景切换

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

请求方式:GET

功能描述:

参数:

键名 类型 参数说明 备注
token string token编码
wall_id number
scene_id number

返回值:

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

# 2.18 设置窗口音频

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

请求方式:PUT

功能描述:

参数:

键名 类型 参数说明 备注
token string token编码
wall_id number 屏幕墙ID
scene_id number 场景ID
window_info object 窗口信息

window_info:

键名 类型 参数说明 备注
enable boolean 是否可用(是否显示)
id number 窗口ID
is_mute boolean 是否静音
source_id number 窗口关联的信号源ID
volume number 音量
win_blend_coef number
win_level number 窗口排列时的层级
x0 number 左上角x坐标
x1 number 右下角x坐标
y0 number 左上角y坐标
y1 number 右下角y坐标

返回值:

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

# 2.19 关闭窗口

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

请求方式:GET

功能描述:

参数:

键名 类型 参数说明 备注
token string token编码
wall_id number 屏幕墙ID
scene_id number 场景ID
win_id number 窗口ID

返回值:

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

# 2.20 改变窗口层级

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

请求方式:GET

功能描述:

参数:

键名 类型 参数说明 备注
token string token编码
wall_id number 屏幕墙ID
scene_id number 场景ID
win_id number 窗口ID
source number 信号源ID
level number 窗口层级 -1置顶,0置底,1-n层级,n越大越上层

返回值:

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

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

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

请求方式:GET

功能描述:

参数:

键名 类型 参数说明 备注
token string token编码
wall_id number 屏幕墙ID
scene_id number 场景ID
win_id number 窗口ID

返回值:

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

data:

键名 类型 参数说明 备注
enable boolean 窗口是否显示
id number 窗口ID
is_mute boolean 窗口是否静音
source_id number 信号源ID
volume number 音量
win_blend_coef number
win_level number 窗口层级
x0 number 左上角x坐标
x1 number 右下角x坐标
y0 number 左上角y坐标
y1 number 右下角y坐标

# 2.22 窗口移动

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

请求方式:GET

功能描述:

参数:

键名 类型 参数说明 备注
token string token编码
wall_id number 屏幕墙ID
scene_id number 场景ID
win_id number 窗口ID
source number 信号源ID
x0 number 左上角x坐标
x1 number 右下角x坐标
y0 number 左上角y坐标
y1 number 右下角y坐标

返回值:

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

# 2.23 新建窗口

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

请求方式:GET

功能描述:

参数:

键名 类型 参数说明 备注
token string token编码
wall_id number 屏幕墙ID
scene_id number 场景ID
win_id number 窗口ID
source number 信号源ID
x0 number 左上角x坐标
x1 number 右下角x坐标
y0 number 左上角y坐标
y1 number 右下角y坐标

返回值:

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

# 2.24 切换窗口信号源

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

请求方式:GET

功能描述:

参数:

键名 类型 参数说明 备注
token string token编码
wall_id number 屏幕墙ID
scene_id number 场景ID
win_id number 窗口ID
source number 信号源ID
x0 number 左上角x坐标
x1 number 右下角x坐标
y0 number 左上角y坐标
y1 number 右下角y坐标

返回值:

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

# 2.25 信号列表

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

请求方式:GET

功能描述:

参数:

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

返回值:

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

data:

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

signals[0]:

键名 类型 参数说明 备注
HZ number 刷新率
channel number
connect_channel number
enable boolean 是否可见
ext string
height number
id string 信号源ID
ip string IP
name string 信号源名称
type number
width number

# 2.26 信号源重命名

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

请求方式:POST

功能描述:

参数:

键名 类型 参数说明 备注
token string token编码
new_name string 新的信号源名称
source object 信号源

source:

键名 类型 参数说明 备注
HZ number 刷新率
channel number
connect_channel number
enable boolean 是否可见
ext string
height number
id string 信号源ID
ip string IP
name string 信号源名称
type number
width number

返回值:

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

# 2.27 编辑屏幕墙

URL地址:/v1/splicer/wall

请求方式:POST

功能描述:

参数:

键名 类型 参数说明 备注
token string token编码
comb_column number 垂直数量
comb_line number 水平数量
height number 高度
width number 宽度
enable boolean 是否可用
led_mode number led模式
mode number 模式
name string 名称
hz number 刷新率
screen_info object led设置
vmode_hnum number 虚拟槽 水平分割
vmode_vnum number 虚拟槽 垂直分割
wall_id string 屏幕墙ID
sub_column number
sub_line number
dis_hsize number 分辨率的宽
dis_vsize number 分辨率的高

返回值:

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

# 2.28 删除屏幕墙

URL地址:/v1/splicer/wall

请求方式:DELETE

功能描述:

参数:

键名 类型 参数说明 备注
token string token编码
comb_column number 垂直数量
comb_line number 水平数量
height number 高度
width number 宽度
enable boolean 是否可用
led_mode number led模式
mode number 模式
name string 名称
hz number 刷新率
screen_info object led设置
vmode_hnum number 虚拟槽 水平分割
vmode_vnum number 虚拟槽 垂直分割
wall_id number 屏幕墙ID
sub_column number
sub_line number
dis_hsize number 分辨率的宽
dis_vsize number 分辨率的高

返回值:

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

# 2.29 屏幕墙列表

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

请求方式:GET

功能描述:

参数:

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

返回值:

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

data:

键名 类型 参数说明 备注
active_wall_id number 当前活动的屏幕墙
walls array [object] 屏幕墙列表

Walls[0]:

键名 类型 参数说明 备注
comb_column number
comb_line number
dis_hsize number
dis_vsize number
enable boolean 是否可见
height number
hz number 屏幕刷新率
led_mode boolean LED模式
mode number 模式
name string 屏幕名称
screen_info object 屏幕信息
sub_column number
sub_line number
vmode_hnum number
vmode_vnum number
wall_id number 屏幕ID
width number

screen_info:

键名 类型 参数说明 备注
screen_height number 屏幕宽
screen_width number 屏幕高
x_offset number X偏移
y_offset number Y偏移