文档首页/ 行业视频管理服务 IVM/ API参考/ 媒体播放管理（媒体管理的接口需搭配SDK使用）/ 【旧】批量获取设备实况播放地址
更新时间：2024-09-11 GMT+08:00
查看PDF
分享

【旧】批量获取设备实况播放地址

功能介绍

批量获取设备实况播放地址

备注：播放实况需要将表5中的live_url输入到播放地址栏

URI

POST /v1/{user_id}/devices/channels/cloud-live/url

表1 路径参数

参数

是否必选

参数类型

描述

user_id

是

String

用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Access-Token

是

String

用户认证AccessToken：从获取用户北向接口认证AccessToken中获取
表3 请求Body参数

参数

是否必选

参数类型

描述

channels

是

Array of GetLiveURLChannelsParam objects

通道列表

expire_time

否

Integer

自定义Url过期时间：时间范围[30, 86400]，不传默认为 30（单位/秒）

备注：仅对channels中的live_url有效

use_times

否

Integer

自定义Url使用次数：枚举类型，不填写时默认值为 0，RTSP协议固定为 0

备注：仅对channels中的live_url有效

枚举值：

  • 0 使用一次
  • 1 有效时间内任意使用，此参数对RTSP协议无效
表4 GetLiveURLChannelsParam

参数

是否必选

参数类型

描述

device_id

是

String

设备ID：

好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取

国标设备：由数字组成，长度固定为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型

channel_id

是

String

通道ID：

好望设备：取值范围[0,999]

国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取

live_protocol

是

String

媒体播放协议：枚举类型，选择获取地址的媒体播放协议类型

枚举值：

  • HOLO 好望协议

  • HLS 基于HTTP的HLS流媒体传输协议（该协议存在安全风险，建议优先使用其他协议）
  • HLS_HTTPS 基于HTTPS的HLS流媒体传输协议
  • HTTP_FLV 基于HTTP的FLV媒体协议（该协议存在安全风险，建议优先使用其他协议）
  • HTTPS_FLV 基于HTTPS的FLV媒体协议
  • RTSP RTSP流媒体传输协议（该协议存在安全风险，建议优先使用其他协议）

stream_type

是

String

码流类型：枚举类型

枚举值：

  • PRIMARY_STREAM 主码流

  • SECONDARY_STREAM_1 子码流1

  • SECONDARY_STREAM_2 子码流2

forbid_audio

否

Integer

禁用音频选项：不填写默认值为 0

备注：只针对HLS有效，推荐微信小程序端使用禁用音频选项

枚举值：

  • 0 不禁用音频

  • 1 禁用音频

trans_protocol

否

String

传输协议：枚举类型，不填写时默认值为 TCP，仅适用于gb28181，其它接入协议无效

枚举值：

  • TCP TCP传输协议
  • UDP UDP传输协议

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

fail_num

Integer

获取设备url失败的数量

channels

Array of getLiveURLChannelsResp objects

响应信息

request_id

String

该请求的记录id
表6 getLiveURLChannelsResp

参数

参数类型

描述

device_id

String

设备ID：设备唯一标识，长度范围[1,32]

channel_id

String

通道ID：长度范围[1,20]

live_url

String

媒体实况播放地址：将此url输入播放地址栏开始播放

result

Result object

错误信息
表7 Result

参数

参数类型

描述

code

String

错误编码：请参见错误码

msg

String

错误信息

请求示例

查询通道实况播放地址

POST /v1/2562572829***/devices/channels/cloud-live/url

{
  "channels": [
    {
      "device_id": "952352LWXT***",
      "channel_id": "0",
      "live_protocol": "HOLO",
      "stream_type": "PRIMARY_STREAM"
    },
   {
      "forbid_audio":1,
      "device_id": "952352DJNR***",
      "channel_id": "0",
      "live_protocol": "HLS",
      "stream_type": "PRIMARY_STREAM"
    },
   {
      "device_id": "952352DJNR***",
      "channel_id": "0",
      "live_protocol": "HLS_HTTPS",
      "stream_type": "PRIMARY_STREAM"
    }]
}

响应示例

状态码： 200

OK

{
  "fail_num": 0,
  "channels": [
    {
      "device_id": "952352LWXT***",
      "channel_id": "0",
      "live_url": "jvmp://123.123.*.*:***/live/952352LWXT***?token=...",
      "result": {
        "code": "IVM.0",
        "msg": "Success"
      }
    },
    {
      "device_id": "952352DJNR***",
      "channel_id": "0",
      "live_url": "http://123.123.*.*:***/live/live.m3u8?token=...&device_id=952352DJNR***&channel_id=0&stream_type=0&forbid_audio=1",
      "result": {
        "code": "IVM.0",
        "msg": "Success"
      }
    },
    {
      "device_id": "952352DJNR***",
      "channel_id": "0",
      "live_url": "https://123.123.*.*:***/live/live.m3u8?token=...&device_id=952352DJNR***&channel_id=0&stream_type=0",
      "result": {
        "code": "IVM.0",
        "msg": "Success"
      }
    }
  ],
  "request_id": "0e3515f7-4c5e-497f-abb8-4541d6963dd2"
}

状态码

请参见状态码

错误码

请参见错误码

相关文档