调用 ListLoopVideos 接口，获取指定直播间中指定直播频道的伪直播配置信息，包括是否开启伪直播、伪直播类型、绑定的互动脚本 ID 等。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListLoopVideos | 接口名称。当前 API 的名称为 ListLoopVideos。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| ActivityId | Long | 是 | 1776****89138 | 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。 |
| LineId | Long | 是 | 123 | 直播频道 ID。您可通过调用 GetStreamsAPI 接口获取 ID。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| ActivityId | Long | 1776****89138 | 直播间 ID。 |
| LineId | Long | 123 | 直播频道 ID。 |
LoopVideoStatus | Integer |
| 是否开始伪直播。取值如下：
|
PlayType | Integer |
| 伪直播类型。取值如下：
|
LoopNumber | Integer |
| 伪直播次数。例如，参数取值为 说明 该参数仅在 |
AutoStartTime | Long |
| 伪直播自动开始时间。Unix 时间戳，单位为秒。支持精确到分钟级开播。 说明 该参数仅在 |
AutoEndTime | Long |
| 伪直播自动结束时间。Unix 时间戳，单位为秒。支持精确到分钟级开播。 说明 该参数仅在 |
IsShowProgram | Integer |
| 是否在观看页展示节目单，即伪直播视频列表。取值如下：
|
ProgramName | String |
| 节目单名称。 说明 该参数仅在 |
| LoopVideos | Array of LoopVideos | - | 伪直播视频列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Index | Integer | 1 | 伪直播视频序号。取值范围为 [1,50]。取值越小，在伪直播视频列表中的位置越靠前。 |
| VideoCoverImage | String | https://www.example.com/a.png | 伪直播视频封面图，包含协议头。 |
| VideoName | String | 视频.mp4 | 伪直播视频名称。 |
| VideoVid | String | v0c251g7cp7j****g65i97kr43jg | 伪直播视频 Vid。 |
| Offset | Integer | 10 | 伪直播启动时刻。单位为秒。例如参数取值为 10，则从视频的第 10 秒开始播放。 |
| MediaSize | Long | 8589490 | 伪直播视频大小。单位为字节。 |
WarmupStatus | Integer |
| 预热状态。取值如下：
|
| WarmupProgress | Integer | 0 | 预热进度。取值范围为 [0,100]。 |
| MediaDuration | Integer | 60 | 视频时长。单位为秒。 |
ReviewStatus | Integer |
| 伪直播视频的审核状态。取值如下：
|
InteractionScriptEnabled | Boolean |
| 是否开启互动脚本。取值如下：
|
| InteractionScriptId | Long | 1 | 伪直播视频绑定的互动脚本 ID。取值为 0 表示该伪直播视频未绑定互动脚本。 |
GET https://livesaas.volcengineapi.com/?Action=ListLoopVideos&Version=2023-08-01&ActivityId=1776****89138&LineId=123
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "ListLoopVideos", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "ActivityId": 1776****89138, "LineId": 123, "LoopVideoStatus": 1, "LoopNumber": 3, "LoopVideos": [ { "Index": 1, "VideoCoverImage": "https://www.example.com/a.png", "VideoName": "视频.mp4", "VideoVid": "v0c251g7cp7j****g65i97kr43jg", "Offset": 10, "MediaSize": 8589490, "WarmupStatus": 0, "WarmupProgress": 0, "MediaDuration": 60, "ReviewStatus": 2, "InteractionScriptEnabled": true, "InteractionScriptId": 1 } ], "IsShowProgram": 0, "ProgramName": "节目单", "PlayType": 0, "AutoStartTime": 1736823565, "AutoEndTime": 1736923565 } }