You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/视频轮播/获取视频轮播配置信息
获取视频轮播配置信息
最近更新时间：2024.06.19 11:42:27首次发布时间：2024.06.19 11:42:27
我的收藏

您可通过此接口获取指定直播间中指定直播频道的轮播开启状态、轮播次数及轮播类型等视频轮播配置信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是ListLoopVideos接口名称。当前 API 的名称为 ListLoopVideos。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。
ActivityIdLong是1776085489138直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
LineIdLong是123直播频道 ID。您可以通过 GetStreamsAPI 接口查询 ID。

返回参数

参数类型示例值描述
ActivityIdLong17765489138直播间 ID。
LineIdLong123直播频道 ID。

LoopVideoStatus

Integer

2

是否开启视频轮播。支持以下取值：

  • 1：开启
  • 2：关闭
LoopNumberInteger1轮播次数。
LoopVideosArray of LoopVideos-轮播视频信息列表。

IsShowProgram

Integer

0

是否在观看页展示节目单（轮播视频列表）。支持以下取值：

  • 0：不展示
  • 1：展示
ProgramNameString节目单节目单名称。

PlayType

Integer

0

轮播类型。支持以下取值：

  • 0：按次数轮播
  • 1：按时段轮播
AutoStartTimeInteger0轮播自动开始时间。Unix 时间戳，单位为秒。
AutoEndTimeInteger0轮播自动结束时间。Unix时间戳，单位为秒。

LoopVideos

参数类型示例值描述
IndexInteger1轮播视频序号。序号越小，位置越靠前。
VideoCoverImageStringhttps://www.example.com轮播视频封面图。包含协议头。
VideoNameString视频.mp4轮播视频名称。
VideoVidStringv0c251g7cp7jhnvog65i97kr43jg轮播视频 Vid。
OffsetInteger0轮播启动时刻，即视频将从该时刻开始播放。单位为秒。
MediaSizeLong8589490轮播视频大小。单位为字节。

WarmupStatus

Integer

0

预热状态。支持以下取值：

  • 0：初始状态
  • 1：预热中
  • 2：预热成功
  • 3：预热失败
WarmupProgressInteger0预热进度。取值范围为 [0,100]。
MediaDurationInteger60视频时长。单位为秒。

ReviewStatus

Integer

2

轮播视频的审核状态。支持以下取值：

  • 1：审核中
  • 2：审核成功
  • 3：审核失败

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListLoopVideos&Version=2023-08-01&ActivityId=17765489138&LineId=123

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListLoopVideos",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1717288552
    },
    "Result": {
        "ActivityId": 17765489138,
        "LineId": 123,
        "LoopVideoStatus": 2,
        "LoopNumber": 1,
        "LoopVideos": [
            {
                "Index": 1,
                "VideoCoverImage": "https://www.example.com",
                "VideoName": "视频.mp4",
                "VideoVid": "v0c251g7cp7jhnvog65i97kr43jg",
                "Offset": 0,
                "MediaSize": 8589490,
                "WarmupStatus": 0,
                "WarmupProgress": 0,
                "MediaDuration": 60,
                "ReviewStatus": 2
            }
        ],
        "IsShowProgram": 0,
        "ProgramName": "节目单",
        "PlayType": 0,
        "AutoStartTime": 0,
        "AutoEndTime": 0
    }
}

错误码

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