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

调试

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

请求参数

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

系统规定参数。取值：QueryLiveStreaming。
Scheme String 否 rtmp

播放协议类型：

  • rtmp（默认）：RTMP协议。
  • hls：HLS协议。
  • flv：HTTP-FLV协议。
IotInstanceId String 否 iot-cn-n6w1y59****

实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。

重要
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无ID值，则无需传入。

实例的更多信息，请参见实例概述。
ProductKey String 否 a1BwAGV****

IPC设备所属产品的ProductKey。

您可以在物联网平台控制台产品页查看或调用QueryProductList查看当前账号下所有产品的信息。

重要 如果传入该参数，需同时传入DeviceName。
DeviceName String 否 camera1

IPC设备的设备名称。

您可以在物联网平台控制台的设备页查看DeviceName。

重要 如果传入该参数，需同时传入ProductKey。
EnableStun Boolean 否 false

是否启用P2P。

  • true：启用。
  • false（默认）：不启用。
说明 该功能仅支持白名单用户使用，如需了解使用相关功能，请发送邮件至cangyu.fhb@alibaba-inc.com进行咨询。
StreamType Integer 否 0

码流类型：

  • 0（默认）：主码流。
  • 1：辅码流。
CacheDuration Integer 否 0

视频缓存数据时长，取值范围为0~10000，单位为毫秒，默认值为0。
IotId String 否 C47T6xwp6ms4bNlkHRWCg4****

IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台QueryDeviceDetail查询。

重要 如果传入该参数，则无需传入ProductKey和DeviceName。IotId作为设备唯一标识符，和ProductKey与DeviceName的组合是一一对应的关系。如果您同时传入IotId和ProductKey与DeviceName的组合，则以IotId为准。
ShouldEncrypt Boolean 否 true

是否加密：

  • true：加密。
  • false（默认）：不加密。
UrlValidDuration Integer 否 60

URL有效期，取值范围为10~14400，单位为秒。默认值为10。
PlayUnLimited Boolean 否 false

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

  • true：允许。
  • false（默认）：不允许。
EncryptType Integer 否 0

加密类型：

0（默认）：关键帧加密。
ForceIFrame Boolean 否 false

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

  • true：下发。
  • false（默认）：不下发。

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

返回数据

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

接口返回码：

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

播放地址信息。
Path String rtmp://47.100.***.***:8000/live?token=dc1****120ce394ef94974/Eb****6RBe8l4_0

直播播放地址。

说明 播放地址有效期为10秒。
RelayDecryptKey String {\"iv\":\"MDEy**********+Pw==\",\"key\":\"TuqB5bpZ+589v********==\"}

解密密钥。

设置ShouldEncrypt参数为true时，生成解密密钥。

  • iv：表示初始向量。
  • key：表示解密密钥。
StunInfo String {\"stunUrl\":\"101.***.***.**:3478?key=MuJtPMYxxxxxA&productKey=g2zbxxxxxx&udpRequestTimeout=300&udpRequestRetryNum=5&p2pSessionTimeout=10000&maxPortDetectNum=20&packetsPerSecond=1\"}

P2P服务地址。
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****
&ShouldEncrypt=true
&<公共请求参数>

正常返回示例

XML格式

<QueryLiveStreamingResponse>
      <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>
      <Data>
            <Path>rtmp://47.100.***.***:8000/live?token=dc1****120ce394ef94974/Eb****6RBe8l4_0</Path>
            <StunInfo>{\"stunUrl\":\"101.***.***.**:3478?key=MuJtPMYxxxxxA&amp;productKey=g2zbxxxxxx&amp;udpRequestTimeout=300&amp;udpRequestRetryNum=5&amp;p2pSessionTimeout=10000&amp;maxPortDetectNum=20&amp;packetsPerSecond=1\"}</StunInfo>
            <RelayDecryptKey>{\"iv\":\"MDEy**********+Pw==\",\"key\":\"TuqB5bpZ+589v********==\"}</RelayDecryptKey>
      </Data>
      <Code>200</Code>
      <Success>true</Success>
</QueryLiveStreamingResponse>

JSON格式

{
    "RequestId": "06DC77A0-4622-42DB-9EE0-25FIOHS82JK1",
    "Data": {
        "Path": "rtmp://47.100.***.***:8000/live?token=dc1****120ce394ef94974/Eb****6RBe8l4_0",
        "StunInfo": "{\\\"stunUrl\\\":\\\"101.***.***.**:3478?key=MuJtPMYxxxxxA&amp;productKey=g2zbxxxxxx&amp;udpRequestTimeout=300&amp;udpRequestRetryNum=5&amp;p2pSessionTimeout=10000&amp;maxPortDetectNum=20&amp;packetsPerSecond=1\\\"}",
        "RelayDecryptKey": "{\"iv\":\"MDEy**********+Pw==\",\"key\":\"TuqB5bpZ+589v********==\"}"
    },
    "Code": 200,
    "Success": true
}

错误码

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