更新视频轮播配置信息--企业直播-火山引擎

文档中心

立即注册

导航

更新视频轮播配置信息

最近更新时间：2024.07.10 18:27:10首次发布时间：2024.06.19 11:42:26

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

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1776085489138`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
LineId	Long	是	`123`	直播频道 ID。您可以通过 GetStreamsAPI 接口查询 ID。
LoopNumber	Integer	否	`1`	轮播次数。取值范围为 [1,50]，默认取值为 `1`。
IsShowProgram	Integer	否	`0`	是否在观看页展示节目单（轮播视频列表）。支持以下取值，默认取值为 `0`。 `0`：不展示 `1`：展示
PlayType	Integer	否	`0`	轮播类型。支持以下取值，默认取值为 `0`。 `0`：按次数轮播 `1`：按时段轮播
AutoStartTime	Long	否	`0`	轮播自动开始时间。Unix 时间戳，单位为秒。默认取值为 `0`。支持精确到分钟级开播。开始时间取值需同时满足以下条件：大于等于`当前时间 + 300`，即当前时间 5 分钟及之后的某个时间点。小于 `AutoEndTime` 的取值，且与 `AutoEndTime` 的差值最大为 259,200，即 72 小时。说明当 `PlayType` 取值为 `1` 时，该参数必传。
AutoEndTime	Long	否	`0`	轮播自动结束时间。Unix 时间戳，单位为秒。默认取值为 `0`。支持精确到分钟级开播。结束取值需大于 `AutoStartTime` 的取值，且与 `AutoStartTime` 的差值最大为 259,200，即 72 小时。说明当 `PlayType` 取值为 `1` 时，该参数必传。
ProgramName	String	否	`节目单`	节目单名称。说明当 `IsShowProgram` 取值为 `1` 时，该参数必传。
LoopVideos	Array of LoopVideos	否	`-`	轮播视频信息列表。说明最多支持添加 50 个轮播视频且视频总大小需小于等于 200 GB。

LoopVideos

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

返回参数

参数	类型	示例值	描述
ActivityId	Long	`10211`	直播间 ID。
LineId	Long	`123`	直播频道 ID。
LoopNumber	Integer	`1`	轮播次数。
LoopVideos	Array of LoopVideos	`-`	轮播视频信息列表。
IsShowProgram	Integer	`0`	是否在观看页展示节目单（轮播视频列表）。支持以下取值： `0`：不展示 `1`：展示
ProgramName	String	`节目单`	节目单名称。
AutoStartTime	Long	`0`	轮播自动开始时间。Unix 时间戳，单位为秒。
AutoEndTime	Long	`0`	轮播自动结束时间。Unix 时间戳，单位为秒。
PlayType	Integer	`0`	轮播类型。支持以下取值： `0`：按次数轮播 `1`：按时间轮播

LoopVideos

参数	类型	示例值	描述
Index	Integer	`1`	轮播视频序号。序号越小，位置越靠前。
VideoCoverImage	String	`http://www.example.com`	轮播视频封面图。包含协议头。
VideoName	String	`视频.mp4`	轮播视频名称。
VideoVid	String	`v0c251g7007acp7jhnvog65i97kr43jg`	轮播视频 Vid。
ReviewStatus	Integer	`2`	轮播视频的审核状态。支持以下取值： `1`：审核中 `2`：审核成功 `3`：审核失败
Offset	Integer	`0`	轮播启动时刻，即视频将从该时刻开始播放。单位为秒。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateLoopVideos&Version=2023-08-01
{
    "ActivityId": 1776085489138,
    "LineId": 123,
    "LoopNumber": 1,
    "LoopVideos": [
        {
            "Index": 1,
            "VideoName": "视频.mp4",
            "VideoVid": "v02a49370000brtj0qvm75gbiokkno91"
        }
    ],
    "IsShowProgram": 0,
    "PlayType": 0,
    "AutoStartTime": 0,
    "AutoEndTime": 0,
    "ProgramName": "节目单"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateLoopVideos",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1"
    },
    "Result": {
        "ActivityId": 1776085489138,
        "LineId": 123,
        "LoopNumber": 1,
        "LoopVideos": [
            {
                "Index": 1,
                "VideoCoverImage": "http://www.example.com",
                "VideoName": "视频.mp4",
                "VideoVid": "v02a49370000brtj0qvm75gbiokkno91",
                "Offset": 0,
                "ReviewStatus":2
            }
        ],
        "IsShowProgram": 0,
        "ProgramName": "节目单",
        "AutoStartTime": 0,
        "AutoEndTime": 0,
        "PlayType": 0
    }
}

错误码

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