ezvizandroidsdkhelp.docx
- 文档编号:9563415
- 上传时间:2023-02-05
- 格式:DOCX
- 页数:27
- 大小:45.76KB
ezvizandroidsdkhelp.docx
《ezvizandroidsdkhelp.docx》由会员分享,可在线阅读,更多相关《ezvizandroidsdkhelp.docx(27页珍藏版)》请在冰豆网上搜索。
ezvizandroidsdkhelp
萤石云视频AndroidSDK接口使用说明
版本:
V2.6合作伙伴交流使用(请勿外传)
版本
日期
修改人
修改原因
1.0
2014-07-21
星仔
1.创建
1.1
2014-08-01
星仔
1.增加报警推送
1.2
2014-08-12
星仔
1.录像sd卡搜索返回时间片段
2.预览/回放密码框实现
1.3
2014-09-02
星仔
1.增加获取摄像头截屏接口
2.支持二维码扫描添加设备
1.4
2014-10-23
星仔
1.获取单个摄像头信息
2.获取摄像头UUID录像信息
3.获取摄像头UUID图片地址
4.修复一些缺陷
1.5
2014-10-30
星仔
1.修复一些缺陷
1.6
2014-11-06
星仔
1.获取摄像头UUID图片地址接口增加图片大小设置
2.获取摄像头信息增加是否加密字段
1.7
2014-11-22
星仔
1.增加摄像头wifi一键配置功能
2.增加视频广场播放功能
1.8
2014-12-18
星仔
1.私有云后台对接授权登录
2.设备操作中间页支持设备固件升级
3.解决目前录像分片段的问题
2.0
2015-01-07
星仔
1.添加设备成功后发送广播
2.修复一些缺陷
2.1
2015-03-12
星仔
1.增加视频广场系列接口
2.修复一些缺陷
2.3
2015-04-13
星仔
1.报警设置已读
2.获取单个设备信息
3.公共视频广场系列接口
4.对内账户系列接口
5.修复一些缺陷
2.5
2015-05-12
星仔
1.增加局域网发现添加设备功能
2.增加局域网本地预览功能
3.修复一些缺陷
2.6
2015-06-10
星仔
1.修改SDK初始化接口
2.调整设备wifi配置接口
3.增加SDK透传接口
4.修复消息录像回放缺陷
SDK设计目的
方便第三方开发人员接入萤石设备进行应用开发。
SDK设计概述
采用MVC框架现实,封装model层和controller层代码,开发人员可以直接采用我们开源的view层或自定义来实现UI。
SDK相关API设计
应用SDK配置
1.新建androidapp工程
2.导入ezviz-openapi-android-sdk.jar(拷贝到libs/下)
3.拷贝lib*.so到libs/armeabi/
4.设置AndroidManifest.xml
权限:
name="android.permission.RESTART_PACKAGES"/> name="android.permission.GET_TASKS"/> name="android.permission.INTERNET"/> name="android.permission.WAKE_LOCK"/> name="android.permission.ACCESS_NETWORK_STATE"/> name="android.permission.WRITE_OWNER_DATA"/> name="android.permission.CAMERA"/> name="android.permission.VIBRATE"/> name="android.permission.FLASHLIGHT"/> name="android.permission.RECORD_AUDIO"/> name="android.permission.READ_PHONE_STATE"/> name="android.permission.RECEIVE_BOOT_COMPLETED"/> name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/> name="android.permission.WRITE_EXTERNAL_STORAGE"/> name="android.permission.ACCESS_COARSE_LOCATION"/> name="android.permission.ACCESS_FINE_LOCATION"/> name="android.permission.ACCESS_WIFI_STATE"/> name="android.permission.CHANGE_WIFI_STATE"/> name="android.permission.READ_LOGS"/> name="android.permission.SYSTEM_ALERT_WINDOW"/> name="android.permission.CHANGE_CONFIGURATION"/> 其余权限请参看demo或者OpenAPI接口: 应用组件: android: name=".main.EzvizWebViewActivity" android: configChanges="orientation|keyboardHidden" android: screenOrientation="portrait"> 用于sdk中间页显示,包含登录、设备添加、设备操作等页面 android: name=".EzvizBroadcastReceiver" android: exported="false"> name="com.vedeogo.action.OAUTH_SUCCESS_ACTION"/> name=".conn.CONNECTIVITY_CHANGE"/> 用于接收网络变化刷新SDK网络状态,接收中间页登录成功消息启动其他界面 其余权限请参看demo或者OpenAPI接口: 5.获取摄像头列表,报警信息查询,云录像搜索、删除设备、预览和回放等功能 详细示例请看demo,具体API请看以下接口说明 SDK初始化: 在应用Application的onCreate回调函数中初始化SDK //正式平台设置 EzvizAPI.init(this,APP_KEY);//设置APP_KEY EzvizAPI.getInstance().setServerUrl(API_URL,WEB_URL);//设置api地址auth地址 //自定义so库路径初始化 EzvizAPI.init(Applicationapplication,StringappKey,StringloadLibraryAbsPath); 接口都在类com.videogo.openapi.EzvizAPI中,详细接口说明如下: 应用登录: voidgotoLoginPage(); 该接口用于应用打开登录中间页 登录成功后发送播放com.videogo.action.OAUTH_SUCCESS_ACTION 应用注销: voidlogout(); 该接口用于应用清空登录信息 获取短信验证码: voidgetSmsCode(inttype,Stringsign); 该接口用于应用获取短信验证码 参数type为短信类型(1,获取用户accessToken;2,硬件特征码校验) 参数sign为请求签名字符串 验证短信验证码: voidverifySmsCode(inttype,StringuserId,Stringphone,StringsmsCode); 该接口用于应用验证短信验证码 参数type为短信类型(1,获取用户accessToken;2,硬件特征码校验) 参数userId为第三用户ID 参数phone为手机号码 参数smsCode为短信验证码 设置第三方token: voidsetThridToken(StringthridToken); 该参数属于保留字段,用于后期扩展,暂时不需要设置值 设备添加: voidgotoAddDevicePage(); 该接口用于应用打开设备添加中间页 voidgotoAddDevicePage(StringdeviceSerial,Stringcode); 该接口用于应用打开设备添加中间页,并传递设备二维码信息 参数deviceId为设备id,code为设备验证码 添加成功后发送播放com.videogo.action.ADD_DEVICE_SUCCESS_ACTION 设备操作: voidgotoSetDevicePage(StringdeviceId); 该接口用于应用打开设备操作中间页 参数deviceId为设备id,获取摄像头列表接口获得的数据,详细请参考demo或者OpenAPI接口: 透传接口: StringtransferAPI(finalString_reqStr); 该接口用于透传平台RestfulAPI,参数和返回请参见平台接口文档 设备管理接口: 获取摄像头列表: List 该接口用于应用获取摄像头列表 参数GetCameraInfoList: Key Value Type UrlEncodeed Optiionnal 备注 pageStart int 分页起始页,从0开始 pageSize int 分页大小 返回CameraInfo列表,CameraInfo属性如下: deviceId: 设备唯一标识,用户设备表的主键 cameraId: camera表的主键 cameraNo: 设备的通道号 cameraName: 通道名称 status: 是否在线0: 不在线1: 在线 display: 是否显示0: 不显示1: 显示 isShared: 分享状态 picUrl: 图片地址(大图) isEncrypt: 是否加密0: 未加密,1: 已加密 详细请参考demo或者OpenAPI接口: 删除设备: voiddeleteDevice(StringdeviceId); 该接口用于应用删除设备 参数deviceId为设备id,获取摄像头列表接口获得的数据,详细请参考demo或者OpenAPI接口: 报警信息查询: List 该接口用于应用获取报警信息列表 参数GetAlarmInfoList: Key Value Type UrlEncodeed Optiionnal 备注 cameraId String yes no 通道唯一标识 startTime String yes no 报警查询开始时间时间格式为: 2013-09-0509: 38: 48 endTime String yes no 报警查询结束时间时间格式为: 2013-09-0509: 38: 48 alarmType int yes no 报警类型 status int yes no 报警消息状态,2: 所有,1: 已读,0: 未读 pageStart int 分页起始页,从0开始 pageSize int 分页大小 返回AlarmInfo列表,AlarmInfo属性如下: alarmId: 主键id alarmName: 报警源名称 alarmType: 报警类型 alarmStart: 报警开始时间 云录像搜索: List 该接口用于应用获取云录像列表 参数GetCloudFileList: Key Value Type UrlEncodeed Optiionnal 备注 cameraId String yes no 通道id startTime String no no 开始时间时间格式为: 2013-09-0509: 38: 48 endTime String no no 结束时间时间格式为: 2013-09-0509: 38: 48 pageStart int 分页起始页,从0开始 pageSize int 分页大小 返回CloudFile列表,CloudFile属性如下: fileId: 文件ID startTime: 开始时间 stopTime: 结束时间 获取摄像头截屏: StringgetCameraSnapshot(StringcameraId); 该接口用于获取摄像头截屏 参数cameraId为摄像头ID 获取单个摄像头信息: CameraInfogetCameraInfo(intcameraNo,StringdeviceSerial); 该接口用于获取单个摄像头信息 参数如下: Key Value Type UrlEncodeed Optiionnal 备注 cameraNo int yes no 设备通道号 deviceSerial String yes no 设备序列号 返回CameraInfo,属性同上 获取摄像头UUID录像信息: VideoInfogetDeviceVideoInfo(Stringuuid); 该接口用于获取摄像头UUID录像信息 参数uuid为录像UUID,通过平台获取 返回VideoInfo,属性如下: uuid: 录像UUID startTime: 开始时间 stopTime: 结束时间 获取摄像头UUID图片地址: StringgetDevicePicture(Stringuuid,intx); 该接口用于获取摄像头UUID图片地址 参数uuid为图片UUID,通过平台获取 参数x为图片大小(宽度,单位: 像素区间: (0,1280]) 返回图片地址,如果图片加密,请按照demo下载 报警设置已读: booleansetAlarmRead(StringalarmId); 该接口用于设置报警已读,参数alarmId为报警id 返回true为设置成功,false为设置失败 获取单个设备信息: DeviceInfogetDeviceInfo(StringdeviceSerial); 该接口用于单个设备信息,参数deviceSerial为设备序列号 返回设备信息DeviceInfo,属性如下: deviceId 设备id deviceSerial 设备序列号 cameraId 通道id cameraNo 通道号 cameraName 通道名称 status 是否在线,0: 不在线,1: 在线 isShared 分享状态,0: 不分享,1: 分享 picUrl 封面地址 isEncrypt 是否加密,0: 不加密,1: 加密 视频广场接口: 获取视频广场栏位: List 该接口用于应用获取视频广场栏位列表 返回SquareColumnInfo列表,SquareColumnInfo属性如下: 字段 类型 说明 channelCode String 频道值 channelName String 频道名称 channelLevel String 频道级别 parentId String 父频道值 showFlag String 显示顺序【升序】 根据栏位获取视频列表: List GetSquareVideoInfoListgetSquareVideoInfoList); 该接口用于应用根据栏位获取视频列表 参数GetSquareVideoInfoList: 字段 类型 是否必填 说明 channel int 否 广场频道id pageSize int 否 分页起始页,从0开始 pageStart int 否 分页大小 返回SquareVideoInfo列表,SquareVideoInfo属性如下: 字段 类型 说明 address String 地址 commentCount int 评论数 coverUrl String 视频封面 likeCount int 点赞数 playUrl String 视频播放地址 title String 视频标题 viewedCount int 观看次数 获取公共视频广场资源: List SearchSquareVideoInfosearchSquareVideoInfo); 该接口用于应用获取公共视频资源列表 参数SearchSquareVideoInfo: Key Type Optionnal 备注 belongType String no 0: 获取视频广场公共资源 1: 获取appkey对应管理员发布到视频广场的资源 longitude String yes 经度 latitude String yes 维度 range String yes 范围 thirdComment String yes 第三方扩展字段 cameraName String yes 视频名称 viewSort int no 是否按观看次数排序: 0: 不排序,1: 降序排序 cameraNameSort int no 是否按视频名称排序: 0: 不排序,1: 降序排序 rangeSort int no 是否按照距离由近及远排序,0: 不排序,1: 排序 pageStart int no 分页起始页,从0开始 pageSize int no 分页大小 channel int yes 栏目 返回SquareVideoInfo列表,SquareVideoInfo属性同上 收藏公共视频广场资源: booleanfavoriteSquareVideo(intsquareId); 该接口用于应用收藏公共视频广场资源 参数squareId为公共视频广场视频ID 取消公共视频广场资源收藏: booleancancelSquareVideoFavorite(intsquareId); 该接口用于应用取消公共视频广场资源收藏 参数squareId为公共视频广场视频ID 获取收藏的公共视频资源: List intpageStart,intpageSize); 该接口用于应用获取收藏的公共视频资源列表,参数如下: Key Type Optionnal 备注 pageStart int no 分页起始页,从0开始 pageSize int no 分页大小 返回SquareVideoInfo列表,SquareVideoInfo属性同上 判断视频资源是否被收藏: StringcheckSquareVideoFavorite(StringsquareIds); 返回被收藏的列表,属性如下: squareId 视频广场id 注: 批量传squareId用逗号隔开 预览和回放接口: 预览接入流程: 1.创建预览任务处理对象RealPlayerHelper(com.videogo.realplay.RealPlayerHelper) mRealPlayerHelper=RealPlayerHelper.getInstance(application); 2.创建预览管理对象RealPlayerManager(com.videogo.realplay.RealPlayerManager) mRealPlayMgr=newRealPlayerManager(this); 3.设置视频显示控件 mRealPlayMgr.setPlaySurface(mRealPlaySh);//SurfaceView创建后设置 mRealPlayMgr.setPlaySurface(null);//SurfaceView销毁后设置 4.任务消息接收和处理 mRealPlayMgr.setHandler(mHandler);//设备Handler接收消息 booleanhandleMessage(Messagemsg);//回调函数处理消息 5.设置声音开关 mRealPlayMgr.isSoundOpen()判断声音是否开启 mRealPlayMgr.openSound();//开启声音 mRealPlayMgr.closeSound();//关闭声音 6.
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- ezvizandroidsdkhelp
![提示](https://static.bdocx.com/images/bang_tan.gif)