ezvizandroidsdkhelpWord文档下载推荐.docx

1、3. 解决目前录像分片段的问题2.02015-01-071. 添加设备成功后发送广播2. 修复一些缺陷2.12015-03-121. 增加视频广场系列接口2.32015-04-131. 报警设置已读2. 获取单个设备信息3. 公共视频广场系列接口4. 对内账户系列接口5. 修复一些缺陷2.52015-05-121. 增加局域网发现添加设备功能2. 增加局域网本地预览功能3. 修复一些缺陷2.62015-06-101. 修改SDK初始化接口2. 调整设备wifi配置接口3. 增加SDK透传接口4. 修复消息录像回放缺陷SDK 设计目的方便第三方开发人员接入萤石设备进行应用开发。SDK 设计概述采

2、用MVC框架现实，封装model层和controller层代码,开发人员可以直接采用我们开源的view层或自定义来实现UI。SDK相关API设计应用SDK配置1. 新建android app工程2. 导入ezviz-openapi-android-sdk.jar（拷贝到libs/下）3. 拷贝lib*.so到libs/armeabi/4. 设置AndroidManifest.xml权限： android.permission.GET_TASKSandroid.permission.INTERNETandroid.permission.WAKE_LOCKandroid.permission.AC

3、CESS_NETWORK_STATEandroid.permission.WRITE_OWNER_DATAandroid.permission.CAMERAandroid.permission.VIBRATEandroid.permission.FLASHLIGHTandroid.permission.RECORD_AUDIOandroid.permission.READ_PHONE_STATEandroid.permission.RECEIVE_BOOT_COMPLETEDandroid.permission.MOUNT_UNMOUNT_FILESYSTEMSandroid.permissi

4、on.WRITE_EXTERNAL_STORAGEandroid.permission.ACCESS_COARSE_LOCATIONandroid.permission.ACCESS_FINE_LOCATIONandroid.permission.ACCESS_WIFI_STATEandroid.permission.CHANGE_WIFI_STATEandroid.permission.READ_LOGSandroid.permission.SYSTEM_ALERT_WINDOW/activity 用于sdk中间页显示，包含登录、设备添加、设备操作等页面receiver.EzvizBroad

5、castReceiverexported=falseintent-filteraction android:com.vedeogo.action.OAUTH_SUCCESS_ACTION.conn.CONNECTIVITY_CHANGE/intent-filter/receiver用于接收网络变化刷新SDK网络状态，接收中间页登录成功消息启动其他界面5. 获取摄像头列表，报警信息查询，云录像搜索、删除设备、预览和回放等功能详细示例请看demo，具体API请看以下接口说明SDK初始化：在应用Application的onCreate回调函数中初始化SDK/正式平台设置EzvizAPI.init（t

6、his, APP_KEY）; /设置APP_KEYEzvizAPI.getInstance（）.setServerUrl（API_URL, WEB_URL）; /设置api地址auth地址/自定义so库路径初始化EzvizAPI.init （Application application, String appKey, String loadLibraryAbsPath）；接口都在类com.videogo.openapi.EzvizAPI中，详细接口说明如下：应用登录：void gotoLoginPage（）;该接口用于应用打开登录中间页登录成功后发送播放com.videogo.action.

7、OAUTH_SUCCESS_ACTION应用注销：void logout（）;该接口用于应用清空登录信息获取短信验证码：void getSmsCode（int type, String sign）;该接口用于应用获取短信验证码参数type为短信类型（1,获取用户accessToken；2,硬件特征码校验）参数sign为请求签名字符串验证短信验证码：void verifySmsCode（int type, String userId, String phone, String smsCode）;该接口用于应用验证短信验证码参数userId为第三用户ID参数phone为手机号码参数smsCode为

8、短信验证码设置第三方token：void setThridToken（String thridToken）;该参数属于保留字段，用于后期扩展，暂时不需要设置值设备添加：void gotoAddDevicePage（）;该接口用于应用打开设备添加中间页void gotoAddDevicePage（String deviceSerial, String code）;该接口用于应用打开设备添加中间页，并传递设备二维码信息参数deviceId为设备id，code为设备验证码 添加成功后发送播放com.videogo.action.ADD_DEVICE_SUCCESS_ACTION设备操作：void g

9、otoSetDevicePage（String deviceId）;该接口用于应用打开设备操作中间页参数deviceId为设备id，获取摄像头列表接口获得的数据，详细请参考demo或者OpenAPI接口：透传接口：String transferAPI（final String _reqStr）；该接口用于透传平台Restful API，参数和返回请参见平台接口文档设备管理接口：获取摄像头列表：List getCameraInfoList（GetCameraInfoList getCameraInfoList）;该接口用于应用获取摄像头列表参数GetCameraInfoList：KeyValue

10、TypeUrl EncodeedOptiionnal备注pageStartint分页起始页，从0开始pageSize分页大小返回CameraInfo列表，CameraInfo属性如下：deviceId:设备唯一标识，用户设备表的主键cameraId:camera表的主键cameraNo：设备的通道号cameraName:通道名称status:是否在线 0：不在线 1：在线display:是否显示 0：不显示 1：显示isShared：分享状态picUrl:图片地址（大图）isEncrypt: 是否加密 0：未加密，1：已加密详细请参考demo或者OpenAPI接口：删除设备：void dele

11、teDevice（String deviceId）;该接口用于应用删除设备报警信息查询：AlarmInfo getAlarmInfoList（GetAlarmInfoList getAlarmInfoList）;该接口用于应用获取报警信息列表参数GetAlarmInfoList：cameraIdStringyesno通道唯一标识startTime报警查询开始时间时间格式为：2013-09-05 09:38:48endTime报警查询结束时间时间格式为：alarmType报警类型status报警消息状态，2：所有，1：已读，0：未读返回AlarmInfo列表，AlarmInfo属性如下：alar

12、mId: 主键idalarmName: 报警源名称alarmType:alarmStart:报警开始时间云录像搜索：CloudFile getCloudFileList（GetCloudFileList getCloudFileList）;该接口用于应用获取云录像列表参数GetCloudFileList：通道id开始时间时间格式为：结束时间时间格式为：返回CloudFile列表，CloudFile属性如下：fileId: 文件IDstartTime:开始时间stopTime:结束时间获取摄像头截屏：String getCameraSnapshot（String cameraId）;该接口用于获

13、取摄像头截屏参数cameraId为摄像头ID获取单个摄像头信息：CameraInfo getCameraInfo（int cameraNo, String deviceSerial）;该接口用于获取单个摄像头信息参数如下：cameraNo设备通道号deviceSerial设备序列号返回CameraInfo，属性同上获取摄像头UUID录像信息：VideoInfo getDeviceVideoInfo（String uuid）;该接口用于获取摄像头UUID录像信息参数uuid为录像UUID,通过平台获取返回VideoInfo，属性如下：uuid: 录像UUID获取摄像头UUID图片地址：Strin

14、g getDevicePicture（String uuid, int x）;该接口用于获取摄像头UUID图片地址参数uuid为图片UUID,通过平台获取参数x为图片大小（宽度，单位：像素 区间：（0,1280）返回图片地址，如果图片加密，请按照demo下载报警设置已读：boolean setAlarmRead（String alarmId）;该接口用于设置报警已读，参数alarmId为报警id返回true为设置成功，false为设置失败获取单个设备信息：DeviceInfo getDeviceInfo（String deviceSerial）;该接口用于单个设备信息，参数deviceSeri

15、al为设备序列号返回设备信息DeviceInfo，属性如下：deviceId设备id通道号cameraName是否在线，0：不在线，1：isShared分享状态，0：不分享，1：分享picUrl封面地址isEncrypt是否加密，0：不加密，1：加密视频广场接口：获取视频广场栏位：SquareColumnInfo getSquareColumn（）;该接口用于应用获取视频广场栏位列表返回SquareColumnInfo列表，SquareColumnInfo属性如下:字段类型说明channelCode频道值channelName频道名称channelLevel频道级别parentId父频道值sh

16、owFlag显示顺序【升序】根据栏位获取视频列表：SquareVideoInfo getSquareVideoList（GetSquareVideoInfoList getSquareVideoInfoList）;该接口用于应用根据栏位获取视频列表参数GetSquareVideoInfoList：是否必填channel否广场频道id返回SquareVideoInfo列表，SquareVideoInfo属性如下:address地址commentCount评论数coverUrl视频封面likeCount点赞数playUrl视频播放地址title视频标题viewedCount观看次数获取公共视频广场

17、资源： searchSquareVideo（SearchSquareVideoInfo searchSquareVideoInfo）;该接口用于应用获取公共视频资源列表参数SearchSquareVideoInfo：OptionnalbelongType0:获取视频广场公共资源1:获取appkey对应管理员发布到视频广场的资源longitude经度latitude维度range范围thirdComment第三方扩展字段视频名称viewSort是否按观看次数排序：0：不排序，1：降序排序cameraNameSort是否按视频名称排序：rangeSort是否按照距离由近及远排序，0：排序栏目返回S

18、quareVideoInfo列表, SquareVideoInfo属性同上收藏公共视频广场资源：boolean favoriteSquareVideo（int squareId）;该接口用于应用收藏公共视频广场资源参数squareId为公共视频广场视频ID取消公共视频广场资源收藏：boolean cancelSquareVideoFavorite（int squareId）;该接口用于应用取消公共视频广场资源收藏获取收藏的公共视频资源： getSquareVideoFavorite（int pageStart, int pageSize）;该接口用于应用获取收藏的公共视频资源列表，参数如下：判

19、断视频资源是否被收藏：String checkSquareVideoFavorite（String squareIds）;返回被收藏的列表，属性如下：squareId视频广场id注：批量传squareId用逗号隔开预览和回放接口：预览接入流程：1. 创建预览任务处理对象RealPlayerHelper（com.videogo.realplay. RealPlayerHelper）mRealPlayerHelper = RealPlayerHelper.getInstance（application）;2. 创建预览管理对象RealPlayerManager（com.videogo.realpl

20、ay. RealPlayerManager）mRealPlayMgr = new RealPlayerManager（this）;3. 设置视频显示控件mRealPlayMgr.setPlaySurface（mRealPlaySh）;/SurfaceView创建后设置mRealPlayMgr.setPlaySurface（null）;/ SurfaceView销毁后设置4. 任务消息接收和处理mRealPlayMgr.setHandler（mHandler）;/设备Handler接收消息boolean handleMessage（Message msg）;/回调函数处理消息5. 设置声音开关mRealPlayMgr.isSoundOpen（）判断声音是否开启mRealPlayMgr.openSound （）；/开启声音mRealPlayMgr.closeSound （）；/关闭声音6.