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

您可通过此接口更新指定直播间视频轮播的开启状态。

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是UpdateLoopVideoStatus接口名称。当前 API 的名称为 UpdateLoopVideoStatus。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。

Body

参数类型是否必选示例值描述
ActivityIdLong是1776085489138直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

IsStartLoopVideo

Integer

是

1

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

  • 1：开启
  • 2：关闭

LineId

Long

否

123

直播频道 ID。您可以通过 GetStreamsAPI 接口查询 ID。

说明

  • 当 IsStartLoopVideo 取值为 2 时，该参数必传。
  • LineId 和 IsStartAllLine 同时传入时，IsStartAllLine 的优先级更高。

IsStartAllLine

Boolean

否

true

是否开启当前直播间所有直播频道的视频轮播。支持以下取值，默认取值为 false。

  • true：全部开启
  • false：仅开启当前直播频道

说明

  • 当 IsStartLoopVideo 取值为 2 时，无需传入该参数。
  • 未传入 LineId 参数时，本参数必传且取值必须为 true。
  • LineId 和 IsStartAllLine 同时传入时，IsStartAllLine 的优先级更高。

返回参数

参数类型示例值描述

Status

Boolean

false

是否更新成功。支持以下取值：

  • true：成功
  • false：失败
FailLineIdsArray of Long[409144,409154]开启视频轮播失败的直播频道的 ID 列表。当选择开启当前直播间所有直播频道的视频轮播（即 IsStartAllLine 取值为 true），且存在部分直播频道开启失败时，返回该列表。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateLoopVideoStatus&Version=2023-08-01
{
    "ActivityId": 1776085489138,
    "IsStartLoopVideo": 1,
    "LineId": 123,
    "IsStartAllLine": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateLoopVideoStatus",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "System Time": 1697163541
    },
    "Result": {
        "Status": false,
        "FailLineIds":[
            409144,
            409154
        ]
    }
}

错误码

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