Recorder API
录制任务相关接口文档。
TIP
其中的id是内部id,并非直播间id,可从列表接口获取
获取录制任务列表
获取所有录制任务的列表,支持筛选和分页。
接口地址: GET /recorder/list
请求参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| platform | string | 否 | 直播平台,可选值: DouYu(斗鱼), HuYa(虎牙), Bilibili(哔哩哔哩), DouYin(抖音) |
| recordStatus | string | 否 | 录制状态, recording(录制中), unrecorded(未录制) |
| name | string | 否 | 备注名称或直播间号,模糊搜索 |
| autoCheck | boolean | 否 | 是否自动监控 |
| page | number | 否 | 页码 |
| pageSize | number | 否 | 每页数量 |
| sortField | string | 否 | 排序字段, living(直播状态), state(录制状态), monitorStatus(监控状态) |
| sortDirection | string | 否 | 排序方向, asc(升序), desc(降序) |
添加录制任务
添加一个新的录制任务。
接口地址: POST /recorder/add
参数太多了,自己去抓吧
获取录制任务详情
获取指定录制任务的配置信息。
接口地址: GET /recorder/:id
路径参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | string | 是 | 录制任务ID |
更新录制任务
更新指定录制任务的配置。
接口地址: PUT /recorder/:id
路径参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | string | 是 | 录制任务ID |
请求参数:
参数太多了,自己去抓吧
删除录制任务
删除指定的录制任务。
接口地址: DELETE /recorder/:id
路径参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | string | 是 | 录制任务ID |
查询参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| removeHistory | string | 否 | 是否删除录制历史,传入 "true" 表示删除,默认为 false |
开始录制
手动开始录制指定的直播间。
接口地址: POST /recorder/:id/start_record
路径参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | string | 是 | 录制任务ID |
停止录制
手动停止录制指定的直播间。
接口地址: POST /recorder/:id/stop_record
路径参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | string | 是 | 录制任务ID |
解析直播间地址
解析直播间URL,获取对应的直播间信息。
接口地址: GET /recorder/manager/resolveChannel
查询参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| url | string | 是 | 直播间地址 |
具体支持的格式见 支持的直播间链接
获取直播间源站信息
批量获取直播间的源站信息。
接口地址: POST /recorder/manager/liveInfo
请求参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| ids | array | 是 | 录制任务ID列表 |
| forceRequest | boolean | 否 | 强制查询直播间信息,不受配置限制,默认为 true |
