编辑轮播--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

编辑轮播

最近更新时间：2024.06.13 19:09:50首次发布时间：2022.03.29 22:10:12

您可通过此接口更新指定直播间中指定直播频道的轮播次数、轮播视频列表等信息。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=UpdateLoopVideoAPI&Version=2020-06-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateLoopVideoAPI`	接口名称。当前 API 的名称为 `UpdateLoopVideoAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`732412312`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
LineId	Long	是	`1234`	直播频道 ID。您可以通过 GetStreamsAPI 接口查询 ID。
LoopNumber	Integer	是	`1`	轮播次数。取值范围为 [1,100]。
LoopVideo	Array of LoopVideo	是	`-`	轮播视频列表。说明最多支持添加 50 个轮播视频且视频总大小需小于等于 200 GB。

LoopVideo

参数	类型	是否必选	示例值	描述
Index	Long	是	`1`	轮播视频序号。该参数取值为从 `1` 开始的连续且不重复的整数，如 `1`、`2`、`3`。取值范围为 [1,50]。取值越小，位置越靠前。
VideoName	String	是	`dongchedi2.mp4`	轮播视频名称。
VideoVid	String	是	`v02a49370000brtj0qvm75gbiokkno91`	轮播视频 Vid。您可以通过 ListActivityMediaAPI 接口查询 Vid。

返回参数

参数	类型	示例值	描述
Id	Long	`10211`	轮播配置 ID。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateLoopVideoAPI&Version=2020-06-01
{
  "ActivityId": 732412312,
  "LineId": 1234,
  "LoopNumber": 1,
  "LoopVideo": [
    {
      "Index": 1,
      "VideoName": "企业直播.mp4",
      "VideoVid": "v02a49370000brtj0qvm75gbiokkno91"
    }
  ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023101310322878F6F44F43F36AC3CA5A",
        "Action": "UpdateLoopVideoAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697164349
    },
    "Result": {
        "Id": 10211
    }
}

错误码

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