微录播api（相机目录、视频、pdf处理、导播、用戶、片头资源、切片上传）

微录播 相机目录 视频 pdf

更新历史

目录

1. 相机目录操作

1.1 创建相机目录

接口功能

创建相机目录

接口地址

/camera

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
name	是	string	相机目录名称

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/camera
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}

1.2 相机目录列表

接口功能

获取相机目录列表

接口地址

/camera/list

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数

参数	必选	类型	说明
RequestBody

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/camera/list
Response
成功:{"success":true,data:["001","002","003","004"]}
失败:{"success":false,"error":"XXX"}

1.3 保存单个相机列表编辑页面状态

接口功能

保存单个相机列表编辑页面状态

接口地址

/camera/history

HTTP Content-Type

application/json

HTTP 请求方式

post

请求参数

参数	必选	类型	说明
RequestBody
camera	是	string	相机列表的名称
data	是	string	编辑页面的操作状态json_string

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/camera/history
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}

1.4 获取单个相机列表编辑页面状态

接口功能

获取单个相机列表编辑页面状态

接口地址

/camera/history

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParam
camera	是	string	相机列表的名称

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/camera/history

Response
成功:{"success":true,"data":"{xxx}"}
失败:{"success":false,"error":"XXX"}

1.5 获取相机日期列表

接口功能

获取相机日期列表

接口地址

/video/daylist/：camera

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数

参数	必选	类型	说明
RequestBody
camera	是	string	相机的名称

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/video/daylist/001
Response
成功:{"success":true,data:["xxx","xxx"]}
失败:{"success":false,"error":"XXX"}

2. 视频处理

2.1 视频剪辑

接口功能

合并视频

接口地址

/video/cut

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
QueryParam
name	是	String	合成后的视频名称
data	是	JsonString	任务json字符串数组

data

组成形式：[{json},{json}]，如下为json的参数

参数	必选	类型	说明
type	是	string	类型 cut:剪辑；merge:合并
index	是	string	任务的执行顺序
url	是	string	任务所对应视频的地址
starttime	是	string	单个任务的剪辑开始时间
duration	是	string	单个任务的剪辑时长

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/video/cut

Response
成功:{"success":true，cutid："1"}
失败:{"success":false,"error":"XXX"}

2.2 查询剪辑任务执行状态

接口功能

查询剪辑任务执行状态

接口地址

/cut/:id

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParam
id	是	string	相机列表的名称

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/camera/history

Response
成功:{"success":true,"data":"{xxx}"}
失败:{"success":false,"error":"XXX"}

2.3 获取相机时间轴视频文件列表

接口功能

获取相机时间轴视频文件列表

接口地址

/video/dateline

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数

参数	必选	类型	说明
RequestBody
camera	是	string	相机的名称
day	是	string	日期

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/video/dateline
Response
成功:{"success":true,data:["xxx","xxx"]}
失败:{"success":false,"error":"XXX"}

2.4 USB上传相机视频文件

接口功能

USB上传相机视频文件

接口地址

/video/USB

HTTP Content-Type

application/json

HTTP 请求方式

post

请求参数

参数	必选	类型	说明
RequestBody
camera	是	string	相机的名称

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/video/USB
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}

2.5 合并ts

接口功能

合并视频

接口地址

/direct/mergeTs

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
QueryParam
name	是	String	合成后的视频名称
tsArr	是	json_array	任务json数组,['xxx','xxx','xxx'],xxx为单个ts的路径

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/direct/mergeTs

Response
成功:{"success":true，cutid："1"}
失败:{"success":false,"error":"XXX"}

3. pdf

3.1 上传pdf

接口功能

上传pdf文件

接口地址

/pdf

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
QueryParam

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/pdf

Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}

3.2 获取pdf列表

接口功能

上传pdf文件

接口地址

/pdf/list

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParam

HTTP 响应状态

200

data参数

其他响应状态描述请参照：【备注】-【错误码】
提供pdf截图功能，assist_url去掉后缀.pdf +/n.png
如：storage/swlsource/pdf/f7/bd262d5d/5.png 代表第五页pdf的截图

接口示例

Request
url: http://ip:port/pdf

Response
成功:{"success":true，data:[{xxx},{xxx}]}
失败:{"success":false,"error":"XXX"}

4. 导播

4.1 导播同步云端pdf

接口功能

导播同步云端pdf

接口地址

/direct/pdf

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
id	是	string	手机端生成与云端对应的唯一id值
url	是	string	pdf的地址，pdf列表接口的assist_url

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/direct/pdf
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}

4.2 导播同步swl

接口功能

导播同步swl文件

接口地址

/direct/swl

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
pdf_json	是	Json	pdf 相关信息，多个pdf，例子{data：[{knowledge:{id:"",title:"",image:""}:knowledge_elements:[{id:"",type:"",image:""...}]}]}
topic_json	否	Json	题目相关信息，多个题目
vtt_json	是	Json	字幕相关信息，多个字幕
video_name	是	String	视频名称
video_url	是	String	视频url
pdf_url	是	String	[pdf 路径
pdf_name	是	String	[pdf 名称

pdf_json

组成形式：{data:[json]}，如下为json的参数

参数	必选	类型	说明
sTime	是	String	pdf 开始时间
duration	是	String	pdf 时长
title	是	String	pdf 标题
page	是	String	pdf 页数

topic_json

组成形式：{data:[json]}，如下为json的参数

参数	必选	类型	说明
showTime	是	String	答题 显示时间
duration	是	String	pdf 时长
title	是	String	pdf 标题

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/direct/swl
Response
成功:{"success":true,"swlid":"xxxx"}
失败:{"success":false,"error":"XXX"}

5. 导播数据库操作

5.1 上传封面

接口功能

上传导播显示的封面

接口地址

/swl/uploadPoster

HTTP Content-Type

multipart/form-data

HTTP 请求方式

POST

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://192.168.1.237/swl/uploadPoster
Response
{"success":true,"path":"storage/poster/upload_656bdadb1a4a90bf0b41b45e85018791.jpg"}

5.2 创建导播

接口功能

创建一条导播

接口地址

/direct/

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
title	是	string	导播的标题
phone_id	是	string	手机唯一id值
start_time	是	string	导播的开始时间，eg:"2017-02-22 15:00:00"

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/direct/
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}

5.3 编辑导播

接口功能

编辑导播数据，例如修改导播简介，保存导播封面等

接口地址

/direct/:direct_id

HTTP Content-Type

application/json

HTTP 请求方式

PUT

请求参数

参数	必选	类型	说明
RequestBody
direct_id	是	string	导播的id
tile	否	string	tile
introduction	否	string	课程简介
poster	否	string	封面的url
status	否	int	导播状态（int） 0:未开始；1：正在导播；2：正在直播；3结束导播
creator_uid	否	string	创建者id
creator_nickname	否	string	创建者昵称
live_url	否	string	直播的url
pdf_json	否	string	pdf_json
camera_json	否	string	相机地址
people_num	否	int	观看人数
start_time	否	string	开始时间

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/direct/pdf
data:{introduction:'导播1课程内容十分丰富',people_num:10}
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}

5.4 删除导播

接口功能

删除导播

接口地址

/direct/:direct_id

HTTP Content-Type

application/json

HTTP 请求方式

DELETE

请求参数

参数	必选	类型	说明
RequestBody
direct_id	是	string	导播id

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/direct/be5cbce2-16c1-44f7-996b-b522693b26db
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}

5.5 （教师）获取导播列表

接口功能

获取导播列表数据

接口地址

/direct/list

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
RequestBody

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/direct/list
Response
成功:{"success":true,"data":[{"direct_id":"ed9003df-97d6-4b33-a399-70ea843e772f","title":"导播3","introduction":"","poster":"","status":0,"creator_uid":"50","creator_nickname":"陪陪","live_url":"","pdf_json":"","camera_json":"","people_num":0,"start_time":"2017-02-22 15:00:00","update_time":"2017-02-22 13:35:12","_id":4}]}
失败:{"success":false,"error":"XXX"}

5.6 分享导播

接口功能

教师分享导播给学生进行观看

接口地址

/direct/share/:direct_id

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
direct_id	是	string	导播id
sharers	是	string	被分享者的uid拼接字符串，eg:'paki1,paki3,paki4'

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://192.168.1.188:3000/direct/share/0b77dd01-f188-40d9-8dc1-c81e323bd4f2
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}

5.7 （学生）获取导播列表

接口功能

获取导播列表数据

接口地址

/direct/share/list

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
RequestBody

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/direct/share/list
Response
成功:{"success":true,"data":[{"direct_id":"ed9003df-97d6-4b33-a399-70ea843e772f","title":"导播3","introduction":"","poster":"","status":0,"creator_uid":"50","creator_nickname":"陪陪","live_url":"","pdf_json":"","camera_json":"","people_num":0,"start_time":"2017-02-22 15:00:00","update_time":"2017-02-22 13:35:12","_id":4}]}
失败:{"success":false,"error":"XXX"}

6. 用户模块

6.1 添加用户

接口功能

添加用户

接口地址

/users/

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
role	是	int	用户的类型
username	是	string	用户名
nickname	是	string	用户昵称
pass	是	string	用户密码

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/users/
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}

6.2 删除用户

接口功能

添加用户

接口地址

/users/:username

HTTP Content-Type

application/json

HTTP 请求方式

DELETE

请求参数

参数	必选	类型	说明
RequestBody
username	是	string	用户名

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/users/pakis
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}

6.3 修改用户

接口功能

添加用户

接口地址

/users/:username

HTTP Content-Type

application/json

HTTP 请求方式

PUT

请求参数

参数	必选	类型	说明
RequestBody
username	是	string	用户名
nickname	否	string	用户昵称
phone	否	string	用户手机
pass	否	string	用户密码

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/users/pakis
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}

6.4 获取用户列表

接口功能

添加用户

接口地址

/users/list

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
RequestBody

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/users/list
Response
成功:{"success":true,"users":[{xx:xx},{xx:xx},{xx:xx}...]}
失败:{"success":false}

7、片头资源

7.1 上传片头图片

接口功能

添加用户

接口地址

/swl/uploadPoster

HTTP Content-Type

formdata/multipart

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/swl/uploadPoster
Response
成功:{"success":true,path:'storage/swlsource/poster/upload_e48938464fd88d99bd6a63c28b3a7fbe.jpg'}
失败:{"success":false,"error":"XXX"}

7.2 上传片头视频

接口功能

添加用户

接口地址

/video

HTTP Content-Type

formdata/multipart

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/video
Response
成功:{"success":true,path:'storage/storage/public/lubocam/upload_e48938464fd88d99b.mp4'}
失败:{"success":false,"error":"XXX"}

7.3 获取片头图片列表

接口功能

添加用户

接口地址

/swl/listPic

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
RequestBody

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/swl/listPic
Response
成功:{"success":true,"data":[{"creator_uid":"admin","name":"53edc9d0d9613.jpg","size":64313,"path":"storage/swlsource/poster/upload_e48938464fd88d99bd6a63c28b3a7fbe.jpg","type":"pic","uuid":"a934cf3c-4986-4730-828d-c8598a3933d7","create_time":"2017-04-18 14:45:49","_id":4},{"creator_uid":"admin","name":"Ace18.jpg","size":381608,"path":"storage/swlsource/poster/upload_a20391fa7ee58bf2b13db5bd9dee2f8d.jpg","type":"pic","uuid":"31e4a094-40bc-49c7-83f5-767476fb512b","create_time":"2017-04-18 14:45:44","_id":3},{"creator_uid":"admin","name":"111.png","size":3374,"path":"storage/swlsource/poster/upload_24925d6f1542d00b29092c2ef5401872.png","type":"pic","uuid":"61d009fc-c50a-4727-8b3f-589b313da602","create_time":"2017-04-18 14:45:38","_id":2}]}
失败:{"success":false,"error":"XXX"}

8. 切片上传

8.1 提交切片上传任务

接口功能

提交切片上传任务

接口地址

/upload/uuid

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
fileName	是	string	文件的名称
size	否	int	文件的总大小
chunkSize	是	int	单个切片的大小

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/upload/uuid
Response
成功:{"success":true,uuid:'adsaddhadherdha'}
失败:{"success":false,"error":"XXX"}

8.2 上传切片

接口功能

上传切片

接口地址

/upload/uuid/:uuid

HTTP Content-Type

formdata/multipart

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
uuid	是	string	切片上传的任务id

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/upload/uuid/agsdagsdgdaegaeada
Response
成功:{"success":true,path:'storage/storage/public/lubocam/upload_e48938464fd88d99b.mp4'}
失败:{"success":false,"error":"XXX"}

8.3 获取切片上传的任务信息

接口功能

获取切片上传的任务信息，主要用于断点续传

接口地址

/upload/resume/:uuid

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
RequestBody
uuid	是	string	切片上传的任务id

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/upload/resume/agsdagsdgdaegaeada
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}

8.4 上传ts切片

接口功能

上传切片

接口地址

/upload/TsUuid/:uuid

HTTP Content-Type

formdata/multipart

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
uuid	是	string	切片上传的任务id
chunk	是	string	上传的文件
end	是	boolean	是否结束

HTTP 响应状态

200

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/upload/uuid/agsdagsdgdaegaeada
Response
成功:{"success":true,path:'storage/storage/public/lubocam/upload_e48938464fd88d99b.mp4'}
失败:{"success":false,"error":"XXX"}