类 EZGlobalSDK


  • public final class EZGlobalSDK
    extends EZOpenSDK
    开放平台海外版本 海外开发者接入时关注此接口(EZOpenSDK是面向国内开发者的) Created by yudan on 16/7/7.
    • 方法概要

      所有方法 静态方法 实例方法 具体方法 已过时的方法 
      修饰符和类型 方法 说明
      boolean addDevice​(java.lang.String deviceSerial, java.lang.String verifyCode)
      添加设备 接口中有网络操作,需要在线程中调用
      java.lang.String captureCamera​(java.lang.String deviceSerial, int channelNo)
      获取摄像头实时图片的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对象,用于视频广场的视频播放
      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)
      获取告警信息列表 接口中有网络操作,需要在线程中调用
      java.util.List<EZAreaInfo> getAreaList()
      获取区域列表 接口中有网络操作,需要在线程中调用
      java.util.List<EZHiddnsDeviceInfo> getDDNSDeviceList​(int pageSize, int pageStart)
      获取账户下所有设备列表DDNS信息 该接口为耗时操作,建议放在线程中调用
      EZHiddnsDeviceInfo getDDNSWithDeviceSerial​(java.lang.String deviceSerial, java.lang.String domain)
      获取设备DDNS信息 该接口为耗时操作,建议放在线程中调用 设备序列号,deviceSerial和domain不能全为空, 如果deviceSerial和domain都不为空,优先查询deviceSerial设备的ddns信息
      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 EZGlobalSDK 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<EZHiddnsDeviceInfo> getShareDDNSDeviceList​(int pageSize, int pageStart)
      获取当前账号下的所有的其它账户分享给自己的设备DDNS信息 该接口为耗时操作,建议放在线程中调用
      java.util.List<EZStorageStatus> getStorageStatus​(java.lang.String deviceSerial)
      获取存储介质状态(如是否初始化,格式化进度等) 接口中有网络操作,需要在线程中调用
      java.lang.String getTerminalId()
      获取终端(手机等)唯一识别码
      int getUnreadMessageCount​(java.lang.String deviceSerial, EZConstants.EZMessageType messageType)
      获取未读消息数 接口中有网络操作,需要在线程中调用
      EZUserInfo getUserInfo()
      获取用户信息;用户信息包含:用户名,头像地址等 接口中有网络操作,需要在线程中调用
      static java.lang.String getVersion()  
      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​(int areaId)
      打开授权登录中间页面,用于获取Accesstoken
      void openLoginPage​(int areaId, 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<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)
      设置告警为已读 接口中有网络操作,需要在线程中调用
      void setDDNSAutomatic​(java.lang.String deviceSerial)
      设置设备DDNS自动映射 该接口为耗时操作,建议放在线程中调用
      void setDDNSManual​(java.lang.String deviceSerial, int cmdPort, int httpPort)
      设置设备DDNS手动映射 该接口为耗时操作,建议放在线程中调用
      boolean setDefence​(java.lang.String deviceSerial, EZConstants.EZDefenceStatus defence)
      设备设置布防状态,兼容A1和IPC设备的布防 接口中有网络操作,需要在线程中调用
      void setDeviceDoamin​(java.lang.String deviceSerial, java.lang.String domain)
      设置设备DDNS域名 该接口为耗时操作,建议放在线程中调用 设备序列号,deviceSerial和domain不能为空,
      boolean setDeviceEncryptStatus​(java.lang.String deviceSerial, java.lang.String validateCode, boolean encrypt)
      设备视频图片加解密开关接口 接口中有网络操作,需要在线程中调用
      boolean setDeviceName​(java.lang.String deviceSerial, java.lang.String deviceName)
      修改设备名称接口 接口中有网络操作,需要在线程中调用
      boolean setLeaveMessageStatus​(java.util.List<java.lang.String> msgIdList, EZConstants.EZMessageStatus messageStatus)
      批量设置留言消息已读功能 该接口为耗时操作,建议放在线程中调用
      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参数,用于控制登录页样式
      void ShareDDNSDeviceList​(java.lang.String deviceSerial, java.lang.String account)
      分享设备DDNS信息,把单个设备的DDNS信息分享给其他账户 该接口为耗时操作,建议放在线程中调用
      void startAPConfigWifiWithSsid​(java.lang.String ssid, java.lang.String password, java.lang.String deviceSerial, java.lang.String verifyCode, APWifiConfig.APConfigCallback apConfigCallback)
      AP配网接口,默认为"EZVIZ_"+设备序列号,设备AP热点密码默认为"EZVIZ_"+设备验证码,默认自动连接设备热点,需要获取可扫描wifi的权限
      void startAPConfigWifiWithSsid​(java.lang.String ssid, java.lang.String password, java.lang.String deviceSerial, java.lang.String verifyCode, java.lang.String routerNamePre, java.lang.String routerPasswordPre, boolean isAutoConnectDeviceHotSpot, APWifiConfig.APConfigCallback apConfigCallback)
      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 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
    • 方法详细资料

      • getInstance

        public static EZGlobalSDK 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 表示失败
      • openCloudPage

        public void openCloudPage​(java.lang.String deviceSerial)
                           throws BaseException
        已过时。
        仅保留接口兼容老用户,请尽快换用void openCloudPage(String deviceSerial, int cameraNo)
        打开云存储H5页面 仅适用于单通道设备,如IPC,不建议使用
        覆盖:
        openCloudPage 在类中 EZOpenSDK
        参数:
        deviceSerial - 设备序列号
        抛出:
        BaseException - 调用失败的异常信息
      • openCloudPage

        public void openCloudPage​(java.lang.String deviceSerial,
                                  int cameraNo)
                           throws BaseException
        打开云存储H5页面
        覆盖:
        openCloudPage 在类中 EZOpenSDK
        参数:
        deviceSerial - 设备序列号
        cameraNo - camera序号,EZCameraInfo.cameraNo
        抛出:
        BaseException - 调用失败的异常信息
        从以下版本开始:
        4.8.8 增加camera序号
      • finiLib

        public static void finiLib()
        释放sdk资源
      • getVersion

        public static java.lang.String getVersion()
      • 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
        覆盖:
        setAccessToken 在类中 EZOpenSDK
        参数:
        accessToken - 授权登录获取的accessToken
      • getEZAccessToken

        public EZAccessToken getEZAccessToken()
        获取登录token
        覆盖:
        getEZAccessToken 在类中 EZOpenSDK
        返回:
        token包含2个字段, 一个是token string本身,另外一个表示过期时间,单位为秒
      • openLoginPage

        public void openLoginPage​(int areaId)
        打开授权登录中间页面,用于获取Accesstoken
        覆盖:
        openLoginPage 在类中 EZOpenSDK
        参数:
        areaId - 区域ID
      • openLoginPage

        public void openLoginPage​(int areaId,
                                  int flag)
        打开授权登录中间页面,用于获取Accesstoken
        参数:
        areaId - 区域ID
        flag - 页面跳转flag 类似Intent.FLAG_ACTIVITY_CLEAR_TOP
      • logout

        public void logout()
        登出账号
        覆盖:
        logout 在类中 EZOpenSDK
      • getDeviceList

        public java.util.List<EZDeviceInfo> getDeviceList​(int pageIndex,
                                                          int pageSize)
                                                   throws BaseException
        获取用户的设备列表,返回EZDeviceInfo的对象数组,只提供设备基础数据 该接口为耗时操作,建议放在线程中调用
        覆盖:
        getDeviceList 在类中 EZOpenSDK
        参数:
        pageIndex - 查询页index,从0开始
        pageSize - 每页数量(建议20以内)
        返回:
        返回的EZDeviceInfo
        抛出:
        BaseException
      • probeDeviceInfo

        public EZProbeDeviceInfo probeDeviceInfo​(java.lang.String deviceSerial)
                                          throws BaseException
        已过时。
        仅保留接口兼容老用户,请尽快换用EZProbeDeviceInfoResult probeDeviceInfo(String deviceSerial,String deviceType)
        尝试查询设备信息(用于添加设备之前, 简单查询设备信息,如是否在线,是否添加等) 该接口为耗时操作,建议放在线程中调用
        覆盖:
        probeDeviceInfo 在类中 EZOpenSDK
        参数:
        deviceSerial - 需要查询的设备序列号
        返回:
        返回 EZProbeDeviceInfo 对象,包含设备简单信息,用于添加目的
        抛出:
        BaseException
      • probeDeviceInfo

        public EZProbeDeviceInfoResult probeDeviceInfo​(java.lang.String deviceSerial,
                                                       java.lang.String deviceType)
        尝试查询设备信息(用于添加设备之前, 简单查询设备信息,如是否在线,是否添加等) 接口中有网络操作,需要在线程中调用
        覆盖:
        probeDeviceInfo 在类中 EZOpenSDK
        参数:
        deviceSerial - 需要查询的设备序列号
        deviceType - 设备型号 (设备型号和设备序列号不能均为空,优先按照设备序列号查询)
        返回:
        返回 EZProbeDeviceInfoResult 对象,包含查询的设备信息,以及异常情况
      • 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
        获取告警信息列表 接口中有网络操作,需要在线程中调用
        覆盖:
        getAlarmList 在类中 EZOpenSDK
        参数:
        deviceSerial - 设备序列号,为null时查询整个账户下的告警信息列表
        pageIndex - 分页当前页码(从0开始)
        pageSize - 分页每页数量(建议20以内)
        beginTime - 搜索时间范围开始时间,开始时间和结束时间可以同时为空
        endTime - 搜索时间范围结束时间
        返回:
        EZAlarmInfo对象列表
        抛出:
        BaseException
      • setAlarmStatus

        public boolean setAlarmStatus​(java.util.List<java.lang.String> alarmIdList,
                                      EZConstants.EZAlarmStatus alarmStatus)
                               throws BaseException
        设置告警为已读 接口中有网络操作,需要在线程中调用
        覆盖:
        setAlarmStatus 在类中 EZOpenSDK
        参数:
        alarmIdList - 告警信息Id数组(设置单条告警为已读时,数组中可以只有一个Id)
        alarmStatus - 告警状态,目前只支持设为已读功能 EZMessageStatusRead
        返回:
        true 表示成功, false 表示失败
        抛出:
        BaseException
      • deleteAlarm

        public boolean deleteAlarm​(java.util.List<java.lang.String> alarmIdList)
                            throws BaseException
        批量删除告警
        覆盖:
        deleteAlarm 在类中 EZOpenSDK
        参数:
        alarmIdList - 告警ID list
        返回:
        true 表示成功, false 表示失败
        抛出:
        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卡中录像 接口中有网络操作,需要在线程中调用
        覆盖:
        searchRecordFileFromDevice 在类中 EZOpenSDK
        参数:
        deviceSerial - 设备序列号
        cameraNo - camera的序号,EZCameraInfo.cameraNo
        startTime - 查询时间范围开始时间
        endTime - 查询时间范围结束时间
        返回:
        远程SD卡存储录像信息列表
        抛出:
        BaseException
      • addDevice

        public boolean addDevice​(java.lang.String deviceSerial,
                                 java.lang.String verifyCode)
                          throws BaseException
        添加设备 接口中有网络操作,需要在线程中调用
        覆盖:
        addDevice 在类中 EZOpenSDK
        参数:
        deviceSerial - 设备序列号
        verifyCode - 设备验证码,验证码位于设备机身上,6位大写字母
        返回:
        true 表示成功, false 表示失败
        抛出:
        BaseException
      • deleteDevice

        public boolean deleteDevice​(java.lang.String deviceSerial)
                             throws BaseException
        删除当前账号的设备 接口中有网络操作,需要在线程中调用
        覆盖:
        deleteDevice 在类中 EZOpenSDK
        参数:
        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 控制接口 接口中有网络操作,需要在线程中调用
        覆盖:
        controlPTZ 在类中 EZOpenSDK
        参数:
        deviceSerial - 设备序列号
        cameraNo - 通道号
        command - ptz控制命令
        action - 控制启动/停止
        speed - 速度(0-7)
        返回:
        操作成功或者失败(返回失败错误码)
        抛出:
        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
        镜像 控制设备视频画面翻转。在摄像头倒装的时候,调用此接口可让画面正过来 需要设备支持 该接口为耗时操作,必须在线程中调用
        覆盖:
        controlVideoFlip 在类中 EZOpenSDK
        参数:
        deviceSerial - 设备序列号
        cameraNo - camera的序号,EZCameraInfo.cameraNo
        command - ptz控制命令
        抛出:
        BaseException - exception 操作失败会抛出异常,错误码 exception.getErrorCode
      • decryptData

        public byte[] decryptData​(byte[] inputData,
                                  java.lang.String verifyCode,
                                  int cryptType)
        解密数据,该接口可以用于解密告警图片
        覆盖:
        decryptData 在类中 EZOpenSDK
        参数:
        inputData - 解密前数据
        verifyCode - 密码,设备加密时通常为设备验证码,平台加密时为平台返回的checkSum
        cryptType - 加密类型 1-设备加密 2-平台加密
      • setDefence

        public boolean setDefence​(java.lang.String deviceSerial,
                                  EZConstants.EZDefenceStatus defence)
                           throws BaseException
        设备设置布防状态,兼容A1和IPC设备的布防 接口中有网络操作,需要在线程中调用
        覆盖:
        setDefence 在类中 EZOpenSDK
        参数:
        deviceSerial - 设备序列号
        defence - 布防状态, 摄像机布防状态只有0和1,告警器有0:睡眠 8:在家 16:外出
        返回:
        抛出:
        BaseException
      • captureCamera

        public java.lang.String captureCamera​(java.lang.String deviceSerial,
                                              int channelNo)
                                       throws BaseException
        获取摄像头实时图片的url接口,需要设备支持,萤石设备一般都能支持此协议。(该功能和萤石云视频app首页刷新封面的功能一致) 该接口为耗时操作,建议放在线程中调用
        覆盖:
        captureCamera 在类中 EZOpenSDK
        参数:
        deviceSerial - 设备序列号
        channelNo - 通道号
        返回:
        图片url
        抛出:
        BaseException
      • getDeviceVersion

        public EZDeviceVersion getDeviceVersion​(java.lang.String deviceSerial)
                                         throws BaseException
        获取设备的版本信息接口 接口中有网络操作,需要在线程中调用
        覆盖:
        getDeviceVersion 在类中 EZOpenSDK
        参数:
        deviceSerial - 设备序列号
        返回:
        版本号EZDeviceVersion对象
        抛出:
        BaseException
      • setDeviceEncryptStatus

        public boolean setDeviceEncryptStatus​(java.lang.String deviceSerial,
                                              java.lang.String validateCode,
                                              boolean encrypt)
                                       throws BaseException
        设备视频图片加解密开关接口 接口中有网络操作,需要在线程中调用
        覆盖:
        setDeviceEncryptStatus 在类中 EZOpenSDK
        参数:
        deviceSerial - 设备序列号
        validateCode - 设备验证码,开启加密无需验证码
        encrypt - 是否加密
        返回:
        抛出:
        BaseException
      • setDeviceName

        public boolean setDeviceName​(java.lang.String deviceSerial,
                                     java.lang.String deviceName)
                              throws BaseException
        修改设备名称接口 接口中有网络操作,需要在线程中调用
        覆盖:
        setDeviceName 在类中 EZOpenSDK
        参数:
        deviceSerial - 设备序列号
        deviceName - 修改后的设备名称
        返回:
        true 表示成功, false 表示失败
        抛出:
        BaseException
      • getUserInfo

        public EZUserInfo getUserInfo()
                               throws BaseException
        获取用户信息;用户信息包含:用户名,头像地址等 接口中有网络操作,需要在线程中调用
        覆盖:
        getUserInfo 在类中 EZOpenSDK
        返回:
        返回 EZUserInfo 对象
        抛出:
        BaseException
      • getUnreadMessageCount

        public int getUnreadMessageCount​(java.lang.String deviceSerial,
                                         EZConstants.EZMessageType messageType)
                                  throws BaseException
        获取未读消息数 接口中有网络操作,需要在线程中调用
        覆盖:
        getUnreadMessageCount 在类中 EZOpenSDK
        参数:
        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
        获取留言消息列表,默认为止查询语音留言信息 该接口为耗时操作,建议放在线程中调用
        覆盖:
        getLeaveMessageList 在类中 EZOpenSDK
        参数:
        deviceSerial - 设备序列号(可为空),为空时返回账户下所有设备的留言消息
        pageIndex - 当前分页,从0开始
        pageSize - 分页大小
        beginTime - 开始时间
        endTime - 结束时间
        返回:
        留言EZLeaveMessage列表
        抛出:
        BaseException
      • setLeaveMessageStatus

        public boolean setLeaveMessageStatus​(java.util.List<java.lang.String> msgIdList,
                                             EZConstants.EZMessageStatus messageStatus)
                                      throws BaseException
        批量设置留言消息已读功能 该接口为耗时操作,建议放在线程中调用
        覆盖:
        setLeaveMessageStatus 在类中 EZOpenSDK
        参数:
        msgIdList - 留言消息Id数组(最大数量为10,允许只有1个)
        messageStatus - 需要设置的留言状态,目前只支持 EZMessageStatusRead(已读);
        返回:
        true 表示成功, false 表示失败
        抛出:
        BaseException
      • deleteLeaveMessages

        public boolean deleteLeaveMessages​(java.util.List<java.lang.String> msgIdList)
                                    throws BaseException
        批量删除留言消息 该接口为耗时操作,建议放在线程中调用
        覆盖:
        deleteLeaveMessages 在类中 EZOpenSDK
        参数:
        msgIdList - 留言消息Id数组(最大数量为10,允许只有1个)
        返回:
        true 表示成功, false 表示失败
        抛出:
        BaseException
      • getLeaveMessageData

        public void getLeaveMessageData​(android.os.Handler handler,
                                        EZLeaveMessage msg,
                                        EZOpenSDKListener.EZLeaveMessageFlowCallback callback)
        获取语音留言数据 该接口为耗时操作,建议放在线程中调用
        覆盖:
        getLeaveMessageData 在类中 EZOpenSDK
        参数:
        handler - handler,用于发送成功或者失败消息, 301:下载留言失败 ;302:下载留言成功 消息obj为留言ID
        msg - 留言消息
        callback - 获取留言消息数据回调
      • getStorageStatus

        public java.util.List<EZStorageStatus> getStorageStatus​(java.lang.String deviceSerial)
                                                         throws BaseException
        获取存储介质状态(如是否初始化,格式化进度等) 接口中有网络操作,需要在线程中调用
        覆盖:
        getStorageStatus 在类中 EZOpenSDK
        参数:
        deviceSerial - 需要获取的设备序列号
        返回:
        存储状态(EZStorageStatus)列表,列表每个item代表一个磁盘分区
        抛出:
        BaseException
      • formatStorage

        public boolean formatStorage​(java.lang.String deviceSerial,
                                     int partitionIndex)
                              throws BaseException
        格式化分区(SD卡) 接口中有网络操作,需要在线程中调用
        覆盖:
        formatStorage 在类中 EZOpenSDK
        参数:
        deviceSerial - 需要格式化的设备序列号
        partitionIndex - getStorageStatus查询返回的分区号
        返回:
        true 表示成功, false 表示失败
        抛出:
        BaseException
      • upgradeDevice

        public void upgradeDevice​(java.lang.String deviceSerial)
                           throws BaseException
        开始升级设备 接口中有网络操作,需要在线程中调用
        覆盖:
        upgradeDevice 在类中 EZOpenSDK
        参数:
        deviceSerial - 设备序列号
        抛出:
        BaseException
      • 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配置
        覆盖:
        startConfigWifi 在类中 EZOpenSDK
        参数:
        context - 应用 activity context
        deviceSerial - 配置设备序列号
        ssid - 连接WiFi SSID
        password - 连接 WiFi 密码
        mode - 配网的方式,EZWiFiConfigMode中列举的模式进行任意组合,例如:EZWiFiConfigMode.EZWiFiConfigSmart|EZWiFiConfigMode.EZWiFiConfigWave
        back - 配置回调
        从以下版本开始:
        4.3.0
      • startConfigWifi

        public boolean startConfigWifi​(android.content.Context context,
                                       java.lang.String ssid,
                                       java.lang.String password,
                                       com.hikvision.wifi.configuration.DeviceDiscoveryListener l)
        已过时。
        开始WiFi配置
        覆盖:
        startConfigWifi 在类中 EZOpenSDK
        参数:
        context - 应用 activity context
        ssid - 连接WiFi SSID
        password - 连接WiFi 密码
        l - 回调,用于处理连接设备的WiFi配置状态
        返回:
        返回值并没有特别的含义,根据回调判断是否配置wifi成功
      • stopConfigWiFi

        public boolean stopConfigWiFi()
        停止Wifi配置
        覆盖:
        stopConfigWiFi 在类中 EZOpenSDK
        返回:
        true 表示成功, false 表示失败
      • startAPConfigWifiWithSsid

        public void startAPConfigWifiWithSsid​(java.lang.String ssid,
                                              java.lang.String password,
                                              java.lang.String deviceSerial,
                                              java.lang.String verifyCode,
                                              APWifiConfig.APConfigCallback apConfigCallback)
        AP配网接口,默认为"EZVIZ_"+设备序列号,设备AP热点密码默认为"EZVIZ_"+设备验证码,默认自动连接设备热点,需要获取可扫描wifi的权限
        覆盖:
        startAPConfigWifiWithSsid 在类中 EZOpenSDK
        参数:
        ssid - WiFi的ssid
        password - WiFi的密码
        deviceSerial - 设备序列号
        verifyCode - 设备验证码
        apConfigCallback - 结果回调
      • startAPConfigWifiWithSsid

        public void startAPConfigWifiWithSsid​(java.lang.String ssid,
                                              java.lang.String password,
                                              java.lang.String deviceSerial,
                                              java.lang.String verifyCode,
                                              java.lang.String routerNamePre,
                                              java.lang.String routerPasswordPre,
                                              boolean isAutoConnectDeviceHotSpot,
                                              APWifiConfig.APConfigCallback apConfigCallback)
        AP配网接口
        覆盖:
        startAPConfigWifiWithSsid 在类中 EZOpenSDK
        参数:
        ssid - WiFi的ssid
        password - WiFi的密码
        deviceSerial - 设备序列号
        verifyCode - 设备验证码
        routerNamePre - 设备热点名称,可传空,默认为"EZVIZ_"+设备序列号
        routerPasswordPre - 设备热点密码,可传空,默认为"EZVIZ_"+设备验证码
        isAutoConnectDeviceHotSpot - 是否自动连接设备热点,需要获取可扫描wifi的权限
        apConfigCallback - 结果回调
      • createPlayerWithUrl

        public EZPlayer createPlayerWithUrl​(java.lang.String url)
        根据视频广场url构造EZPlayer对象,用于视频广场的视频播放
        覆盖:
        createPlayerWithUrl 在类中 EZOpenSDK
        参数:
        url - 广场视频url
        返回:
        EZPlayer对象
      • createPlayerWithUserId

        public EZPlayer createPlayerWithUserId​(int userId,
                                               int cameraNo,
                                               int streamType)
        创建局域网播放器
        覆盖:
        createPlayerWithUserId 在类中 EZOpenSDK
        参数:
        userId - 设备登录成功后的userId
        cameraNo - 设备预览的通道号
        streamType - 设备预览的码流类型 1:主码流;2:子码流
        返回:
      • createPlayer

        public EZPlayer createPlayer​(java.lang.String deviceSerial,
                                     int cameraNo)
        根据deviceSerial 和 cameraNo 构造EZPlayer对象
        覆盖:
        createPlayer 在类中 EZOpenSDK
        参数:
        deviceSerial -
        cameraNo -
        返回:
        EZPlayer对象
      • releasePlayer

        public void releasePlayer​(EZPlayer player)
        释放 EZPlayer 对象
        覆盖:
        releasePlayer 在类中 EZOpenSDK
        参数:
        player - 将要释放的EZPlayer对象
      • getSharedDeviceList

        public java.util.List<EZDeviceInfo> getSharedDeviceList​(int pageIndex,
                                                                int pageSize)
                                                         throws BaseException
        获取好友分享的设备列表,返回EZDeviceInfo的对象数组 该接口为耗时操作,建议放在线程中调用
        覆盖:
        getSharedDeviceList 在类中 EZOpenSDK
        参数:
        pageIndex - 分页起始页,从0开始
        pageSize - 分页每页数量(建议20以内)
        返回:
        抛出:
        BaseException
        从以下版本开始:
        4.2
      • setVideoLevel

        public boolean setVideoLevel​(java.lang.String deviceSerial,
                                     int cameraNo,
                                     int videoLevel)
                              throws BaseException
        设置指定监控点视频清晰度 接口中有网络操作,需要在线程中调用
        覆盖:
        setVideoLevel 在类中 EZOpenSDK
        参数:
        deviceSerial - 设备序列号
        cameraNo - 设备通道号,默认为1
        videoLevel - 清晰度 0-流畅 1-均衡 2-高品质
        返回:
        抛出:
        BaseException
      • getDeviceInfo

        public EZDeviceInfo getDeviceInfo​(java.lang.String deviceSerial)
                                   throws BaseException
        获取单个设备信息 该接口为耗时操作,建议放在线程中调用
        覆盖:
        getDeviceInfo 在类中 EZOpenSDK
        参数:
        deviceSerial - 设备序列号
        返回:
        设备信息对象EZDeviceInfo,与getDeviceList中对象一致
        抛出:
        BaseException
        从以下版本开始:
        4.3
      • getTerminalId

        public java.lang.String getTerminalId()
        获取终端(手机等)唯一识别码
        覆盖:
        getTerminalId 在类中 EZOpenSDK
        返回:
        终端唯一识别码
        从以下版本开始:
        4.3.0
      • clearStreamInfoCache

        public void clearStreamInfoCache()
        清除取流时的缓存数据
        覆盖:
        clearStreamInfoCache 在类中 EZOpenSDK
        从以下版本开始:
        4.5.0
      • getDDNSWithDeviceSerial

        public EZHiddnsDeviceInfo getDDNSWithDeviceSerial​(java.lang.String deviceSerial,
                                                          java.lang.String domain)
                                                   throws BaseException
        获取设备DDNS信息 该接口为耗时操作,建议放在线程中调用 设备序列号,deviceSerial和domain不能全为空, 如果deviceSerial和domain都不为空,优先查询deviceSerial设备的ddns信息
        参数:
        deviceSerial - 设备序列号
        domain - 设备域名
        抛出:
        BaseException
      • setDeviceDoamin

        public void setDeviceDoamin​(java.lang.String deviceSerial,
                                    java.lang.String domain)
                             throws BaseException
        设置设备DDNS域名 该接口为耗时操作,建议放在线程中调用 设备序列号,deviceSerial和domain不能为空,
        参数:
        deviceSerial - 设备序列号
        domain - 设备域名,设备域名规则修改,不能为空,6-32位,可以为本身序列号,包含小写字母、数字、-,首位必须字母,末位不能为-
        抛出:
        BaseException
      • setDDNSAutomatic

        public void setDDNSAutomatic​(java.lang.String deviceSerial)
                              throws BaseException
        设置设备DDNS自动映射 该接口为耗时操作,建议放在线程中调用
        参数:
        deviceSerial - 设备序列号
        抛出:
        BaseException
      • setDDNSManual

        public void setDDNSManual​(java.lang.String deviceSerial,
                                  int cmdPort,
                                  int httpPort)
                           throws BaseException
        设置设备DDNS手动映射 该接口为耗时操作,建议放在线程中调用
        参数:
        deviceSerial - 设备序列号
        cmdPort - cmd(服务)端口
        httpPort - http端口
        抛出:
        BaseException
      • getDDNSDeviceList

        public java.util.List<EZHiddnsDeviceInfo> getDDNSDeviceList​(int pageSize,
                                                                    int pageStart)
                                                             throws BaseException
        获取账户下所有设备列表DDNS信息 该接口为耗时操作,建议放在线程中调用
        参数:
        pageSize - 分页大小,默认为10,最大为50
        pageStart - 分页起始页,从0开始,默认为0
        抛出:
        BaseException
      • ShareDDNSDeviceList

        public void ShareDDNSDeviceList​(java.lang.String deviceSerial,
                                        java.lang.String account)
                                 throws BaseException
        分享设备DDNS信息,把单个设备的DDNS信息分享给其他账户 该接口为耗时操作,建议放在线程中调用
        参数:
        deviceSerial - 设备序列号
        account - 被分享账户,可以是邮箱地址或手机号码(包含国家代码)或不是全数字的用户名
        抛出:
        BaseException
      • getShareDDNSDeviceList

        public java.util.List<EZHiddnsDeviceInfo> getShareDDNSDeviceList​(int pageSize,
                                                                         int pageStart)
                                                                  throws BaseException
        获取当前账号下的所有的其它账户分享给自己的设备DDNS信息 该接口为耗时操作,建议放在线程中调用
        参数:
        pageSize - 分页大小,默认为10,最大为50
        pageStart - 分页起始页,从0开始,默认为0
        抛出:
        BaseException
      • isLogin

        public boolean isLogin()
        是否已登录授权
        覆盖:
        isLogin 在类中 EZOpenSDK
        从以下版本开始:
        4.8.3
      • setVparamForLoginPage

        public void setVparamForLoginPage​(java.lang.String vParam)
        设置登录页的v参数,用于控制登录页样式
        覆盖:
        setVparamForLoginPage 在类中 EZOpenSDK
        参数:
        vParam - 登录页样式(mobile-移动版、wap-pc版。。。)
        从以下版本开始:
        4.8.7
      • setServerUrl

        public void setServerUrl​(java.lang.String apiUrl,
                                 java.lang.String webUrl)
        切换到指定服务区域
        覆盖:
        setServerUrl 在类中 EZOpenSDK
        参数:
        apiUrl - 区域接口请求域名
        webUrl - 区域WEB登录域名(默认可不填写)
        从以下版本开始:
        4.11.0