调用该接口获取IPC设备的直播开播地址。

使用限制

如果在企业版实例中调用该接口,必须传入参数IotInstanceId的值。否则,调用接口会失败。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String QueryLiveStreaming

系统规定参数。取值:QueryLiveStreaming

IotId String C47T6xwp6ms4bNlkHRWCg4****

IPC设备的设备ID。物联网平台为该设备颁发的ID,设备的唯一标识符。

可调用物联网平台QueryDeviceDetail查询。

Scheme String rtmp

播放协议类型:

  • rtmp(默认):RTMP协议
  • hls:HLS协议
  • flv:HTTP-FLV协议
IotInstanceId String iot-cn-n6w1y59****

实例ID:

  • 企业版实例:必须传入此参数。您可在物联网平台控制台的实例概览页面,查看您的企业版实例ID。
  • 公共实例:无需传入此参数。
StreamType Integer 0

码流类型:

  • 0(默认):主码流
  • 1:辅码流
CacheDuration Integer 0

视频缓存数据时长,取值范围为0~10000,单位为毫秒,默认值为0。

ShouldEncrypt Boolean false

是否加密:

  • true(默认):加密
  • false:不加密
PlayUnLimited Boolean false

播放地址在有效期内是否允许无限次使用:

  • true(默认):允许
  • false:不允许
EncryptType Integer 0

加密类型:

  • 1(默认):关键帧加密
  • 0:不加密
ForceIFrame Boolean false

是否给设备下发强制I帧指令:

  • true(默认):下发
  • false:不下发

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。

返回数据

名称 类型 示例值 描述
Code String 200

接口返回码:

  • 200:表示成功。
  • 其它:表示错误码。错误码详情,请参见错误码
Data Struct

播放地址信息。

DecryptKey String {\"iv\":\"\",\"key\":\"\"}

解密密钥。

Path String rtmp://106.15.XX.XX/live?token=token1/streamName

直播播放地址。

说明 播放地址有效期为10s。
ErrorMessage String stream push failed

调用失败时,返回的出错信息。

RequestId String 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1

阿里云为该请求生成的唯一标识符。

Success Boolean true

是否调用成功:

  • true:调用成功。
  • false:调用失败。

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryLiveStreaming
&IotId=C47T6xwp6ms4bNlkHRWCg4****
&<公共请求参数>

正常返回示例

XML格式

<QueryLiveStreamingResponse>
  <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>
  <Data>
        <Path>rtmp://106.15.XX.XX/live?token=token1/streamName</Path>
        <DecryptKey>{\"iv\":\"\",\"key\":\"\"}</DecryptKey>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</QueryLiveStreamingResponse>

JSON格式

{
    "RequestId": "06DC77A0-4622-42DB-9EE0-25FIOHS82JK1",
    "Data": {
        "Path": "rtmp://106.15.XX.XX/live?token=token1/streamName",
        "DecryptKey": "{\\\"iv\\\":\\\"\\\",\\\"key\\\":\\\"\\\"}"
    },
    "Code": "200",
    "Success": "true"
}

错误码

访问错误中心查看更多错误码。