ezviz-android-sdk-help

萤石云视频AndroidSDK接口使用说明版本：V2.6合作伙伴交流使用（请勿外传）版本日期修改人修改原因1.02014-07-21星仔1.创建1.12014-08-01星仔1.增加报警推送1.22014-08-12星仔1．录像sd卡搜索返回时间片段2．预览/回放密码框实现1.32014-09-02星仔1.增加获取摄像头截屏接口2.支持二维码扫描添加设备1.42014-10-23星仔1.获取单个摄像头信息2.获取摄像头UUID录像信息3.获取摄像头UUID图片地址4.修复一些缺陷1.52014-10-30星仔1.修复一些缺陷1.62014-11-06星仔1.获取摄像头UUID图片地址接口增加图片大小设置2.获取摄像头信息增加是否加密字段1.72014-11-22星仔1.增加摄像头wifi一键配置功能2.增加视频广场播放功能1.82014-12-18星仔1.私有云后台对接授权登录2.设备操作中间页支持设备固件升级3.解决目前录像分片段的问题2.02015-01-07星仔1.添加设备成功后发送广播2.修复一些缺陷2.12015-03-12星仔1.增加视频广场系列接口2.修复一些缺陷2.32015-04-13星仔1.报警设置已读2.获取单个设备信息3.公共视频广场系列接口4.对内账户系列接口5.修复一些缺陷2.52015-05-12星仔1.增加局域网发现添加设备功能2.增加局域网本地预览功能3.修复一些缺陷2.62015-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权限：uses-permissionandroid:name=android.permission.RESTART_PACKAGES/uses-permissionandroid:name=android.permission.GET_TASKS/uses-permissionandroid:name=android.permission.INTERNET/uses-permissionandroid:name=android.permission.WAKE_LOCK/uses-permissionandroid:name=android.permission.ACCESS_NETWORK_STATE/uses-permissionandroid:name=android.permission.WRITE_OWNER_DATA/uses-permissionandroid:name=android.permission.CAMERA/uses-permissionandroid:name=android.permission.VIBRATE/uses-permissionandroid:name=android.permission.FLASHLIGHT/uses-permissionandroid:name=android.permission.RECORD_AUDIO/uses-permissionandroid:name=android.permission.READ_PHONE_STATE/uses-permissionandroid:name=android.permission.RECEIVE_BOOT_COMPLETED/uses-permissionandroid:name=android.permission.MOUNT_UNMOUNT_FILESYSTEMS/uses-permissionandroid:name=android.permission.WRITE_EXTERNAL_STORAGE/uses-permissionandroid:name=android.permission.ACCESS_COARSE_LOCATION/uses-permissionandroid:name=android.permission.ACCESS_FINE_LOCATION/uses-permissionandroid:name=android.permission.ACCESS_WIFI_STATE/uses-permissionandroid:name=android.permission.CHANGE_WIFI_STATE/uses-permissionandroid:name=android.permission.READ_LOGS/uses-permissionandroid:name=android.permission.SYSTEM_ALERT_WINDOW/uses-permissionandroid:name=android.permission.CHANGE_CONFIGURATION/其余权限请参看demo或者错误!未找到引用源。应用组件：activityandroid:name=.main.EzvizWebViewActivityandroid:configChanges=orientation|keyboardHiddenandroid:screenOrientation=portrait/activity用于sdk中间页显示，包含登录、设备添加、设备操作等页面receiverandroid:name=.EzvizBroadcastReceiverandroid:exported=falseintent-filteractionandroid:name=com.vedeogo.action.OAUTH_SUCCESS_ACTION/actionandroid:name=android.net.conn.CONNECTIVITY_CHANGE//intent-filter/receiver用于接收网络变化刷新SDK网络状态，接收中间页登录成功消息启动其他界面其余权限请参看demo或者错误!未找到引用源。5.获取摄像头列表，报警信息查询，云录像搜索、删除设备、预览和回放等功能详细示例请看demo，具体API请看以下接口说明SDK初始化：在应用Application的onCreate回调函数中初始化SDK//正式平台设置EzvizAPI.init(this,APP_KEY);//设置APP_KEYEzvizAPI.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或者错误!未找到引用源。透传接口：StringtransferAPI(finalString_reqStr)；该接口用于透传平台RestfulAPI，参数和返回请参见平台接口文档设备管理接口：获取摄像头列表：ListCameraInfogetCameraInfoList(GetCameraInfoListgetCameraInfoList);该接口用于应用获取摄像头列表参数GetCameraInfoList：KeyValueTypeUrlEncodeedOptiionnal备注pageStartint分页起始页，从0开始pageSizeint分页大小返回CameraInfo列表，CameraInfo属性如下：deviceId:设备唯一标识，用户设备表的主键cameraId:camera表的主键cameraNo：设备的通道号cameraName:通道名称status:是否在线0：不在线1：在线display:是否显示0：不显示1：显示isShared：分享状态picUrl:图片地址（大图）isEncrypt:是否加密0：未加密，1：已加密详细请参考demo或者错误!未找到引用源。删除设备：voiddeleteDevice(StringdeviceId);该接口用于应用删除设备参数deviceId为设备id，获取摄像头列表接口获得的数据，详细请参考demo或者错误!未找到引用源。报警信息查询：ListAlarmInfogetAlarmInfoList(GetAlarmInfoListgetAlarmInfoList);该接口用于应用获取报警信息列表参数GetAlarmInfoList：KeyValueTypeUrlEncodeedOptiionnal备注cameraIdStringyesno通道唯一标识startTimeStringyesno报警查询开始时间时间格式为：2013-09-0509:38:48endTimeStringyesno报警查询结束时间时间格式为：2013-09-0509:38:48alarmTypeintyesno报警类型statusintyesno报警消息状态，2：所有，1：已读，0：未读pageStartint分页起始页，从0开始pageSizeint分页大小返回AlarmInfo列表，AlarmInfo属性如下：alarmId:主键idalarmName:报警源名称alarmType:报警类型alarmStart:报警开始时间云录像搜索：ListCloudFilegetCloudFileList(GetCloudFileListgetCloudFileList);