1. 接口描述
接口请求域名: iss.tencentcloudapi.com 。
用于获取设备的实时开流地址。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ControlDeviceStream。 |
| Version | 是 | String | 公共参数,本接口取值:2023-05-17。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| ChannelId | 是 | String | 通道 ID(从通道查询接口DescribeDeviceChannel中获取) 示例值:f7ca505f-be1b-4ce8-849b-**** |
| StreamType | 否 | String | 流类型(1:主码流; 示例值:1 |
| Resolution | 否 | String | 分辨率(1:QCIF; 示例值:19201080 |
| IsInternal | 否 | Boolean | 是否内网 示例值:true |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | ControlDeviceStreamData | 返回数据 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ControlDeviceStream
<公共请求参数>
{
"ChannelId": "df27ec26-812c-443c-b594-f95bf383ef70"
}
输出示例
{
"Response": {
"Data": {
"FMp4": "https://test-play-gz.***********/live/df27ec26-****-443c-b594-************.live.mp4?token=cms_700000*****9_1791947426_H9MbdKLQZiX7C-a******w",
"Flv": "https://test-play-gz.***********/live/df27ec26-****-443c-b594-************.live.flv?token=cms_700000*****_1791947426_H9MbdKLQZiX7C-********",
"Hls": "https://test-play-gz.***********/.cn/live/df27ec26-812c-******-b594-f95bf383ef70/hls.m3u8?token=cms_700000*****_1791947426_H9MbdKLQZiX7C-******",
"Rtmp": "rtmp://test-play-gz.***********/.cn/live/df27ec26-812c-******-b594-f95bf383ef70?token=cms_700000*****_1791947426_H9MbdKLQZiX7C-******"
},
"RequestId": "b62b4c63-0913-4a2b-85c9-4fc61d821530"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 无效的输入参数 |
| InvalidParameterValue.DeviceMismatchChannel | 设备ID和通道ID不匹配 |
| InvalidParameterValue.InvalidChannelId | 无效的通道ID |
| InvalidParameterValue.InvalidDeviceId | 无效的设备ID |
| InvalidParameterValue.InvalidStreamType | 无效的流类型 |
| ResourceNotFound | 资源不存在 |
| ResourceUnavailable.ChannelOffline | 通道离线 |
| ResourceUnavailable.DevDisable | 设备被禁用 |
| ResourceUnavailable.DevNoRegister | 设备未注册 |
| ResourceUnavailable.DevOffline | 设备离线 |
| UnsupportedOperation.StreamTypeOrResolution | StreamType和Resolution参数不支持同时下发 |