You need to enable JavaScript to run this app.
导航
创建视频流
最近更新时间:2024.04.16 15:36:55首次发布时间:2021.11.25 17:21:46

在指定空间内创建视频流(适用于接入类型为 RTMP、拉流空间)。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com?Action=CreateStream&Version=2021-01-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringCreateStream接口名称。当前 API 的名称为 CreateStream
VersionString2021-01-01接口版本。当前 API 的版本为 2021-01-01
SpaceIDStringa2d6ca94-334b-4f81-b89c-02d381xxxxxx空间 ID,可通过调用 ListSpaces 接口获取。

Body

参数类型是否必选示例值描述
StreamNameStringStream01视频流名称。
DescriptionStringNew stream for pulling video视频流描述。

PullSource

String

https://livedomain/live/stream1.m3u8

拉流地址。

  • 空间为拉流空间时必填,支持 RTMP 或 HLS 协议拉流地址。
  • 空间为 RTMP 空间时不填。

Destination

String

rtmp://livedomain/live/stream1

转推地址。

  • 空间为拉流空间时生效,表示将拉取的视频流转推到此地址,默认为空时表示拉取视频流至慢直播中心,转推地址支持 RTMP 协议推流地址。
  • 空间为 RTMP 空间时不填。

说明

将视频流拉取至慢直播中心时,视频流将通过慢直播节点分发,分发地址可以通过 GetStream 获取;也可以通过指定 Destination 字段,将流同时转推到其他第三方地址。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数类型示例值描述
IDString3a890d3f-6db4-4663-a5a6-9abf0683627f创建成功的视频流 ID,流状态以及拉流地址可以通过 GetStream 获取。

请求示例

POST https://open.volcengineapi.com?Action=CreateStream&Version=2021-01-01&SpaceID=a2d6ca94-334b-4f81-b89c-02d381xxxxxx
{
    "StreamName": "Stream01",
    "Description": "New stream for pulling video",
    "PullSource": "https://livedomain/live/stream1.m3u8",
    "Destination": "rtmp://livedomain/live/stream2"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202112081549400102121450322701D9BA",
        "Action": "CreateStream",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "3a890d3f-6db4-4663-a5a6-9abf0683627f"
    }
}

错误码

您可访问公共错误码,获取更多错误码信息。