1. 接口描述
接口请求域名: iotvideoindustry.tencentcloudapi.com 。
本接口(DescribeDeviceStreams)用于获取设备实时流地址。
请使用DescribeChannelStreamURL接口
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDeviceStreams。 |
Version | 是 | String | 公共参数,本接口取值:2020-12-01。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
DeviceId | 是 | String | 设备唯一标识 示例值:99933020581320000064_99933020581320000064 |
ExpireTime | 是 | Integer | 流地址失效时间 示例值:1610199034 |
ChannelId | 否 | String | 通道唯一标识(接口升级字段为必填) 示例值:99933020581320000064_99933020581320000064 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | DescribeDeviceStreamsData | 设备实时流地址列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取设备流地址
输入示例
POST / HTTP/1.1
Host:iotvideoindustry.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeviceStreams
<公共请求参数>
{
"DeviceId": "xxx",
"ExpireTime": 1610199034
}
输出示例
{
"Response": {
"Data": {
"RtspAddr": "NULL",
"RtmpAddr": "rtmp://dev-pl.video.tencentcs.com/live/0035752400?txSecret=1a52a468ed68ce343d42bdb1c80ae855&txTime=5FE720C7",
"HlsAddr": "http://dev-pl.video.tencentcs.com/live/0035752400.m3u8?txSecret=1a52a468ed68ce343d42bdb1c80ae855&txTime=5FE720C7",
"FlvAddr": "http://dev-pl.video.tencentcs.com/live/0035752400.flv?txSecret=1a52a468ed68ce343d42bdb1c80ae855&txTime=5FE720C7"
},
"RequestId": "d3d6f466-f2c2-44df-b78b-383ba717a3d8"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue.DeviceOffline | 设备离线或未注册。 |
InvalidParameterValue.DeviceTypeNotSupport | 设备类型不支持。 |
InvalidParameterValue.ExpireTime | 超时时间错误。 |
ResourceNotFound.DeviceNotExist | 设备未创建或是已删除。 |
ResourceUnavailable.StreamInfoException | 流信息异常。 |
UnsupportedOperation.DeviceMissMatch | 设备和通道不匹配,请检查。 |
UnsupportedOperation.DeviceSipCommandFail | 设备信令不通。 |
UnsupportedOperation.UserIsIsolate | 处于隔离中的资源不能进行此操作。 |