You need to enable JavaScript to run this app.
导航

启用视频流

最近更新时间2023.08.11 21:23:00

首次发布时间2023.06.27 11:40:50

启用指定视频流(适用于接入类型为 GB 的空间内的视频流)。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考「公共参数」。

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称StartStream
VersionQueryString公共参数,OpenAPI 接口版本2021-01-01

StreamID

Query

String

视频流 ID

可通过调用 ListStreams 接口获
说明:与 DeviceNSID+ChannelID 组合二选一

Body 参数

字段
类型
必填
说明

DeviceNSID

String

设备国标 ID
说明:与 StreamID 二选一

ChannelID

String

视频流通道 ID
说明:与 StreamID 二选一

StreamType

Integer

视频流码流:

  • 0(主码流)
  • 1~n(子码流)

说明:

  • 如果 StreamType 和 Resolution 都不指定,则默认拉取主码流
  • StreamType 和 Resolution 参数不能同时指定

Resolution

String

视频流分辨率:

  • 1(QCIF - 176x144)
  • 2(CIF - 320x288)
  • 3(4CIF - 704x576)
  • 4(D1 - 720x576)
  • 5(720p)
  • 6(1080p/i)
  • 其他(自定义宽高,如19201080等,需设备支持)

说明:

  • 如果 StreamType 和 Resolution 都不指定,则默认拉取主码流
  • StreamType 和 Resolution 参数不能同时指定

返回结果

返回参数说明

通用返回参数,请参考 ResponseMetadata 结构体说明

Result 字段包含以下参数:

字段
类型
说明
IDString启用成功的视频流 ID
PullUrlsString[]拉流地址

示例

请求示例

POST https://open.volcengineapi.com?Action=StartStream
&Version=2021-01-01
&<公共请求参数>

{
    "DeviceNSID": "34020037991180xxxxxx",
    "ChannelID": "34020000001320xxxxxx",
    "StreamType": 0
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202112081609140102120720962400088F",
        "Action": "StartStream",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "4b9ee060-9fed-4c0e-aaa4-283b17xxxxxx",
        "PullUrls": [
                "rtmp://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001",
                "http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.flv",
                "http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.m3u8",
                "http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.sdp"
        ]
    }
}