有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

接口请求域名: weilingwith.tencentcloudapi.com 。

实时流接口

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeVideoLiveStream。
Version String 公共参数,本接口取值:2023-04-27。
Region String 公共参数,详见产品支持的 地域列表
WID String 设备的唯一标识

示例值:c0e3f641-6ec6-444e-8ac9-3cfecc755cb0
Protocol String 枚举如下:
flv
rtmp
hls
webrtc
raw (视频原始帧)
示例值:hls
WorkspaceId Integer 工作空间Id
示例值:1016
ApplicationToken String 应用token
示例值:xxx
StreamId Integer 主码流传0,子码流传1,默认主码流

示例值:0
Env String 设备所在环境,公有云私有化项目传0或者不传,混合云项目一般传空间id
示例值:0

3. 输出参数

参数名称 类型 描述
Result VideoRecordStreamRes 视频实时流获取结果
示例值:{"FLV":"","HLS":"https://t-video.twins.tencent.com:443/hls1935/76d8109e-64cd-4a85-b011-4a0c29a654e8.m3u8?ticket=7a2368131f084363a4a6cb146cbfc353","RAW":{"IP":"","InnerIP":"","NATIP":"","Port":0,"SM4Vector":"","StreamEnKey":"","StreamToken":""},"RTMP":"","Stream":"76d8109e-64cd-4a85-b011-4a0c29a654e8","WebRTC":""}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取实时流地址

成功响应

输入示例

POST / HTTP/1.1
Host: weilingwith.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVideoLiveStream
<公共请求参数>

{
    "WID": "76d8109e-64cd-4a85-b011-4a0c29a654e8",
    "Protocol": "hls",
    "WorkspaceId": 1016,
    "ApplicationToken": "ct5E8QNPQEZZqNW7ShPAJQVzrTV9xIbL"
}

输出示例

{
    "Response": {
        "RequestId": "96233e8f-3a98-470b-8bf2-45fbd4988bd8",
        "Result": {
            "FLV": "",
            "HLS": "https://t-video.twins.tencent.com:443/hls1935/xxx",
            "RAW": {
                "IP": "",
                "InnerIP": "",
                "NATIP": "",
                "Port": 0,
                "SM4Vector": "",
                "StreamEnKey": "",
                "StreamToken": ""
            },
            "RTMP": "",
            "Stream": "76d8109e-64cd-4a85-b011-4a0c29a654e8",
            "WebRTC": ""
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.LockRedisCacheFailed 锁定Redis缓存错误
FailedOperation.SendMsgToIOTFailed 向IOT服务发送消息失败
InternalError 内部错误。
InvalidParameter.InvalidMetaData 错误的Meta数据,无法构建握手参数
InvalidParameterValue.InvalidProtocol 非法protocol协议参数
InvalidParameterValue.InvalidStreamId 非法StreamId,StreamId仅支持0或1
LimitExceeded.VideoStreamThresholdExceeded 视频流超过阈值
LimitExceeded.VideoTranscode 视频转码超出阈值
MissingParameter.EmptyWID WID参数缺失
ResourceNotFound.CameraBaseInfoNotExist 摄像头基础信息不存在
ResourceNotFound.CameraStatusNotExist 摄像头状态不存在
ResourceNotFound.SRSHookServiceNode srs_hook服务节点缺失
ResourceNotFound.SRSNotExist 该deviceId的srs信息缺失
ResourceNotFound.VideoPushServiceNode VideoPush服务节点缺失
ResourceUnavailable.DeviceOffline 设备已离线