视频录制记录API
# 列表查询
接口说明
根据查询条件查询视频录制记录列表。
接口版本
v1接口地址
/api-v1/camera-records
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 | 默认 | 示例 |
---|---|---|---|---|---|---|
query | label | string | false | 模糊查询字段 | name | |
query | search | string | false | 模糊查询值 | 测试 | |
query | time | string | false | 时间范围查询字段,必须是设备字段中的时间或时间戳字段名,例如createdAt,updatedAt | createdAt | |
query | range | string[] or string | false | 时间范围,开始时间到结束时间,可以是string[]或者以逗号分割的开始时间到结束时间或时间戳 | 2019-10-22T00:00:00.000Z,2022-01-22T00:00:00.000Z | |
query | page | number | false | 分页第几页 | 1 | |
query | limit | number | false | 单页几条数据 | 10 | |
query | sort | string | false | 根据哪个字段排序 | _id | -createdAt |
query | select | string | false | 只查询部分字段,字段名之间用过空格分隔,去掉某个字段的查询字段名前面加- | ||
query | autopopulate | boolean | false | 自动关联数据,部分字段自动关联关系表查询,设置这个值可开关自动联表查询 | true | false |
query | populate | string | false | 指定关联表查询,查询多个关联表用逗号分隔 | checks,operates |
请求参数举例
注意
GET请求所有参数类型都会变成string拼接在url上面,文档为了表述清晰,将示例结构以json格式编写
{
"page":"1",
"limit":"10",
"sort":"-_id",
"autopopulate":"false"
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 返回代码 |
data | json | True | 返回数据 |
-rows | array | False | 当前返回的视频录制记录对象列表 |
返回参数举例
{
"code": 0,
"data": {
"rows": [{
"_id": "61f11c94eb734c005a69dcc6",
"recordTime": "2022-01-26T10:04:04.308Z",
"camera": "61f11c8feb734c005a69dc71",
"duration": 10,
"image": "/path/a.jpg"
}]
}
}
# 新建
接口说明
新建一个标签信息。
接口版本
v1接口地址
/api-v1/camera-records
请求方法
POST
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
body | - | Object | True | 标签信息对象字段说明 |
请求参数举例
{
"recordTime": "2022-01-26T10:04:04.308Z",
"camera": "61f11c8feb734c005a69dc71",
"duration": 10,
"image": "http://res.25soft.com/api/uploads/6437a80829c2f81db01f475c/airconditioner.png",
"creator": "5714a78935b1fecb47044bf7"
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回创建的对象 |
返回参数举例
{
"code": 0,
"data": {
"_id": "61f11c94eb734c005a69dcc6",
"recordTime": "2022-01-26T10:04:04.308Z",
"camera": "61f11c8feb734c005a69dc71",
"duration": 10,
"image": "http://res.25soft.com/api/uploads/6437a80829c2f81db01f475c/airconditioner.png",
"creator": "5714a78935b1fecb47044bf7"
}
}
# 删除
接口说明
删除一个视频录制记录。
接口版本
v1接口地址
/api-v1/camera-records/:id
请求方法
DELETE
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 删除的视频录制记录ID |
请求参数举例
只需发送删除记录的ID
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 返回代码 |
data | string | false | 返回的数据 |
返回参数举例
{
"code": 0,
"data": {
"_id": "61f11c94eb734c005a69dcc6",
"recordTime": "2022-01-26T10:04:04.308Z",
"camera": "61f11c8feb734c005a69dc71",
"duration": 10,
"image": "/path/a.jpg"
}
}
# 资源服务器根据图片合成视频
接口说明
根据摄像头上传到资源服务器的截图,将这些截图和合并生成为一个视频。
接口版本
v1接口地址
https://res.25soft.com/api/uploads/image-to-video
请求方法
POST
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
body | images | Array | True | 图片截图保存在资源服务器的ID组,例如:图片路径是http://res.25soft.com/api/uploads/5fdc41591e911e0006e1a07b/1608270165349.jpg 其中5fdc41591e911e0006e1a07b是图片ID |
请求参数举例
{ "images":["5fdc41591e911e0006e1a07b","5fe1c34b1e911e0006e1a1b7","5fe1c3501e911e0006e1a1b8","5fe1c3601e911e0006e1a1b9"], }
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 返回代码 |
data | string | false | 视频网络路径 |
返回参数举例
{
"code": 0,
"data": "upload/2023/01/02/5fc919a14.mp4"
}
上次更新: 2023/04/13, 15:34:31