上架/下架/解绑回放视频--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

上架/下架/解绑回放视频

最近更新时间：2024.08.23 17:10:04首次发布时间：2022.03.29 22:10:12

您可通过此接口在指定直播间内上架、下架或解绑回放视频。

说明

如果直播间内没有回放视频，您可调用 UploadReplayAPI 接口将媒资库的视频文件作为直播间的回放视频。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1772441831234`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。
MediaId	Long	是	`3706016`	回放列表视频 ID。您可通过 ListMediasAPI 接口的返回参数 `MediaId` 获取 ID。
OnlineStatus	Integer	是	`1`	对回放视频的操作。取值如下： `0`：下架回放视频。如果直播状态为回放且无其他已上架回放视频，则直播状态会切换为已结束。 `1`：上架回放视频。如果直播状态为已结束，则直播状态会切换为回放。 `2`：解绑回放视频。如果直播状态为回放且无其他已上架回放视频，则直播状态会切换为已结束。
ForceReplayStatus	Boolean	否	`true`	直播状态为预告时，上架回放视频（即 `OnlineStatus` 参数的取值为 `1` 时）是否将直播状态切换为回放。默认值为 `false`。取值如下： `true`：直播状态切换为回放，且播放上架的回放视频。 `false`：直播状态不变，且不播放上架的回放视频。

返回参数

无。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateMediaOnlineStatusAPI&Version=2020-06-01
{
  "ActivityId": 1772441831234,
  "MediaId": 3706016,
  "OnlineStatus": 1,
  "ForceReplayStatus": true
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "UpdateMediaOnlineStatusAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1655978114
  }
}

错误码

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