java.lang.Object
- com.videogo.openapi.EZOpenSDK

直接已知子类:

EZGlobalSDK
```
public class EZOpenSDK
extends java.lang.Object
```
开放平台总接口类如果接口函数调用失败，请仔细查看日志中是否有android.os.NetworkOnMainThreadException异常。EZOpenSDK中的大部分接口都有网络操作，需要在线程中调用。

字段概要

字段
修饰符和类型	字段	说明
`static java.lang.String`	`API_URL`
`protected android.app.Application`	`mApplication`
`protected static EZOpenSDK`	`mEZOpenSDK`
`protected EzvizAPI`	`mEzvizAPI`
`static java.lang.String`	`WEB_URL`

构造器概要

构造器
限定符构造器说明

protected EZOpenSDK(android.app.Application application, java.lang.String appKey)

方法概要

所有方法静态方法实例方法具体方法已过时的方法
修饰符和类型	方法	说明
`boolean`	`addDevice(java.lang.String deviceSerial, java.lang.String verifyCode)`	添加设备该接口为耗时操作，必须在线程中调用
`java.lang.String`	`captureCamera(java.lang.String deviceSerial, int cameraNo)`	获取摄像头实时图片的url接口，需要设备支持，萤石设备一般都能支持此协议。
`void`	`clearStreamInfoCache()`	清除取流时的缓存数据
`boolean`	`controlPTZ(java.lang.String deviceSerial, int cameraNo, EZConstants.EZPTZCommand command, EZConstants.EZPTZAction action, int speed)`	PTZ 控制接口该接口为耗时操作，必须在线程中调用
`void`	`controlVideoFlip(java.lang.String deviceSerial, int cameraNo, EZConstants.EZPTZDisplayCommand command)`	已过时。建议用http方式实现，使用说明请参考https://open.ys7.com/doc/zh/book/index/device_ptz.html#device_ptz-api3
`EZPlayer`	`createPlayer(java.lang.String deviceSerial, int cameraNo)`	根据deviceSerial 和 cameraNo 构造EZPlayer对象
`EZPlayer`	`createPlayerWithUrl(java.lang.String url)`	根据视频url构造EZPlayer对象，用于通过视频url进行播放
`EZPlayer`	`createPlayerWithUserId(int userId, int cameraNo, int streamType)`	创建局域网播放器
`byte[]`	`decryptData(byte[] inputData, java.lang.String verifyCode, int cryptType)`	解密数据，该接口可以用于解密告警图片
`boolean`	`deleteAlarm(java.util.List<java.lang.String> alarmIdList)`	批量删除告警该接口为耗时操作，必须在线程中调用
`boolean`	`deleteDevice(java.lang.String deviceSerial)`	删除当前账号的设备该接口为耗时操作，必须在线程中调用
`boolean`	`deleteLeaveMessages(java.util.List<java.lang.String> msgIdList)`	批量删除留言消息该接口为耗时操作，必须在线程中调用
`static void`	`enableP2P(boolean bEnable)`	设置是否支持P2P取流，默认是不支持的 P2P取流可以降低转发取流的比例，但是在多人同时观看时对设备端的带宽要求也更高，设备端带宽不够的情况下，影响播放体验对于可能多人同时观看的场景，建议不支持对于家用监控类的场景，建议支持P2P 此函数可以在任意时刻调用
`static void`	`finiLib()`	释放sdk资源
`boolean`	`formatStorage(java.lang.String deviceSerial, int partitionIndex)`	格式化分区(SD卡) 该接口为耗时操作，必须在线程中调用
`java.util.List<EZAlarmInfo>`	`getAlarmList(java.lang.String deviceSerial, int pageIndex, int pageSize, java.util.Calendar beginTime, java.util.Calendar endTime)`	获取告警信息列表该接口为耗时操作，必须在线程中调用
`EZDeviceInfo`	`getDeviceInfo(java.lang.String deviceSerial)`	获取单个设备信息该接口为耗时操作，必须在线程中调用
`java.util.List<EZDeviceInfo>`	`getDeviceList(int pageIndex, int pageSize)`	获取用户的设备列表，返回EZDeviceInfo的对象数组，只提供设备基础数据该接口为耗时操作，必须在线程中调用
`EZDeviceUpgradeStatus`	`getDeviceUpgradeStatus(java.lang.String deviceSerial)`	获取设备升级状态该接口为耗时操作，必须在线程中调用
`EZDeviceVersion`	`getDeviceVersion(java.lang.String deviceSerial)`	获取设备的版本信息接口该接口为耗时操作，必须在线程中调用
`EZAccessToken`	`getEZAccessToken()`	获取登录token
`static EZOpenSDK`	`getInstance()`	获取单例对象
`void`	`getLeaveMessageData(android.os.Handler handler, EZLeaveMessage msg, EZOpenSDKListener.EZLeaveMessageFlowCallback callback)`	获取语音留言数据该接口为耗时操作，必须在线程中调用
`java.util.List<EZLeaveMessage>`	`getLeaveMessageList(java.lang.String deviceSerial, int pageIndex, int pageSize, java.util.Calendar beginTime, java.util.Calendar endTime)`	获取留言消息列表,默认为止查询语音留言信息该接口为耗时操作，必须在线程中调用
`java.util.List<EZDeviceInfo>`	`getSharedDeviceList(int pageIndex, int pageSize)`	获取好友分享的设备列表，返回EZDeviceInfo的对象数组该接口为耗时操作，必须在线程中调用
`java.util.List<EZStorageStatus>`	`getStorageStatus(java.lang.String deviceSerial)`	获取存储介质状态(如是否初始化，格式化进度等) 该接口为耗时操作，必须在线程中调用
`java.lang.String`	`getTerminalId()`	获取终端（手机等）唯一识别码
`java.util.List<EZDeviceInfo>`	`getTrustDeviceList(int pageIndex, int ezpageSize)`	获取用户设备和托管设备列表 (接口暂未启用,请勿调用)
`int`	`getUnreadMessageCount(java.lang.String deviceSerial, EZConstants.EZMessageType messageType)`	获取未读消息数该接口为耗时操作，必须在线程中调用
`EZUserInfo`	`getUserInfo()`	获取用户信息；用户信息包含：用户名,头像地址等该接口为耗时操作，必须在线程中调用
`static java.lang.String`	`getVersion()`	获取SDK版本
`static boolean`	`initLib(android.app.Application application, java.lang.String appKey)`	SDK 初始化
`static boolean`	`initLib(android.app.Application application, java.lang.String appKey, java.lang.String loadLibraryAbsPath)`	已过时。不再支持加载外置so库，仅保留形式兼容老版本sdk
`boolean`	`isLogin()`	是否已登录授权
`void`	`logout()`	登出账号该接口为耗时操作，必须在线程中调用
`void`	`openChangePasswordPage()`	修改密码页面
`void`	`openCloudPage(java.lang.String deviceSerial)`	已过时。仅保留接口兼容老用户，请尽快换用void openCloudPage(String deviceSerial, int cameraNo)
`void`	`openCloudPage(java.lang.String deviceSerial, int cameraNo)`	打开云存储H5页面
`void`	`openLoginPage()`	打开授权登录中间页面,用于获取Accesstoken
`void`	`openLoginPage(int flag)`	打开授权登录中间页面,用于获取Accesstoken
`EZProbeDeviceInfo`	`probeDeviceInfo(java.lang.String deviceSerial)`	已过时。仅保留接口兼容老用户，请尽快换用EZProbeDeviceInfoResult probeDeviceInfo(String deviceSerial,String deviceType)
`EZProbeDeviceInfoResult`	`probeDeviceInfo(java.lang.String deviceSerial, java.lang.String deviceType)`	尝试查询设备信息（用于添加设备之前, 简单查询设备信息，如是否在线，是否添加等）该接口为耗时操作，必须在线程中调用
`void`	`releasePlayer(EZPlayer player)`	释放 EZPlayer 对象
`java.util.List<EZCloudRecordFile>`	`searchRecordFileFromCloud(java.lang.String deviceSerial, int cameraNo, java.util.Calendar startTime, java.util.Calendar endTime)`	查询云存储录像信息列表该接口中有网络操作，需要在线程中调用
`java.util.List<EZDeviceRecordFile>`	`searchRecordFileFromDevice(java.lang.String deviceSerial, int cameraNo, java.util.Calendar startTime, java.util.Calendar endTime)`	查询远程SD卡存储录像信息列表当设备关联了NVR存储设备后，此时查找的是NVR设备中录像，不再提供查找设备SD卡中录像该接口为耗时操作，必须在线程中调用
`void`	`setAccessToken(java.lang.String accessToken)`	授权登录以后给EZOpenSDK设置AccessToken
`boolean`	`setAlarmStatus(java.util.List<java.lang.String> alarmIdList, EZConstants.EZAlarmStatus alarmStatus)`	设置告警为已读该接口为耗时操作，必须在线程中调用
`boolean`	`setDefence(java.lang.String deviceSerial, EZConstants.EZDefenceStatus defence)`	设备设置布防状态，兼容A1和IPC设备的布防该接口为耗时操作，必须在线程中调用
`boolean`	`setDeviceEncryptStatus(java.lang.String deviceSerial, java.lang.String validateCode, boolean encrypt)`	设备视频图片加解密开关接口该接口为耗时操作，必须在线程中调用 As of v4.2.0, replaced setDeviceEncryptStatusEx
`boolean`	`setDeviceName(java.lang.String deviceSerial, java.lang.String deviceName)`	修改设备名称接口该接口为耗时操作，必须在线程中调用
`boolean`	`setLeaveMessageStatus(java.util.List<java.lang.String> msgIdList, EZConstants.EZMessageStatus messageStatus)`	批量设置留言消息已读功能该接口为耗时操作，必须在线程中调用
`void`	`setLogCallback(EZOpenSDKListener.LogCallback callback)`	设置SDK日志回调
`void`	`setServerUrl(java.lang.String apiUrl, java.lang.String webUrl)`	切换到指定服务区域
`boolean`	`setVideoLevel(java.lang.String deviceSerial, int cameraNo, int videoLevel)`	设置指定监控点视频清晰度该接口为耗时操作，必须在线程中调用
`void`	`setVparamForLoginPage(java.lang.String vParam)`	设置登录页的v参数，用于控制登录页样式
`static void`	`showSDKLog(boolean showLog)`	设置是否打印sdk中logcat日志建议在debug下设置打印，release下设置不打印此函数建议在初始化之前调用
`void`	`startAPConfigWifiWithSsid(java.lang.String wifiSsid, java.lang.String wifiPwd, java.lang.String deviceSerial, java.lang.String deviceVerifyCode, APWifiConfig.APConfigCallback callback)`	AP配网接口,默认为"EZVIZ_"+设备序列号,设备AP热点密码默认为"EZVIZ_"+设备验证码,默认自动连接设备热点，需要获取可扫描wifi的权限
`void`	`startAPConfigWifiWithSsid(java.lang.String wifiSsid, java.lang.String wifiPwd, java.lang.String deviceSerial, java.lang.String deviceVerifyCode, java.lang.String deviceHotspotName, java.lang.String deviceHotspotPwd, boolean autoConnectToDeviceHotSpot, APWifiConfig.APConfigCallback callback)`	AP配网接口
`boolean`	`startConfigWifi(android.content.Context context, java.lang.String ssid, java.lang.String password, com.hikvision.wifi.configuration.DeviceDiscoveryListener l)`	已过时。不再使用
`void`	`startConfigWifi(android.content.Context context, java.lang.String deviceSerial, java.lang.String ssid, java.lang.String password, int mode, EZOpenSDKListener.EZStartConfigWifiCallback back)`	开始WiFi配置
`void`	`startConfigWifi(android.content.Context context, java.lang.String deviceSerial, java.lang.String ssid, java.lang.String password, EZOpenSDKListener.EZStartConfigWifiCallback back)`	开始WiFi配置
`void`	`stopAPConfigWifiWithSsid()`	停止AP配网
`boolean`	`stopConfigWiFi()`	停止Wifi配置
`void`	`upgradeDevice(java.lang.String deviceSerial)`	开始升级设备固件该接口为耗时操作，必须在线程中调用

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - API_URL
```
public static java.lang.String API_URL
```
  - WEB_URL
```
public static java.lang.String WEB_URL
```
  - mEZOpenSDK
```
protected static EZOpenSDK mEZOpenSDK
```
  - mApplication
```
protected android.app.Application mApplication
```
  - mEzvizAPI
```
protected EzvizAPI mEzvizAPI
```
- 构造器详细资料
  - EZOpenSDK
```
protected EZOpenSDK(android.app.Application application,
                    java.lang.String appKey)
```
- 方法详细资料
  - getInstance
```
public static EZOpenSDK getInstance()
```
    获取单例对象
    
    返回:
    
    获取单例对象
  - initLib
```
public static boolean initLib(android.app.Application application,
                              java.lang.String appKey,
                              java.lang.String loadLibraryAbsPath)
```
    已过时。
    不再支持加载外置so库，仅保留形式兼容老版本sdk
  - initLib
```
public static boolean initLib(android.app.Application application,
                              java.lang.String appKey)
```
    SDK 初始化
    
    参数:
    
    application - 客戶端app的 Application 對象
    
    appKey - 客戶端app申請的app key
    
    返回:
    
    true 表示成功，false 表示失败
    
    从以下版本开始:
    
    4.8.0
  - finiLib
```
public static void finiLib()
```
    释放sdk资源
  - showSDKLog
```
public static void showSDKLog(boolean showLog)
```
    设置是否打印sdk中logcat日志建议在debug下设置打印，release下设置不打印此函数建议在初始化之前调用
    
    参数:
    
    showLog - true打印 false不打印
  - enableP2P
```
public static void enableP2P(boolean bEnable)
```
    设置是否支持P2P取流，默认是不支持的 P2P取流可以降低转发取流的比例，但是在多人同时观看时对设备端的带宽要求也更高，设备端带宽不够的情况下，影响播放体验对于可能多人同时观看的场景，建议不支持对于家用监控类的场景，建议支持P2P 此函数可以在任意时刻调用
    
    参数:
    
    bEnable - true-支持p2p false-不支持p2p
  - setAccessToken
```
public void setAccessToken(java.lang.String accessToken)
```
    授权登录以后给EZOpenSDK设置AccessToken
    
    参数:
    
    accessToken - 授权登录获取的accessToken
  - getEZAccessToken
```
public EZAccessToken getEZAccessToken()
```
    获取登录token
    
    返回:
    
    token包含2个字段，一个是token string本身，另外一个表示过期时间，单位为秒
  - openLoginPage
```
public void openLoginPage()
```
    打开授权登录中间页面,用于获取Accesstoken
  - openLoginPage
```
public void openLoginPage(int flag)
```
    打开授权登录中间页面,用于获取Accesstoken
    
    参数:
    
    flag - 页面跳转flag 类似Intent.FLAG_ACTIVITY_CLEAR_TOP
  - logout
```
public void logout()
```
    登出账号该接口为耗时操作，必须在线程中调用
  - setAlarmStatus
```
public boolean setAlarmStatus(java.util.List<java.lang.String> alarmIdList,
                              EZConstants.EZAlarmStatus alarmStatus)
                       throws BaseException
```
    设置告警为已读该接口为耗时操作，必须在线程中调用
    
    参数:
    
    alarmIdList - 告警信息Id数组(设置单条告警为已读时，数组中可以只有一个Id)
    
    alarmStatus - 告警状态,目前只支持设为已读功能 EZMessageStatusRead
    
    返回:
    
    true 表示成功， false 表示失败
    
    抛出:
    
    BaseException
  - deleteAlarm
```
public boolean deleteAlarm(java.util.List<java.lang.String> alarmIdList)
                    throws BaseException
```
    批量删除告警该接口为耗时操作，必须在线程中调用
    
    参数:
    
    alarmIdList - 告警ID list
    
    返回:
    
    true 表示成功， false 表示失败
    
    抛出:
    
    BaseException
  - searchRecordFileFromCloud
```
public java.util.List<EZCloudRecordFile> searchRecordFileFromCloud(java.lang.String deviceSerial,
                                                                   int cameraNo,
                                                                   java.util.Calendar startTime,
                                                                   java.util.Calendar endTime)
                                                            throws BaseException
```
    查询云存储录像信息列表该接口中有网络操作，需要在线程中调用
    
    参数:
    
    deviceSerial - 设备序列号
    
    cameraNo - camera的序号，EZCameraInfo.cameraNo
    
    startTime - 查询时间范围开始时间
    
    endTime - 查询时间范围结束时间
    
    返回:
    
    云存储录像信息列表
    
    抛出:
    
    BaseException - 操作失败的异常信息
  - searchRecordFileFromDevice
```
public java.util.List<EZDeviceRecordFile> searchRecordFileFromDevice(java.lang.String deviceSerial,
                                                                     int cameraNo,
                                                                     java.util.Calendar startTime,
                                                                     java.util.Calendar endTime)
                                                              throws BaseException
```
    查询远程SD卡存储录像信息列表当设备关联了NVR存储设备后，此时查找的是NVR设备中录像，不再提供查找设备SD卡中录像该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 设备序列号
    
    cameraNo - camera的序号，EZCameraInfo.cameraNo
    
    startTime - 查询时间范围开始时间
    
    endTime - 查询时间范围结束时间
    
    返回:
    
    远程SD卡存储录像信息列表
    
    抛出:
    
    BaseException
  - addDevice
```
public boolean addDevice(java.lang.String deviceSerial,
                         java.lang.String verifyCode)
                  throws BaseException
```
    添加设备该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 设备序列号
    
    verifyCode - 设备验证码，验证码位于设备机身上，6位大写字母
    
    返回:
    
    true 表示成功， false 表示失败
    
    抛出:
    
    BaseException
  - deleteDevice
```
public boolean deleteDevice(java.lang.String deviceSerial)
                     throws BaseException
```
    删除当前账号的设备该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 设备序列号, 9位数字
    
    返回:
    
    true 表示成功， false 表示失败
    
    抛出:
    
    BaseException
  - controlPTZ
```
public boolean controlPTZ(java.lang.String deviceSerial,
                          int cameraNo,
                          EZConstants.EZPTZCommand command,
                          EZConstants.EZPTZAction action,
                          int speed)
                   throws BaseException
```
    PTZ 控制接口该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 设备序列号
    
    cameraNo - 通道号
    
    command - ptz控制命令
    
    action - 控制启动/停止
    
    speed - 速度（0-2）
    
    返回:
    
    操作成功或者失败(返回失败错误码)
    
    抛出:
    
    BaseException
  - controlVideoFlip
```
public void controlVideoFlip(java.lang.String deviceSerial,
                             int cameraNo,
                             EZConstants.EZPTZDisplayCommand command)
                      throws BaseException
```
    已过时。
    建议用http方式实现，使用说明请参考https://open.ys7.com/doc/zh/book/index/device_ptz.html#device_ptz-api3
    
    镜像控制设备视频画面翻转。在摄像头倒装的时候，调用此接口可让画面正过来需要设备支持该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 设备序列号
    
    cameraNo - camera的序号，EZCameraInfo.cameraNo
    
    command - ptz控制命令
    
    抛出:
    
    BaseException - exception 操作失败会抛出异常，错误码 exception.getErrorCode
  - decryptData
```
public byte[] decryptData(byte[] inputData,
                          java.lang.String verifyCode,
                          int cryptType)
```
    解密数据，该接口可以用于解密告警图片
    
    参数:
    
    inputData - 解密前数据
    
    verifyCode - 密码，设备加密时通常为设备验证码，平台加密时为平台返回的checkSum
    
    cryptType - 加密类型 1-设备加密 2-平台加密
  - captureCamera
```
public java.lang.String captureCamera(java.lang.String deviceSerial,
                                      int cameraNo)
                               throws BaseException
```
    获取摄像头实时图片的url接口，需要设备支持，萤石设备一般都能支持此协议。(该功能和萤石云视频app首页刷新封面的功能一致) 该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 设备序列号
    
    cameraNo - 通道号
    
    返回:
    
    图片url
    
    抛出:
    
    BaseException - replaced by getRealPicture and capturePicture
  - getDeviceVersion
```
public EZDeviceVersion getDeviceVersion(java.lang.String deviceSerial)
                                 throws BaseException
```
    获取设备的版本信息接口该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 设备序列号
    
    返回:
    
    版本号EZDeviceVersion对象
    
    抛出:
    
    BaseException
  - setDeviceEncryptStatus
```
public boolean setDeviceEncryptStatus(java.lang.String deviceSerial,
                                      java.lang.String validateCode,
                                      boolean encrypt)
                               throws BaseException
```
    设备视频图片加解密开关接口该接口为耗时操作，必须在线程中调用 As of v4.2.0, replaced setDeviceEncryptStatusEx
    
    参数:
    
    deviceSerial - 设备序列号
    
    validateCode - 设备验证码
    
    encrypt - 是否加密 1加密，0不加密
    
    返回:
    
    true成功，false失败
    
    抛出:
    
    BaseException
  - setDeviceName
```
public boolean setDeviceName(java.lang.String deviceSerial,
                             java.lang.String deviceName)
                      throws BaseException
```
    修改设备名称接口该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 设备序列号
    
    deviceName - 修改后的设备名称
    
    返回:
    
    true 表示成功， false 表示失败
    
    抛出:
    
    BaseException
  - getUserInfo
```
public EZUserInfo getUserInfo()
                       throws BaseException
```
    获取用户信息；用户信息包含：用户名,头像地址等该接口为耗时操作，必须在线程中调用
    
    返回:
    
    返回 EZUserInfo 对象, 目前nickname和avatarUrl字段无效
    
    抛出:
    
    BaseException
  - getUnreadMessageCount
```
public int getUnreadMessageCount(java.lang.String deviceSerial,
                                 EZConstants.EZMessageType messageType)
                          throws BaseException
```
    获取未读消息数该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 需要获取的设备序列号，为空时返回账户下所有设备的未读消息数
    
    messageType - 消息类型：EZMessageTypeAlarm 告警消息，EZMessageTypeLeave 留言消息
    
    返回:
    
    未读消息数
    
    抛出:
    
    BaseException
  - getLeaveMessageList
```
public java.util.List<EZLeaveMessage> getLeaveMessageList(java.lang.String deviceSerial,
                                                          int pageIndex,
                                                          int pageSize,
                                                          java.util.Calendar beginTime,
                                                          java.util.Calendar endTime)
                                                   throws BaseException
```
    获取留言消息列表,默认为止查询语音留言信息该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 设备序列号（可为空），为空时返回账户下所有设备的留言消息
    
    pageIndex - 当前分页，从0开始
    
    pageSize - 分页大小
    
    beginTime - 开始时间
    
    endTime - 结束时间
    
    返回:
    
    留言EZLeaveMessage列表
    
    抛出:
    
    BaseException
  - setLeaveMessageStatus
```
public boolean setLeaveMessageStatus(java.util.List<java.lang.String> msgIdList,
                                     EZConstants.EZMessageStatus messageStatus)
                              throws BaseException
```
    批量设置留言消息已读功能该接口为耗时操作，必须在线程中调用
    
    参数:
    
    msgIdList - 留言消息Id数组(最大数量为10，允许只有1个)
    
    messageStatus - 需要设置的留言状态，目前只支持 EZMessageStatusRead(已读);
    
    返回:
    
    true 表示成功， false 表示失败
    
    抛出:
    
    BaseException
  - deleteLeaveMessages
```
public boolean deleteLeaveMessages(java.util.List<java.lang.String> msgIdList)
                            throws BaseException
```
    批量删除留言消息该接口为耗时操作，必须在线程中调用
    
    参数:
    
    msgIdList - 留言消息Id数组(最大数量为10，允许只有1个)
    
    返回:
    
    true 表示成功， false 表示失败
    
    抛出:
    
    BaseException
  - getLeaveMessageData
```
public void getLeaveMessageData(android.os.Handler handler,
                                EZLeaveMessage msg,
                                EZOpenSDKListener.EZLeaveMessageFlowCallback callback)
```
    获取语音留言数据该接口为耗时操作，必须在线程中调用
    
    参数:
    
    handler - handler，用于发送成功或者失败消息, 301:下载留言失败 ;302:下载留言成功消息obj为留言ID
    
    msg - 留言消息
    
    callback - 获取留言消息数据回调
  - getStorageStatus
```
public java.util.List<EZStorageStatus> getStorageStatus(java.lang.String deviceSerial)
                                                 throws BaseException
```
    获取存储介质状态(如是否初始化，格式化进度等) 该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 需要获取的设备序列号
    
    返回:
    
    存储状态(EZStorageStatus)列表，列表每个item代表一个磁盘分区
    
    抛出:
    
    BaseException
  - formatStorage
```
public boolean formatStorage(java.lang.String deviceSerial,
                             int partitionIndex)
                      throws BaseException
```
    格式化分区(SD卡) 该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 需要格式化的设备序列号
    
    partitionIndex - getStorageStatus查询返回的分区号
    
    返回:
    
    true 表示成功， false 表示失败
    
    抛出:
    
    BaseException
  - probeDeviceInfo
```
public EZProbeDeviceInfo probeDeviceInfo(java.lang.String deviceSerial)
                                  throws BaseException
```
    已过时。
    仅保留接口兼容老用户，请尽快换用EZProbeDeviceInfoResult probeDeviceInfo(String deviceSerial,String deviceType)
    
    尝试查询设备信息（用于添加设备之前, 简单查询设备信息，如是否在线，是否添加等）该接口为耗时操作，建议放在线程中调用
    
    参数:
    
    deviceSerial - 需要查询的设备序列号
    
    返回:
    
    返回 EZProbeDeviceInfo 对象，包含设备简单信息，用于添加目的
    
    抛出:
    
    BaseException
  - probeDeviceInfo
```
public EZProbeDeviceInfoResult probeDeviceInfo(java.lang.String deviceSerial,
                                               java.lang.String deviceType)
```
    尝试查询设备信息（用于添加设备之前, 简单查询设备信息，如是否在线，是否添加等）该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 需要查询的设备序列号
    
    deviceType - 设备型号 (设备型号和设备序列号不能均为空,优先按照设备序列号查询)
    
    返回:
    
    返回 EZProbeDeviceInfo 对象，包含设备简单信息，用于添加目的
  - upgradeDevice
```
public void upgradeDevice(java.lang.String deviceSerial)
                   throws BaseException
```
    开始升级设备固件该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 设备序列号
    
    抛出:
    
    BaseException
  - getDeviceUpgradeStatus
```
public EZDeviceUpgradeStatus getDeviceUpgradeStatus(java.lang.String deviceSerial)
                                             throws BaseException
```
    获取设备升级状态该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 设备序列号
    
    返回:
    
    EZDeviceUpgradeStatus对象
    
    抛出:
    
    BaseException
  - openCloudPage
```
public void openCloudPage(java.lang.String deviceSerial)
                   throws BaseException
```
    已过时。
    仅保留接口兼容老用户，请尽快换用void openCloudPage(String deviceSerial, int cameraNo)
    
    打开云存储H5页面仅适用于单通道设备，如IPC，不建议使用
    
    参数:
    
    deviceSerial - 设备序列号
    
    抛出:
    
    BaseException - 调用失败的异常信息
  - openCloudPage
```
public void openCloudPage(java.lang.String deviceSerial,
                          int cameraNo)
                   throws BaseException
```
    打开云存储H5页面
    
    参数:
    
    deviceSerial - 设备序列号
    
    cameraNo - camera序号，EZCameraInfo.cameraNo
    
    抛出:
    
    BaseException - 调用失败的异常信息
    
    从以下版本开始:
    
    4.8.8 增加camera序号
  - startConfigWifi
```
public void startConfigWifi(android.content.Context context,
                            java.lang.String deviceSerial,
                            java.lang.String ssid,
                            java.lang.String password,
                            EZOpenSDKListener.EZStartConfigWifiCallback back)
```
    开始WiFi配置
    
    参数:
    
    context - 应用 activity context
    
    deviceSerial - 配置设备序列号
    
    ssid - 连接WiFi SSID
    
    password - 连接 WiFi 密码
    
    back - 配置回调
    
    从以下版本开始:
    
    4.3.0
  - startConfigWifi
```
public void startConfigWifi(android.content.Context context,
                            java.lang.String deviceSerial,
                            java.lang.String ssid,
                            java.lang.String password,
                            int mode,
                            EZOpenSDKListener.EZStartConfigWifiCallback back)
```
    开始WiFi配置
    
    参数:
    
    context - 应用 activity context
    
    deviceSerial - 配置设备序列号
    
    ssid - 连接WiFi SSID
    
    password - 连接 WiFi 密码
    
    mode - 配网的方式，EZWiFiConfigMode中列举的模式进行任意组合,例如:EZWiFiConfigMode.EZWiFiConfigSmart|EZWiFiConfigMode.EZWiFiConfigWave
    
    back - 配置回调
    
    从以下版本开始:
    
    4.8.3
  - startConfigWifi
```
public boolean startConfigWifi(android.content.Context context,
                               java.lang.String ssid,
                               java.lang.String password,
                               com.hikvision.wifi.configuration.DeviceDiscoveryListener l)
```
    已过时。
    不再使用
    
    开始WiFi配置
    
    参数:
    
    context - 应用 activity context
    
    ssid - 连接WiFi SSID
    
    password - 连接WiFi 密码
    
    l - 回调，用于处理连接设备的WiFi配置状态
    
    返回:
    
    返回值并没有特别的含义，根据回调判断是否配置wifi成功
  - stopConfigWiFi
```
public boolean stopConfigWiFi()
```
    停止Wifi配置
    
    返回:
    
    true 表示成功， false 表示失败
  - startAPConfigWifiWithSsid
```
public void startAPConfigWifiWithSsid(java.lang.String wifiSsid,
                                      java.lang.String wifiPwd,
                                      java.lang.String deviceSerial,
                                      java.lang.String deviceVerifyCode,
                                      APWifiConfig.APConfigCallback callback)
```
    AP配网接口,默认为"EZVIZ_"+设备序列号,设备AP热点密码默认为"EZVIZ_"+设备验证码,默认自动连接设备热点，需要获取可扫描wifi的权限
    
    参数:
    
    wifiSsid - WiFi的ssid
    
    wifiPwd - WiFi的密码
    
    deviceSerial - 设备序列号
    
    deviceVerifyCode - 设备验证码
    
    callback - 结果回调
  - startAPConfigWifiWithSsid
```
public void startAPConfigWifiWithSsid(java.lang.String wifiSsid,
                                      java.lang.String wifiPwd,
                                      java.lang.String deviceSerial,
                                      java.lang.String deviceVerifyCode,
                                      java.lang.String deviceHotspotName,
                                      java.lang.String deviceHotspotPwd,
                                      boolean autoConnectToDeviceHotSpot,
                                      APWifiConfig.APConfigCallback callback)
```
    AP配网接口
    
    参数:
    
    wifiSsid - WiFi的ssid
    
    wifiPwd - WiFi的密码
    
    deviceSerial - 设备序列号
    
    deviceVerifyCode - 设备验证码
    
    deviceHotspotName - 设备热点名称，可传空，默认为"EZVIZ_"+设备序列号
    
    deviceHotspotPwd - 设备热点密码,可传空，默认为"EZVIZ_"+设备验证码
    
    autoConnectToDeviceHotSpot - 是否自动连接设备热点,需要获取可扫描wifi的权限
    
    callback - 结果回调
  - stopAPConfigWifiWithSsid
```
public void stopAPConfigWifiWithSsid()
```
    停止AP配网
  - getVersion
```
public static java.lang.String getVersion()
```
    获取SDK版本
    
    返回:
    
    sdk 版本
  - createPlayer
```
public EZPlayer createPlayer(java.lang.String deviceSerial,
                             int cameraNo)
```
    根据deviceSerial 和 cameraNo 构造EZPlayer对象
    
    参数:
    
    deviceSerial - 设备序列号
    
    cameraNo - 通道号
    
    返回:
    
    EZPlayer对象
  - createPlayerWithUrl
```
public EZPlayer createPlayerWithUrl(java.lang.String url)
```
    根据视频url构造EZPlayer对象，用于通过视频url进行播放
    
    参数:
    
    url - 视频url
    
    返回:
    
    EZPlayer对象
  - createPlayerWithUserId
```
public EZPlayer createPlayerWithUserId(int userId,
                                       int cameraNo,
                                       int streamType)
```
    创建局域网播放器
    
    参数:
    
    userId - 设备登录成功后的userId
    
    cameraNo - 设备预览的通道号
    
    streamType - 设备预览的码流类型 1:主码流;2:子码流
    
    返回:
  - releasePlayer
```
public void releasePlayer(EZPlayer player)
```
    释放 EZPlayer 对象
    
    参数:
    
    player - 将要释放的EZPlayer对象
  - getDeviceList
```
public java.util.List<EZDeviceInfo> getDeviceList(int pageIndex,
                                                  int pageSize)
                                           throws BaseException
```
    获取用户的设备列表，返回EZDeviceInfo的对象数组，只提供设备基础数据该接口为耗时操作，必须在线程中调用
    
    参数:
    
    pageIndex - 查询页index，从0开始
    
    pageSize - 每页数量（建议20以内）
    
    返回:
    
    返回的EZDeviceInfo
    
    抛出:
    
    BaseException
  - getAlarmList
```
public java.util.List<EZAlarmInfo> getAlarmList(java.lang.String deviceSerial,
                                                int pageIndex,
                                                int pageSize,
                                                java.util.Calendar beginTime,
                                                java.util.Calendar endTime)
                                         throws BaseException
```
    获取告警信息列表该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 设备序列号，为null时查询整个账户下的告警信息列表
    
    pageIndex - 查询页index，从0开始
    
    pageSize - 每页数量（建议20以内）
    
    beginTime - 搜索时间范围开始时间，开始时间和结束时间可以同时为空
    
    endTime - 搜索时间范围结束时间
    
    返回:
    
    EZAlarmInfo对象列表
    
    抛出:
    
    BaseException
  - setDefence
```
public boolean setDefence(java.lang.String deviceSerial,
                          EZConstants.EZDefenceStatus defence)
                   throws BaseException
```
    设备设置布防状态，兼容A1和IPC设备的布防该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 设备序列号
    
    defence - 布防状态, 摄像机布防状态只有0和1，告警器有0:睡眠 8:在家 16:外出
    
    返回:
    
    设备设置布防状态是否成功
    
    抛出:
    
    BaseException
  - openChangePasswordPage
```
public void openChangePasswordPage()
```
    修改密码页面
  - getSharedDeviceList
```
public java.util.List<EZDeviceInfo> getSharedDeviceList(int pageIndex,
                                                        int pageSize)
                                                 throws BaseException
```
    获取好友分享的设备列表，返回EZDeviceInfo的对象数组该接口为耗时操作，必须在线程中调用
    
    参数:
    
    pageIndex - 分页起始页，从0开始
    
    pageSize - 分页每页数量（建议20以内）
    
    返回:
    
    抛出:
    
    BaseException
    
    从以下版本开始:
    
    4.2
  - setVideoLevel
```
public boolean setVideoLevel(java.lang.String deviceSerial,
                             int cameraNo,
                             int videoLevel)
                      throws BaseException
```
    设置指定监控点视频清晰度该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 设备序列号
    
    cameraNo - 设备通道号，默认为1
    
    videoLevel - 清晰度 0-流畅 1-均衡 2-高品质
    
    返回:
    
    抛出:
    
    BaseException
    
    从以下版本开始:
    
    4.2
  - getDeviceInfo
```
public EZDeviceInfo getDeviceInfo(java.lang.String deviceSerial)
                           throws BaseException
```
    获取单个设备信息该接口为耗时操作，必须在线程中调用
    
    参数:
    
    deviceSerial - 设备序列号
    
    返回:
    
    设备信息对象EZDeviceInfo，与getDeviceList中对象一致
    
    抛出:
    
    BaseException
    
    从以下版本开始:
    
    4.3
  - getTerminalId
```
public java.lang.String getTerminalId()
```
    获取终端（手机等）唯一识别码
    
    返回:
    
    终端唯一识别码
    
    从以下版本开始:
    
    4.3.0
  - clearStreamInfoCache
```
public void clearStreamInfoCache()
```
    清除取流时的缓存数据
    
    从以下版本开始:
    
    4.5.0
  - isLogin
```
public boolean isLogin()
```
    是否已登录授权
    
    从以下版本开始:
    
    4.8.3
  - setVparamForLoginPage
```
public void setVparamForLoginPage(java.lang.String vParam)
```
    设置登录页的v参数，用于控制登录页样式
    
    参数:
    
    vParam - 登录页样式（mobile-移动版、wap-pc版。。。）
    
    从以下版本开始:
    
    4.8.7
  - getTrustDeviceList
```
public java.util.List<EZDeviceInfo> getTrustDeviceList(int pageIndex,
                                                       int ezpageSize)
                                                throws BaseException
```
    获取用户设备和托管设备列表 (接口暂未启用,请勿调用)
    
    参数:
    
    pageIndex - 分页起始页，从0开始
    
    ezpageSize - 分页每页数量（建议20以内）
    
    抛出:
    
    BaseException - 报错信息
  - setServerUrl
```
public void setServerUrl(java.lang.String apiUrl,
                         java.lang.String webUrl)
```
    切换到指定服务区域
    
    参数:
    
    apiUrl - 区域接口请求域名
    
    webUrl - 区域WEB登录域名（默认可不填写）
  - setLogCallback
```
public void setLogCallback(EZOpenSDKListener.LogCallback callback)
```
    设置SDK日志回调
    
    从以下版本开始:
    
    4.11.0

类 EZOpenSDK

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

API_URL

WEB_URL

mEZOpenSDK

mApplication

mEzvizAPI

构造器详细资料

EZOpenSDK

方法详细资料

getInstance

initLib

initLib

finiLib

showSDKLog

enableP2P

setAccessToken

getEZAccessToken

openLoginPage

openLoginPage

logout

setAlarmStatus

deleteAlarm

searchRecordFileFromCloud

searchRecordFileFromDevice

addDevice

deleteDevice

controlPTZ

controlVideoFlip

decryptData

captureCamera

getDeviceVersion

setDeviceEncryptStatus

setDeviceName

getUserInfo

getUnreadMessageCount

getLeaveMessageList

setLeaveMessageStatus

deleteLeaveMessages

getLeaveMessageData

getStorageStatus

formatStorage

probeDeviceInfo

probeDeviceInfo

upgradeDevice

getDeviceUpgradeStatus

openCloudPage

openCloudPage

startConfigWifi

startConfigWifi

startConfigWifi

stopConfigWiFi

startAPConfigWifiWithSsid

startAPConfigWifiWithSsid

stopAPConfigWifiWithSsid

getVersion

createPlayer

createPlayerWithUrl

createPlayerWithUserId

releasePlayer

getDeviceList

getAlarmList

setDefence

openChangePasswordPage

getSharedDeviceList

setVideoLevel

getDeviceInfo

getTerminalId

clearStreamInfoCache

isLogin

setVparamForLoginPage

getTrustDeviceList

setServerUrl

setLogCallback