ListLoopVideos - 获取录播直播配置信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

ListLoopVideos - 获取录播直播配置信息

最近更新时间：2025.08.27 16:38:29首次发布时间：2024.06.19 11:42:27

调用 ListLoopVideos 接口，获取指定直播间的录播直播配置信息，包括是否开启录播直播、录播直播类型、录播直播视频信息等。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=ListLoopVideos&Version=2023-08-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数	类型	是否必选	示例值	描述
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	`1`	是否开始录播直播。取值如下： `1`：开始 `2`：结束
PlayType	Integer	`0`	录播直播类型。取值如下： `0`：按次数录播直播 `1`：按时间段录播直播
LoopNumber	Integer	`3`	录播直播次数。例如，参数取值为 `3`，则录播直播开始后，录播直播视频列表会循环播放 3 次。说明该参数仅在 `PlayType` 取值为 `0` 时生效。
AutoStartTime	Long	`1736823565`	录播直播自动开始时间。Unix 时间戳，单位为秒。支持精确到分钟级开播。在录播直播自动开始和结束的时间段内，录播直播视频列表会循环播放。说明该参数仅在 `PlayType` 取值为 `1` 时生效。
AutoEndTime	Long	`1736923565`	录播直播自动结束时间。Unix 时间戳，单位为秒。支持精确到分钟级开播。在录播直播自动开始和结束的时间段内，录播直播视频列表会循环播放。说明该参数仅在 `PlayType` 取值为 `1` 时生效。
IsShowProgram	Integer	`0`	已废弃。
ProgramName	String	`节目单`	已废弃。
LoopVideos	Array of LoopVideos	`-`	录播直播视频信息。

LoopVideos

参数	类型	示例值	描述
Index	Integer	`1`	录播直播视频序号。取值固定为 `1`。
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	`0`	已废弃。
WarmupProgress	Integer	`0`	已废弃。
MediaDuration	Integer	`60`	视频时长。单位为秒。
ReviewStatus	Integer	`2`	录播直播视频的审核状态。取值如下： `1`：审核中 `2`：审核成功 `3`：审核失败
TranscodeStatus	Integer	`2`	录播直播视频的转码状态。取值如下： `1`：转码中 `2`：转码成功 `3`：转码失败
InteractionScriptEnabled	Boolean	`true`	是否开启互动脚本。取值如下： `true`：开启 `false`：不开启
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": 1,
        "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,
                "TranscodeStatus": 2
            }
        ],
        "IsShowProgram": 0,
        "ProgramName": "节目单",
        "PlayType": 0,
        "AutoStartTime": 1736823565,
        "AutoEndTime": 1736923565
    }
}

错误码

访问公共错误码和错误码获取详细信息。