生成直播流切片--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

生成直播流切片

最近更新时间：2024.07.23 11:32:26首次发布时间：2024.07.23 11:32:26

您可通过此接口对指定直播间的直播流进行切片。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1815315306165`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
IsBackup	Boolean	否	`false`	是否为备流，默认为主流。支持以下取值。有关如何开启主备流功能，详见直播频道管理。 `ture`：是 `false`：否
StartTime	Long	是	`1719900312`	切片的开始时间。Unix 时间戳，单位为秒。开始时间取值需同时满足以下条件：大于等于`当前时间 - 1,209,600`，即当前时间 14 天及之前的某个时间点。小于 `EndTime` 的取值，且与 `EndTime` 的差值最大为 86,400，即 24 小时。
EndTime	Long	是	`1719900315`	切片的结束时间。Unix 时间戳，单位为秒。结束时间取值需同时满足以下条件：大于 `StartTime` 的取值，且与 `StartTime` 的差值最大为 86,400，即 24 小时。小于等于当前时间。
LineId	Long	是	`46809590`	直播频道 ID。您可以通过 ListLiveChannelConfig 接口查询 ID。

返回参数

参数类型示例值描述

参数	类型	示例值	描述
Status	Boolean	`true`	是否开始生成切片。支持以下取值： `true`：开始生成 `false`：生成失败

Status

Boolean

true

是否开始生成切片。支持以下取值：

true：开始生成
false：生成失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=GenerateActivityStreamSlice&Version=2023-08-01
{
    "ActivityId": 1815315306165,
    "LineId": 46809590,
    "IsBackup": true,
    "StartTime": 1719900312,
    "EndTime": 1719900315
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GenerateActivityStreamSlice",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1717269866
    },
    "Result": {
        "Status": true
    }
}

错误码

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