-
Notifications
You must be signed in to change notification settings - Fork 112
接口文档
banmajio edited this page Dec 7, 2020
·
1 revision
Path: /status
Method: GET
接口描述:
获取当前服务运行时长以及保活时长、推送IP、推送端口、设备主码流最大码率、设备子码流最大码率的信息。
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
uptime | string | 必须 | 运行时长 | ||
config | object | 必须 | 配置参数 | ||
├─ keepalive | string | 必须 | 保活时长(分钟) | ||
├─ push_host | string | 必须 | 推送IP | ||
├─ host_extra | string | 必须 | |||
├─ push_port | string | 必须 | 推送端口 | ||
├─ main_code | string | 必须 | 设备主码流最大码率 | ||
├─ sub_code | string | 必须 | 设备子码流最大码率 |
Path: /cameras
Method: GET
接口描述:
获取当前正在进行推流的设备信息。
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
object [] | 非必须 | item 类型: object |
|||
├─ ip | string | 必须 | 设备用户名 | ||
├─ username | string | 必须 | 设备密码 | ||
├─ password | string | 必须 | 设备ip | ||
├─ channel | string | 必须 | 通道号 | ||
├─ stream | string | 必须 | 码流(历史流不返回码流) | ||
├─ rtsp | string | 必须 | 取流地址 | ||
├─ rtmp | string | 必须 | 推流地址 | ||
├─ url | string | 必须 | 播放地址 | ||
├─ startTime | string | 非必须 | 开始时间(直播流没有开始时间) | ||
├─ endTime | string | 非必须 | 结束时间(直播流没有结束时间) | ||
├─ openTime | string | 必须 | 打开时间 | ||
├─ count | string | 必须 | 使用人数 | ||
├─ token | string | 必须 | 令牌 |
Path: /cameras
Method: POST
接口描述:
通过传入参数将rtsp流转为rtmp流进行推送。(历史流推送时,如果该设备正在推流则返回“当前视频正在使用中...”)
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
Body |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
ip | string | 必须 | 设备IP | ||
username | string | 必须 | 设备用户名 | ||
password | string | 必须 | 设备密码 | ||
channel | string | 必须 | 通道号 | ||
stream | string | 必须 | 码流(直播流需要指定码流;历史流不需要指定码流) | ||
startTime | string | 非必须 | 开始时间(直播流没有开始时间) | ||
endTime | string | 非必须 | 结束时间(直播流没有结束时间) |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
token | string | 必须 | 令牌 | ||
uri | string | 必须 | 推流地址 |
Path: /cameras/:tokens
Method: DELETE
接口描述:
关闭正在进行的推流任务。
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
tokens | 令牌 |
Path: /cameras/:tokens
Method: PUT
接口描述:
对正在推送的视频流进行保活。
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
tokens | 令牌 |