接口说明
根据视频通道的通道编码和码流类型获取该通道的实时的RTSP流地址
支持H264、H265编码模式
前置条件
前置条件
端口必须通
wsplayer对接:ws:9100端口,wss:9102端口
dhplayer对接:固定端口9100
客户端正常播放
设备必须是视频设备
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.5及以上版本
视频业务系统V1.0.1及以上版本
接口版本
1.0.0
接口更新说明
无
接口URL
/evo-apigw/admin/API/MTS/Video/StartVideo
请求类型
POST
数据格式
application/json
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
data | true | Object | Json对象 |
+channelId | true | string | 视频通道编码,第一个$后数字代表通道类型,必须是1; 方式一:调设备通道分页查询接口 ,unitTypeList送[1]; 方式二:调设备树查询接口,type送;;1 |
+dataType | true | string | 视频类型:1=视频 |
+streamType | true | string | 码流类型:1=主码流,2=辅码流,3=辅码流2 |
请求参数示例
{
"data": {
"channelId": "1000018$1$0$0",
"dataType": "1",
"streamType": "1"
}
}
返回参数
名称 | 类型 | 说明 |
---|---|---|
code | int | 错误代码,code=1000代表成功,非1000代表失败,参考附录-错误码 |
desc | string | 结果描述 |
data | Object | Json对象 |
+token | string | RTSP令牌(有效时间30秒,请及时建立连接),仅能播放一次,失效后重新请求获取 |
+url | string | RTSP地址,完整的播放地址需拼接RTSP令牌访问,RTSP令牌为此接口返回的token字段; 以返回参数示例(无内外网映射:rtsp://10.35.239.81:9100/dss/monitor/param/cameraid=1000018%240%26substream=1)为例, 完整的播放地址:rtsp://10.35.239.81:9100/dss/monitor/param/cameraid=1000018%240%26substream=1?token=170 以返回参数示例(内外网映射:rtsp://10.55.36.202:9100/dss/monitor/param/cameraid=1001337%240%26substream=1|rtsp://115.236.17.59:9022/dss/monitor/param/cameraid=1001337%240%26substream=1)为例,根据竖线截取,选择响应网络地址,拼接token; 内网播放的完整地址:rtsp://10.55.36.202:9100/dss/monitor/param/cameraid=1001337%240%26substream=1?token=20004; 外网播放的完整地址:rtsp://115.236.17.59:9022/dss/monitor/param/cameraid=1001337%240%26substream=1?token=20004; |
+trackId | string | 轨道ID |
+minRate | string | (已废弃)最低码流,要求客户具备的最低码流 |
+protocol | string | (已废弃)协议:1=CNM3, 2=RTSP |
+ip | string | (已废弃)IP地址,根据类型可能是转发服务器IP,也可能是设备IP |
+port | string | (已废弃)端口 |
+stunEnable | string | (已废弃)是否支持STUN协议:1=支持, 0=不支持 |
+stunPort | string | (已废弃)STUN协议端口 |
+connectType | string | (已废弃)类型:1=转发模式,2=直连模式 |
+session | string | (已废弃)转发会话ID |
返回参数示例(成功)
{
"code": 1000,
"desc": "Success",
"data": {
"minRate": null,
"protocol": null,
"ip": null,
"port": null,
"stunEnable": null,
"stunPort": null,
"url": "rtsp://10.35.239.81:9100/dss/monitor/param/cameraid=1000018%240%26substream=1",
"connectType": null,
"session": "170",
"token": "170",
"trackId": null
}
}
返回参数示例(失败)
{
"code": 1001,
"desc": "Failed"
}
demo下载参考支持与服务->资源中心->资源下载下的开发demo页
集成方式 | 说明 | 在线参考网址 |
---|---|---|
H5播放器开发套件(wsplayer无插件开发包) | 无插件播放,无操作系统的限制 | wsplayer在线文档 |
插件式播放器开发套件(DHPlayer插件开发包) | 插件播放,仅支持win7/win8/win10/win11 | dhplayer在线文档 |
接口说明
开始语音对讲 同一个通道/设备同一时间点只能允许一个用户发起对讲,调接口会提示语音对讲中 一段时间后内不进行语音对讲会自动断开 接口支持情况与客户端一致 设备对讲与通道对讲: 1、NVR、DVR、EVS、IVSS 这些设备类型,默认走通道对讲(ICC客户端点击预览窗口的对讲,走的是通道对讲),也支持设备对讲(点击设备树右键-设备对讲,走的是设备对讲),支持:通道和设备两种对讲方式 2、其它设备类型,如IPC,则走设备对讲(ICC客户端点击预览窗口的对讲,走的是设备对讲),一般不走通道对讲(ICC客户端不支持) 国标设备(国标级联的和本级国标协议接入的):国标设备目前参数是固定的,走通道广播,deviceCode和channelSeq必传,talkType传2,talkMode传1,audioBit传16,audioType传2,sampleRate传8000
前置条件
请求头设置Authorization字段
端口必须通
wsplayer对接:ws:9100端口,wss:9102端口
dhplayer对接:固定端口9100
客户端正常对讲
设备必须是视频设备
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.5及以上版本
视频业务系统V1.0.1及以上版本
接口版本
1.0.0
接口更新说明
无
接口URL
/evo-apigw/admin/API/MTS/Audio/StartTalk
请求类型
POST
数据格式
application/json
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
data | true | Object | Json对象 |
+deviceCode | true | string | 设备编码,视频通道编码第一个$之前的内容; 获取视频通道编码方式一:调设备通道分页查询接口 ,unitTypeList送1,返回字段deviceCode; 获取视频通道编码方式二:调设备树查询接口,type送;;1 |
+talkType | true | string | 对讲类型:1=设备, 2=通道, 3=国标设备广播 ,设备对讲:设备对讲:设备通过设备管理添加到平台,通道对讲:设备作为通道集成到平台,一般是通过同步设备信息将通道同步到平台 |
+audioBit | true | string | 位数,固定:16 ,对讲时以接口返回为准 |
+audioType | true | string | 音频编码类型,推荐值:2,对讲时以接口返回为准 |
+broadcastChannels | false | string | 广播通道(广播对讲时使用) |
+sampleRate | true | string | 采样率,固定:8000 ,对讲时以接口返回为准 |
+talkMode | false | string | 对讲模式:0=对讲(默认模式), 1=广播(从广播切换到对讲要重新设置) |
+channelSeq | true | string | 通道序号(通道对讲时使用) |
除了deviceCode、talkType、talkmode、channelSeq,其他参数按照示例送,使用DHPlayer插件语音对讲时,以接口实际返回的audioType、audioBit、sampleRate为准
请求参数示例
{
"data": {
"deviceCode": "1002636",
"talkType": "1",
"audioBit": "16",
"audioType": "2",
"broadcastChannels": "",
"sampleRate": "8000",
"talkmode": "",
"channelSeq": "0"
}
}
返回参数
名称 | 类型 | 说明 |
---|---|---|
code | int | 错误代码,code=1000代表成功,非1000代表失败,参考附录-错误码 |
desc | string | 结果描述 |
data | Object | Json对象 |
+deviceCode | string | 设备编码 |
+url | string | RTSP地址,完整的播放地址需拼接RTSP令牌访问,RTSP令牌为此接口返回的token字段; ,例如rtsp://10.35.92.55:9100/talk/pu/2380?token=2 ,仅能播放一次,作为参数拼接url字段后,例如:rtsp://10.35.92.55:9100/talk/pu/2380?token=2;若存在内外网映射多个根据竖线截取 |
+token | string | RTSP令牌(有效时间30秒,请及时建立连接),仅能播放一次,失效后重新请求获取 |
+session | string | 语音对讲会话session,停止语音对讲时需要送此参数 |
+audioType | string | 音频编码类型,0=DEFAULT, 1=PCM, 2=G711a, 3=AMR, 4=G711u, 5=G726; 当前对讲url指定的对讲参数,如果和传参不一样,表示设备不支持传参中的对讲参数,自动选择设备支持的第一种对讲参数audioType |
+audioBit | string | 位数: 8 、16;用实际的值表示,如8位,则值为8 |
+sampleRate | string | 采样频率:8000、16000、32000、48000、8192 |
返回参数示例(成功)
{
"code": 1000,
"desc": "Success",
"data": {
"deviceCode": "1002636",
"url": "rtsp://124.160.33.135:4079/talk/pu/1019",
"token": "21",
"session": "1019",
"audioType": "2",
"audioBit": "16",
"sampleRate": "8000",
"protocolType": "2",
"innerIp": "10.10.8.5",
"stream": 1024,
"reachable": null,
"wssDirect": 0,
"gbDevice": 0
},
"success": true
}
返回参数示例(失败)
{
"code": 1001,
"desc": "Failed"
}
demo下载参考支持与服务->资源中心->资源下载下的开发demo页
集成方式 | 说明 | 在线参考网址 |
---|---|---|
H5播放器开发套件(wsplayer无插件开发包) | 无插件播放,无操作系统的限制 | wsplayer在线文档 |
插件式播放器开发套件(DHPlayer插件开发包) | 插件播放,仅支持win7/win8/win10/win11 | dhplayer在线文档 |
接口说明
根据开始语音对讲接口返回的session关闭语音对讲
前置条件
请求头设置Authorization字段
端口9100必须通
客户端正常停止语音对讲
设备必须是视频设备
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.5及以上版本
视频业务系统V1.0.1及以上版本
接口版本
1.0.0
接口更新说明
无
接口URL
/evo-apigw/admin/API/MTS/Audio/StopTalk
请求类型
POST
数据格式
application/json
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
data | true | Object | Json对象 |
+talkType | true | string | 对讲类型:1=设备, 2=通道, 3=国标设备广播 |
+deviceCode | true | string | 设备编码,视频通道编码第一个$之前的内容; 获取视频通道编码方式一:调设备通道分页查询接口 ,unitTypeList送1,返回字段deviceCode; 获取视频通道编码方式二:调设备树查询接口,type送;;1 |
+session | true | string | 会话ID,开始语音对讲接口返回字段 |
+channelSeq | false | string | 通道序号(通道对讲时使用) |
请求参数示例
{
"data": {
"talkType": "1",
"deviceCode": "1000040",
"session": "2380",
"channelSeq": ""
}
}
返回参数
名称 | 类型 | 说明 |
---|---|---|
code | int | 错误代码,code=1000代表成功,非1000代表失败,参考附录-错误码 |
desc | string | 结果描述 |
返回参数示例(成功)
{
"code": 1000,
"desc": "Success"
}
返回参数示例(失败)
{
"code": 1001,
"desc": "Failed"
}
接口说明
获取某视频通道的HLS、FLV和RTMP形式的实时拉流流地址
注意:RTMP实时拉流不支持智能编码,后端仅进行了URL的拼接工作,如果通过VLC播放失败,需要开发人员协助进行相关问题排查
实时拉流接口仅支持H264编码模式,不能播放时请先确认设备的编码模式
hlss表示使用https协议的HLS,flvs表示使用https协议的FLV
ws-flv表示使用ws协议的FLV,比http-flv支持路数多,http-flv类型仅支持6路,视频子系统1.1.4版本支持
wss-flv表示使用wss协议的FLV,比https-flv支持路数多,https-flv类型仅支持6路,视频子系统1.1.4版本支持
前置条件
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.12及以上版本
视频业务系统V1.1.2及以上版本
接口版本
1.0.0
接口更新说明
无
接口URL
/evo-apigw/admin/API/video/stream/realtime
请求类型
POST
数据格式
application/json
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
data | true | string | Json串 |
+channelId | true | string | 视频通道编码 |
+streamType | true | string | 码流类型:1=主码流, 2=辅码流,3=辅码流2 |
+type | true | string | 协议类型:hls,hlss,flv,flvs,ws_flv,wss_flv,rtmp hls:http协议,m3u8格式,端口7086; hlss:https协议,m3u8格式,端口是7096; flv:http协议,flv格式,端口7886; flvs:https协议,flv格式,端口是7896; ws_flv:ws协议,flv格式,端口是7886; wss_flv:wss协议,flv格式,端口是7896; rtmp:rtmp协议,端口是1975; |
请求参数示例
{
"data": {
"channelId": "1000067$1$0$0",
"streamType": "1",
"type": "hls"
}
}
返回参数
名称 | 类型 | 说明 |
---|---|---|
code | int | 错误代码,code=1000代表成功,非1000代表失败,参考附录-错误码 |
desc | string | 结果描述 |
data | string | Json串 |
+url | string | 拉流url,流地址需拼接?token=鉴权认证接口返回的access_token; hls示例:http://172.7.2.110:7086/live/cameraid/1000000%240/substream/1.m3u8?token=1:2cfa8e9b-e6c7-44d1-a676-6ae1cb9971e0 flv示例:http://172.7.2.110:7886/live/cameraid/1000000%240/substream/1.flv?token=1:2cfa8e9b-e6c7-44d1-a676-6ae1cb9971e0 ws-flv示例:ws://172.7.2.110:7886/live/cameraid/1000000%240/substream/1.flv?token=1:2cfa8e9b-e6c7-44d1-a676-6ae1cb9971e0 rtmp示例:rtmp://10.56.24.100:1975/live/cameraid=1004715%240;substream=1;token=1:2cfa8e9b-e6c7-44d1-a676-6ae1cb9971e0 |
hls返回参数示例(成功)
{
"code": 1000,
"desc": "Success",
"data": {
"url": "http://172.7.2.110:7086/live/cameraid/1000000%240/substream/1.m3u8"
}
}
flv返回参数示例(成功)
{
"code": 1000,
"desc": "Success",
"data": {
"url": "http://172.7.2.110:7886/live/cameraid/1000000%240/substream/1.flv"
}
}
ws-flv返回参数示例(成功)
{
"code": 1000,
"desc": "Success",
"data": {
"url": "ws://172.7.2.110:7886/live/cameraid/1000000%240/substream/1.flv"
}
}
rtmp返回参数示例(成功)
{
"code": 1000,
"desc": "Success",
"data": {
"url": "rtmp://10.56.24.100:1975/live/cameraid=1004715%240;substream=1"
}
}
返回参数示例(失败)
{
"code": 1001,
"desc": "Failed"
}
demo下载参考支持与服务->资源中心->资源下载下的开发demo页
集成方式 | 说明 | 在线参考网址 |
---|---|---|
HLS/FLV开发套件 | 无插件播放,无操作系统的限制 | 在线文档 |
播放示例说明
接口返回url需拼接?token=鉴权认证接口返回的access_token,若要取消拼接token,参考FAQHLS/FLV/RTMP取消拼接token配置;
设备编码模式必须是H264;
https播放需提供你安全证,按照HLS/FLV拉流https配置
无法播放参考FLV无法播放排查步骤
友商私有协议接入播放参考友商设备支持播放配置
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.12及以上版本
视频业务系统V1.1.2及以上版本
前置条件
请求头设置Authorization字段
7086/7096端口必须通
拼接规则
http(s)://平台IP:端口/live/cameraid/设备编码%24通道号/substream/码流类型.m3u8?token=鉴权token
字段说明
http端口:7086
https端口:7096(demo示例有证书错误,需技术支持配置忽略证书)
设备编码:平台上设备编码,视频通道编码第一个$符号之前的内容,做下urlencode;例如1000004$1$0$2,则设备编码为1000004;例如1000004@001$1$0$2,则设备编码为1000004%40001
通道号:设备下通道,从0(通道一)开始;视频通道编码最后一个$符号之后的内容,例如1000004$1$0$2,则通道号为2。
码流类型:1代表主码流,2代表辅码流
鉴权token:鉴权认证接口返回的access_token,若要取消拼接token,参考FAQHLS/FLV/RTMP取消拼接token配置中的HLS修改配置;
http流地址示例
http://20.2.42.185:7086/live/cameraid/1000004%242/substream/1.m3u8?token=1:2cfa8e9b-e6c7-44d1-a676-6ae1cb9971e0
https流地址示例
https://20.2.42.185:7096/live/cameraid/1000004%242/substream/1.m3u8?token=1:2cfa8e9b-e6c7-44d1-a676-6ae1cb9971e0
级联设备http流地址示例
http://20.2.42.185:7086/live/cameraid/1000004%40001%242/substream/1.m3u8?token=1:2cfa8e9b-e6c7-44d1-a676-6ae1cb9971e0
级联https流地址示例
https://20.2.42.185:7096/live/cameraid/1000004%40001%242/substream/1.m3u8?token=1:2cfa8e9b-e6c7-44d1-a676-6ae1cb9971e0
http取消token鉴权流地址示例
参考FAQ:HLS/FLV/RTMP取消拼接token配置中的HLS修改配置;
http://20.2.42.185:7086/live/cameraid/1000004%242/substream/1.m3u8
demo下载参考支持与服务->资源中心->资源下载下的开发demo页
集成方式 | 说明 | 在线参考网址 |
---|---|---|
HLS/FLV开发套件 | 无插件播放,无操作系统的限制 | 在线文档 |
播放示例说明
接口返回url需拼接?token=鉴权认证接口返回的access_token,若要取消拼接token,参考FAQHLS/FLV/RTMP取消拼接token配置;
设备编码模式必须是H264;
https播放需提供你安全证,按照HLS/FLV拉流https配置
无法播放参考FLV无法播放排查步骤
友商私有协议接入播放参考友商设备支持播放配置
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.12及以上版本
视频业务系统V1.1.2及以上版本
前置条件
请求头设置Authorization字段
7886/7896端口必须通
拼接规则
(协议类型)://平台IP:端口/live/cameraid/设备编码%24通道号/substream/码流类型.flv?token=鉴权token
字段说明
协议类型:http、https、ws、wss
http:端口默认7886,最大路数:6路
https:端口默认7896,最大路数:6路,https访问需导入安全证书
ws:端口默认7886,视频版本1.1.4支持
wss:端口默认7896,视频版本1.1.4支持,wss访问需导入安全证书
设备编码:平台上设备编码,视频通道编码第一个$符号之前的内容,做下urlencode;例如1000004$1$0$25,则设备编码为1000004例如1000004@001$1$0$25,则设备编码为1000004%40001
通道号:设备下通道,从0(通道一)开始;视频通道编码最后一个$符号之后的内容,例如1000004$1$0$25,则通道号为25。
码流类型:1代表主码流,2代表辅码流
鉴权token:鉴权认证接口返回的access_token,若要取消拼接token,参考FAQHLS/FLV/RTMP取消拼接token配置中的FLV修改配置;
http流地址示例
http://20.2.42.185:7886/live/cameraid/1000004%2425/substream/1.flv?token=1:2cfa8e9b-e6c7-44d1-a676-6ae1cb9971e0
https流地址示例
https://20.2.42.185:7896/live/cameraid/1000004%2425/substream/1.flv?token=1:2cfa8e9b-e6c7-44d1-a676-6ae1cb9971e0
ws流地址示例
ws://20.2.42.185:7886/live/cameraid/1000004%2425/substream/1.flv?token=1:2cfa8e9b-e6c7-44d1-a676-6ae1cb9971e0
wss流地址示例
wss://20.2.42.185:7896/live/cameraid/1000004%2425/substream/1.flv?token=1:2cfa8e9b-e6c7-44d1-a676-6ae1cb9971e0
级联设备http流地址示例
http://20.2.42.185:7886/live/cameraid/1000004%40001%2425/substream/1.flv?token=1:2cfa8e9b-e6c7-44d1-a676-6ae1cb9971e0
级联https流地址示例
http://20.2.42.185:7896/live/cameraid/1000004%40001%2425/substream/1.flv?token=1:2cfa8e9b-e6c7-44d1-a676-6ae1cb9971e0
http取消token鉴权流地址示例
参考FAQ:HLS/FLV/RTMP取消拼接token配置中的HLS修改配置;
http://20.2.42.185:7886/live/cameraid/1000004%2425/substream/1.flv
demo下载参考支持与服务->资源中心->资源下载下的开发demo页
集成方式 | 说明 | 在线参考网址 |
---|---|---|
HLS/FLV开发套件 | 无插件播放,无操作系统的限制 | 在线文档 |
播放示例说明
接口返回url需拼接?token=鉴权认证接口返回的access_token,若要取消拼接token,参考FAQHLS/FLV/RTMP取消拼接token配置;
设备编码模式必须是H264;
https播放需提供你安全证,按照HLS/FLV拉流https配置
无法播放参考FLV无法播放排查步骤
友商私有协议接入播放参考友商设备支持播放配置
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.12及以上版本
视频业务系统V1.1.2及以上版本
前置条件
请求头设置Authorization字段
1975端口必须通
拼接规则
rtmp://平台IP:端口/live/cameraid=设备编码%24通道号;substream=码流类型;token=鉴权token
字段说明
端口:1975
设备编码:平台上设备编码,视频通道编码第一个$符号之前的内容,做下urlencode;例如1000004$1$0$26,则设备编码为1000004;例如1001337@001$1$0$0,则设备编码为1001337%40001
通道号:设备下通道,从0(通道一)开始;视频通道编码最后一个$符号之后的内容,例如1000004$1$0$26,则通道号为26。
码流类型:1代表主码流,2代表辅码流
鉴权token:鉴权认证接口返回的access_token,若要取消拼接token,参考FAQHLS/FLV/RTMP取消拼接token配置中的HLS修改配置;
本级拉流拼接示例
rtmp://10.35.239.168:1975/live/cameraid=1001337%2426;substream=1;token=1:2cfa8e9b-e6c7-44d1-a676-6ae1cb9971e0
级联设备拉流拼接示例
rtmp://10.35.239.168:1975/live/cameraid=1001337%40001%240;substream=1;token=1:2cfa8e9b-e6c7-44d1-a676-6ae1cb9971e0
http取消token鉴权流地址示例
参考FAQ:HLS/FLV/RTMP取消拼接token配置中的HLS修改配置;
rtmp://10.35.239.168:1975/live/cameraid=1001337%40001%240;substream=1
播放示例说明
接口返回url需拼接?token=鉴权认证接口返回的access_token,若要取消拼接token,参考FAQHLS/FLV/RTMP取消拼接token配置;
设备编码模式必须是H264;
无法播放参考RTMP无法播放排查步骤
友商私有协议接入播放参考友商设备支持播放配置