获取设备实时视频取流URL。

调试

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

请求参数

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

系统规定参数。取值:GetDeviceLiveUrl

CorpId String 10001****

设备对应的项目ID

DeviceId String 0757740611131545****

设备ID

StreamType String 1

视频流选择,枚举值:

1:主流

2:子流

注:国标协议设备不支持,仅SAPI协议设备支持。

OutProtocol String hls

视频流协议:hls、rtmp、rtsp、httpsflv、httpshls。

默认hls。

GbId String 0757740611131545****

已废弃。即 DeviceId。

返回数据

名称 类型 示例值 描述
RequestId String 46329898-489C-4E63-9BA1-C1DA5C5D0986

请求ID

Code String 200

返回结果编码

200:获取成功

Failed:获取失败

Retry:按需拉流模式,正在建立取流连接,请稍后重试

Message String Success

返回结果消息

OutProtocol String hls

视频流协议:hls、rtmp、rtsp、httpsflv、httpshls。

StreamType Long 1

视频流选择,1:主流, 2:子流。

Url String http://example.com/xxx

返回的视频播放URL。

示例

请求示例

http(s)://[Endpoint]/?Action=GetDeviceLiveUrl
&CorpId=10001****
&DeviceId=0757740611131545****
&StreamType=1
&OutProtocol=hls
&GbId=0757740611131545****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetDeviceLiveUrlResponse>
    <RequestId>46329898-489C-4E63-9BA1-C1DA5C5D0986</RequestId>
    <Code>200</Code>
    <Message>Success</Message>
    <OutProtocol>hls</OutProtocol>
    <StreamType>1</StreamType>
    <Url>http://example.com/xxx</Url>
</GetDeviceLiveUrlResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "46329898-489C-4E63-9BA1-C1DA5C5D0986",
  "Code" : "200",
  "Message" : "Success",
  "OutProtocol" : "hls",
  "StreamType" : 1,
  "Url" : "http://example.com/xxx"
}

错误码

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