You need to enable JavaScript to run this app.
导航
慢直播
  • 文档首页
    • /
  • 慢直播

查看视频流列表

最近更新时间：2023.06.27 11:40:49

首次发布时间：2021.11.25 17:21:46

我的收藏

查询指定空间内已创建的视频流列表。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明
值
ActionQueryString是公共参数，OpenAPI 接口名称ListStreams
VersionQueryString是公共参数，OpenAPI 接口版本2021-01-01
SpaceIDQueryString是空间 ID可通过调用 ListSpaces 接口获取
StreamNameQueryString否筛选条件，视频流名称，支持模糊查询可通过调用 CreateStream 接口获取

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段
类型
说明
StreamsArray of objects查询到的设备信息列表，参考以下 List<Stream> 结构说明

List<Stream> 结构说明

字段
类型
说明
SpaceIDString视频流所属空间 ID
SIPIDStringSIP 服务器 ID
StreamNameString视频流名称
StreamIDString视频流 ID

SpaceAccessType

String

视频流所属空间类型：

  • rtmp
  • gb28181

Status

String

视频流状态：

  • online：在线
  • offline：离线
  • failed：失败
  • pulling：拉流中
DeviceIDString视频流所属设备 ID，RTMP 类型为空
DeviceNSIDString视频流所属设备国标 ID，RTMP 类型为空
ChannelIDString视频流所属设备通道 ID，RTMP 类型为空

StreamingType

String

视频流类型：

  • main_stream：主码流
  • sub_stream：子码流
DescriptionString视频流描述
ScreenshotObject为视频流配置的截图模板，参考以下 Template 数据结构说明
RecordObject为视频流配置的录制模板，参考以下 Template 数据结构说明
AIObject为视频流配置的 AI 模板，参考以下 Template 数据结构说明
RecentPushTsTimestamp最近推流时间
CreatedAtString视频流创建时间
UpdatedAtString视频流更新时间
RTMPushUrlString推流地址
PushUrlDDLInteger推流地址保存时间
PullUrlsString[]拉流地址
TransPullUrlsObject转封装拉流地址
RecentPushTsString最近推流时间

RtpTransportTcp

Boolean

流媒体传输是否使用 TCP 协议：

  • true：是
  • false：否

Resolution

String

通道支持的分辨率列表：

  • 1（QCIF - 176x144）
  • 2（CIF - 320x288)
  • 3（4CIF - 704x576)
  • 4（D1 - 720x576)
  • 5（720p)
  • 6（1080p/i)
  • 其他（自定义宽高，如19201080等，需设备支持）
LogsArray of objects流最近的日志，暂显示最近的一条，参考以下 LogInfo 数据结构说明

Template 数据结构说明

字段
类型
说明
TemplateIDString模板 ID（未配置时为空）
TemplateNameString模板名称（未配置时为空）

LogInfo 数据结构说明

字段
类型
说明
MessageStringLog 信息

LogLevel

Int32

  • 0：info
  • 1：warning
  • 2：error
LogTimeInt64Log 时间戳，精确到秒

示例

请求示例

GET https://open.volcengineapi.com?Action=ListStreams
&Version=2021-01-01
&SpaceID=517ff7ec-7700-4862-b1e7-7967a4xxxxxx
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021120815283601021117309810012896",
        "Action": "ListStreams",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 10,
        "Streams": [
            {
                "SpaceID": "517ff7ec-7700-4862-b1e7-7967a4xxxxxx",
                "SIPID": "34020000002000xxxxxx",
                "StreamName": "34020033991320xxxxxx_34020033991320384963",
                "StreamID": "4b9ee060-9fed-4c0e-aaa4-283b17xxxxxx",
                "SpaceAccessType": "gb28181",
                "DeviceID": "0a32c128-c89c-4f39-aa60-66e5f1xxxxxx",
                "DeviceNSID": "34020033991320xxxxxx",
                "ChannelID": "34020033991320xxxxxx",
                "Status": "online",
                "StreamingType": "main_stream",
                "Description": "channel: 34020033991320xxxxxx@device: 34020033991320xxxxxx",
                "Screenshot": {
                    "TemplateName": "",
                    "TemplateID": ""
                },
                "Record": {
                    "TemplateName": "online-record-1022",
                    "TemplateID": "1f5704dc-8d31-4547-9534-1ac40bxxxxxx"
                },
                "AI": {
                    "TemplateName": "car0121",
                    "TemplateID": "1c443146-8d6a-44d5-baf8-5efafcxxxxxx"
                },
                "CreatedAt": "2023-06-13T16:20:28+08:00",
                "UpdatedAt": "2023-06-13T16:22:28+08:00",
                "PushUrlDDL": 1687383521,
                "RTMPushUrl": "https://xxx-push.xx/xxx.sdp?Time=123&Secret=xxx",
                "PullUrls": [
                    "rtmp://m8v21xhnuzxxxxxx.pull.xxx.com/xxx/xxx_xxx_xxx",
                    "https://prcldt8wqxxxxxx.pull.xxx.com/xxx.flv",
                    "https://prcldt8wqxxxxxx.pull.xxx.com/xxx.m3u8"
                ],
                "TransPullUrls": {
                    "flv": [
                        "https://prcldt8wqxxxxxx.pull.xxx.com/xxx.flv",
                        "https://prcldt8wqxxxxxx.pull.xxx.com/xxx.flv",
                        "https://prcldt8wqxxxxxx.pull.xxx.com/xxx.flv",
                        "https://prcldt8wqxxxxxx.pull.xxx.com/xxx.flv"
                    ],
                    "hls": [
                        "https://prcldt8wqxxxxxx.pull.xxx.com/xxx.m3u8",
                        "https://prcldt8wqxxxxxx.pull.xxx.com/xxx.m3u8",
                        "https://prcldt8wqxxxxxx.pull.xxx.com/xxx.m3u8",
                        "https://prcldt8wqxxxxxx.pull.xxx.com/xxx.m3u8"
                    ],
                    "rtmp": [
                        "rtmp://m8v21xhnuzxxxxxx.pull.xxx.com/xxx/xxx_xxx_xxx",
                        "rtmp://m8v21xhnuzxxxxxx.pull.xxx.com/xxx/xxx_xxx_xxx",
                        "rtmp://m8v21xhnuzxxxxxx.pull.xxx.com/xxx/xxx_xxx_xxx",
                        "rtmp://m8v21xhnuzxxxxxx.pull.xxx.com/xxx/xxx_xxx_xxx"
                    ],
                    "webrtc": [
                        "https://m8v21xhnuzxxxxxx.pull.xxx.com/xxx/xxx_xxx.sdp",
                        "https://m8v21xhnuzxxxxxx.pull.xxx.com/xxx/xxx_xxx.sdp",
                        "https://m8v21xhnuzxxxxxx.pull.xxx.com/xxx/xxx_xxx.sdp",
                        "https://m8v21xhnuzxxxxxx.pull.xxx.com/xxx/xxx_xxx.sdp"
                    ]
                },
                "FailedTimes": 0,
                "RecentPushTs": "2021-11-30T17:07:35+08:00",
                "RtpTransportTcp": true,
                "Resolution": "6",
                "Logs": [
                    {
                        "LogTime": 1638603119124,
                        "LogLevel": 2,
                        "Message": "invite message send failed"
                    }
                ]
            }
             ...
             ...
             ...
        ]
    }
}