合并回放文件--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

合并回放文件

最近更新时间：2024.01.04 11:49:01首次发布时间：2023.07.10 10:49:15

将多个回放视频合并成一个视频文件，并按需选择是否将其上架至指定直播间。合并后的视频文件存储在媒资库 > 视频库中。您可以通过调用 ListActivityMediaAPI 接口查询合并生成的回放视频。

注意事项

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

请求说明

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

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

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

Body

参数	类型	是否必选	示例值	描述
Vids	Array of String	是	`["vdasdasdag","vdasdasabc"]`	待合并的回放视频 Vid 列表。您可以通过 ListMediasAPI 接口查询 Vid。说明最多支持合并 10 个视频文件且总时长不可超过 24 小时。
OnlineStatus	Integer	否	`1`	是否将合并生成的视频文件上架至指定直播间。若上架，则需要通过 `ActivityId` 参数指定上架的直播间。默认取值为 `0`。 `0`：不上架 `1`：上架
ActivityId	Long	否	`17700853219225`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。若合并生成的视频文件需要上架到直播间（即 `OnlineStatus` 取值为 `1`），您需要通过该参数指定上架的直播间。
MediaName	String	否	`合并文件_202306301230`	合并生成的视频文件名称。名称默认为：合并文件 + "_" + 年月日 + 时分。
ForceReplayStatus	Boolean	否	`true`	在直播状态为预告或已结束时，上架合并生成的视频文件（即 `OnlineStatus` 取值为 `1`），是否将直播状态切换为回放。默认取值为 `false`。 `true`：切换，则直播状态切换为回放并播放上架的回放视频。 `false`：不切换，则直播状态不变且不播放上架的回放视频。

返回参数

参数	类型	示例值	描述
MergeTaskId	String	`e01039216ede40b0a16462buu7139c03`	合并任务 ID。返回该 ID，表示已成功将合并任务提交至云剪辑。合并任务完成后，将通过合并回放视频结果回调进行通知。

示例

请求示例

POST https://livesaas.volcengineapi.com/?Action=MediasMergeAPI&Version=2020-06-01
{
  "Vids": [
    "vdasdasdag","vdasdasabc"
  ],
  "ActivityId": 17700853219225,
  "MediaName": "合并文件_202306301230",
  "OnlineStatus": 1,
  "ForceReplayStatus": true
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "MediasMergeAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "MergeTaskId": "e01039216ede40b0a16462buu7139c03"
  }
}

错误码

下表提供了该接口特有的错误码，公共错误码请参见公共错误码和错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter.VidsInvalid	The total video duration exceeds the limit.	回放视频总时长超出限制。请修改后重试。
500	InternalError	No space left in library.	媒资库空间不足。