OpenSDK  V4.2.0
编程引导

开放SDK接口约束

一、AppKey:
开发者在开放平台申请应用后,针对每个开发者的应用,开放平台都会生一个对应的APP Key。详细请见开发者应用管理
二、AccessToken:
第三方私有云需要与萤石开平进行账号对接、认证才能获取开放平台授权的用户AccessToken,使用授权的AccessToken才能调用SDK接口进行预览、回放等功能。
根据开发者的开发模式不同,提供了两个获取AccessToken的基本方案,详见账户对接流程介绍(下载压缩包后打开)。
三、authAddr:
开放平台认证中心地址,国内默认地址为:https://openauth.ys7.com,海外默认地址为: https://openauth.ezvizlife.com, 对于开发者而言,请填写此默认地址即可。
四、openAddr:
开放平台后台地址,默认地址为:https://open.ys7.com,海外默认地址为: https://open.ezvizlife.com, 对于开发者而言,请填写此默认地址即可。

SDK接口主要调用流程

注:SDK接口全部定义在OpenNetStream.dll中,打包的其他库为该动态链接库的依赖库。调用接口前需要加载OpenNetStream.dll,建议使用动态加载。

main.jpg

分配会话功能用于分配一个处理资源,在多任务处理的情况下,每个任务都需要调用OpenSDK_AllocSession分配一个会话,否则将会出现无法预知的错误。分配会话的同时需要注册OpenSDK_MessageHandler类型的回调函数,该函数主要用于错误码的抛出和信息的回调。OpenSDK_StartSearch搜索录像返回的结果通过OpenSDK_MessageHandler回调函数返回。

认证模块:

at.jpg

一、 萤石账号通过中间页登陆。
二、 开发者不希望通过中间页的方式获取AccessToken,可以通过调用OpenSDK_HttpSendWithWait接口向平台发出请求,可以参考萤石平台接口使用说明文档》(最新版本)。
三、 B模式下,即AppKey申请者和登陆用户是属于同一个用户,直接通过《萤石平台接口使用说明文档》(最新版本)关于3.5第三方获取accessToken章节。
四、 C模式下,新接入的用户则需要使用短信验证码方式来开通萤石云服务,再通过《萤石平台接口使用说明文档》(最新版本)关于3.5第三方获取accessToken章节。
五、 下面所有的操作几乎都需要携带AccessToken,流程中不再重复该步骤。

预览模块:

rp.jpg

回放模块:

pb.jpg

对讲模块:

vt.jpg

设备操作模块:

do.jpg

数据模块:

da.jpg

报警模块:

al.jpg


使用萤石PC OpenSDK, 通过发送邮件到open-team.com申请pushSecret,用于接受设备端到客户端的报文消息推送,申请时请提供以下信息(*为必填):
① 环境(test2 /online)*
② 有效的appKey(开放平台注册),必须与环境对应*
③ 第三方应用名称*
④ 第三方应用描述(非必要)

报警模块和数据模块的报警列表是两种模式,报警模块是主动模式,当有报警发生时,会推送给回调函数;报警列表时被动获取模式,新报警的发送需要重新调用该接口获取。