列表直播
优质
小牛编辑
131浏览
2023-12-01
修改列表名称【控制台】
基本信息
Path： /listlive/api/renamelist
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| listid | number | 非必须 | 列表ID | ||
| listname | string | 非必须 | 列表名称 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 必须 |
创建列表【控制台】
基本信息
Path： /listlive/api/createlist
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| actid | string | 必须 | 频道HashID | ||
| listname | string | 必须 | 列表名称 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 非必须 | |||
| id | number | 非必须 | 列表ID |
删除列表【控制台】
基本信息
Path： /listlive/api/dellist
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| listid | number | 必须 | 列表ID |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 必须 |
暂停视频【控制台】
基本信息
Path： /listlive/api/setpause
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| listid | number | 必须 | 列表ID | ||
| pause | boolean | 必须 | 是否暂停 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 必须 |
更新列表【控制台】
基本信息
Path： /listlive/api/savevideolist
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| lid | number | 非必须 | 列表ID | ||
| videos | object [] | 非必须 | 视频列表 | item 类型: object | |
| ├─ name | string | 非必须 | 视频名称 | ||
| ├─ url | string | 非必须 | 视频拉流地址 | ||
| ├─ quality | number | 非必须 | 分辨率，例如：360，480... | ||
| ├─ duration | number | 非必须 | 视频时长 | ||
| ├─ cover | string | 非必须 | 视频预览图 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 必须 |
获取列表【控制台】
基本信息
Path： /listlive/api/list
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| actid | 是 | 频道Hash ID |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 非必须 | |||
| result | object [] | 非必须 | 列表 | item 类型: object | |
| ├─ id | number | 非必须 | 列表ID | ||
| ├─ name | string | 非必须 | 列表名称 | ||
| ├─ loop | boolean | 非必须 | 是否循环播放 | ||
| ├─ pause | boolean | 非必须 | 是否暂停 | ||
| ├─ running | boolean | 非必须 | 是否正在播放 | ||
| ├─ current_index | number | 非必须 | 当前视频下标 | ||
| ├─ current_position | number | 非必须 | 当前视频时间点 | ||
| ├─ duration | number | 非必须 | 总视频时长 | ||
| ├─ videos | object [] | 非必须 | 视频内容列表 | item 类型: object | |
| ├─ name | string | 必须 | 视频名称 | ||
| ├─ url | string | 必须 | 视频拉流地址 | ||
| ├─ quality | number | 必须 | 分辨率 | ||
| ├─ duration | number | 必须 | 视频时长 | ||
| ├─ cover | string | 必须 | 视频预览图 | ||
| ├─ index | number | 必须 | 视频下标 |
视频跳跃到下一时间点【控制台】
基本信息
Path： /listlive/api/setposition
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| listid | number | 非必须 | 列表ID | ||
| index | number | 非必须 | 视频下标 | ||
| position | number | 非必须 | 时间点，单位 纳秒 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 必须 |
设置循环播放【控制台】
基本信息
Path： /listlive/api/setloop
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| listid | number | 非必须 | 列表ID | ||
| loop | boolean | 非必须 | 是否循环播放 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 必须 |
跳至其他视频【控制台】
基本信息
Path： /listlive/api/setindex
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| listid | number | 非必须 | 列表ID | ||
| index | number | 非必须 | 视频下标 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 必须 |
开启列表直播【控制台】
基本信息
Path： /listlive/api/start
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| actid | string | 必须 | 频道HashID | ||
| listid | number | 必须 | 列表ID | ||
| loop | boolean | 非必须 | 是否循环播放，默认不循环 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 必须 |
停止列表直播【控制台】
基本信息
Path： /listlive/api/stop
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| actid | string | 必须 | 频道HashID | ||
| listid | number | 必须 | 列表ID |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 必须 |