EZOpenSDK  4.8.6
 全部 类 函数 属性
Class Methods | 所有成员列表
EZOpenSDK类 参考

此类为EZOpenSDK接口类 特别说明：110001（参数错误）、110002（AccessToken过期）、149999、150000（服务端异常）是所有http接口（返回值是NSOperation对象的大部分是http接口）都会返回的通用错误码，400002为接口参数错误的通用错误码 更多...

#import <EZOpenSDK.h>

类 EZOpenSDK 继承关系图:

Class Methods

(BOOL) + initLibWithAppKey:
 
(BOOL) + destoryLib
 
(NSString *) + getVersion
 
(void) + openLoginPage:
 
(void) + setAccessToken:
 
(void) + logout:
 
(NSOperation *) + deleteAlarm:completion:
 
(NSOperation *) + setAlarmStatus:alarmStatus:completion:
 
(NSOperation *) + deleteDevice:completion:
 
(BOOL) + startConfigWifi:password:deviceSerial:deviceStatus:
 
(BOOL) + stopConfigWifi
 
(NSOperation *) + controlPTZ:cameraNo:command:action:speed:result:
 
(void) + controlVideoFlip:cameraNo:command:result:
 
(EZPlayer *) + createPlayerWithDeviceSerial:cameraNo:
 
(EZPlayer *) + createPlayerWithUrl:
 
(BOOL) + releasePlayer:
 
(NSData *) + decryptData:verifyCode:
 
(NSOperation *) + getDeviceVersion:completion:
 
(NSOperation *) + setDeviceEncryptStatus:verifyCode:encrypt:completion:
 
(NSOperation *) + setDeviceName:deviceSerial:completion:
 
(NSOperation *) + getUserInfo:
 
(NSOperation *) + getUnreadMessageCount:messageType:completion:
 
(NSOperation *) + getLeaveMessageList:pageIndex:pageSize:beginTime:endTime:completion:
 
(NSOperation *) + setLeaveMessageStatus:messageStatus:completion:
 
(NSOperation *) + deleteLeaveMessage:completion:
 
(NSOperation *) + getStorageStatus:completion:
 
(NSOperation *) + formatStorage:storageIndex:completion:
 
(NSOperation *) + probeDeviceInfo:deviceType:completion:
 
(NSOperation *) + getDeviceUpgradeStatus:completion:
 
(NSOperation *) + upgradeDevice:completion:
 
(NSOperation *) + getLeaveMessageData:completion:
 
(void) + openCloudPage:
 
(void) + openChangePasswordPage:
 
(void) + enableP2P:
 
(BOOL) + setDebugLogEnable:
 
(NSOperation *) + getDeviceList:pageSize:completion:
 
(NSOperation *) + getSharedDeviceList:pageSize:completion:
 
(NSOperation *) + searchRecordFileFromCloud:cameraNo:beginTime:endTime:completion:
 
(NSOperation *) + searchRecordFileFromDevice:cameraNo:beginTime:endTime:completion:
 
(NSOperation *) + getAlarmList:pageIndex:pageSize:beginTime:endTime:completion:
 
(NSOperation *) + addDevice:verifyCode:completion:
 
(NSOperation *) + captureCamera:cameraNo:completion:
 
(NSOperation *) + setVideoLevel:cameraNo:videoLevel:completion:
 
(NSOperation *) + setDefence:deviceSerial:completion:
 
(NSOperation *) + getDeviceInfo:completion:
 
(NSString *) + getTerminalId
 
(void) + initPushService
 
(void) + clearStreamInfoCache
 
(BOOL) + isLogin
 
(NSString *) + getAccesstoken
 
(BOOL) + isEzvizAppInstalledWithType:
 
(BOOL) + ezvizLoginWithAppType:
 
(BOOL) + gotoEzvizAppPage:appType:
 
(BOOL) + handleOpenUrl:options:delegate:
 
(BOOL) + handleOpenUrl:delegate:
 
(BOOL) + handleOpenUrl:sourceApplication:annotation:delegate:
 
(BOOL) + startConfigWifi:password:deviceSerial:mode:deviceStatus:
 
(BOOL) + startAPConfigWifiWithSsid:password:deviceSerial:verifyCode:result:
 
(void) + stopAPConfigWifi
 

详细描述

此类为EZOpenSDK接口类 特别说明：110001（参数错误）、110002（AccessToken过期）、149999、150000（服务端异常）是所有http接口（返回值是NSOperation对象的大部分是http接口）都会返回的通用错误码，400002为接口参数错误的通用错误码

Method Documentation

+ (NSOperation *) addDevice: (NSString *)  deviceSerial
verifyCode: (NSString *)  verifyCode
completion: (void(^)(NSError *error))  completion 
自从
4.2.0 根据设备序列号和设备验证码添加设备接口
参数
deviceSerial设备序列号
verifyCode设备验证码
completion回调block，error为空时表示添加成功
返回
operation
+ (NSOperation *) captureCamera: (NSString *)  deviceSerial
cameraNo: (NSInteger)  cameraNo
completion: (void(^)(NSString *url, NSError *error))  completion 
自从
4.2.0 获取抓取摄像头图片的url接口
参数
deviceSerial设备序列号
cameraNo通道号
completion回调block，正常时返回url地址信息，错误时返回错误码
参见
该接口比较耗时，不建议进行批量设备抓图，SDK内部只支持6个http请求并发，该接口会持续占用http请求资源，如果遇到http请求延时巨大问题，优先考虑抓图接口并发造成的问题, 抓图将在服务器端保留2个小时
返回
operation
+ (void) clearStreamInfoCache

清除取流时的缓存数据

+ (NSOperation *) controlPTZ: (NSString *)  deviceSerial
cameraNo: (NSInteger)  cameraNo
command: (EZPTZCommand)  command
action: (EZPTZAction)  action
speed: (NSInteger)  speed
result: (void(^)(NSError *error))  resultBlock 
自从
3.0.0 PTZ 控制接口
参数
deviceSerial设备序列号
cameraNo通道号
commandptz控制命令
action控制启动/停止
speed云台速度：0-慢，1-适中，2-快
resultBlock回调block，当error为空时表示操作成功
返回
operation
+ (void) controlVideoFlip: (NSString *)  deviceSerial
cameraNo: (NSInteger)  cameraNo
command: (EZDisplayCommand)  command
result: (void(^)(NSError *error))  resultBlock 
自从
3.0.0 摄像头显示控制接口
参数
deviceSerial设备序列号
cameraNo通道号
command显示控制命令
resultBlock回调block，当error为空时表示操作成功
+ (EZPlayer *) createPlayerWithDeviceSerial: (NSString *)  deviceSerial
cameraNo: (NSInteger)  cameraNo 
自从
3.0.0 根据cameraId构造EZPlayer对象
参数
deviceSerial设备序列号
cameraNo通道号
返回
EZPlayer对象
+ (EZPlayer *) createPlayerWithUrl: (NSString *)  url
自从
3.0.0 根据url构造EZPlayer对象 （主要用来处理视频广场的播放）
参数
url播放url，目前只支持该协议：ysproto://vtm.ys7.com:8554/live?dev=531993276&chn=1&stream=1&cln=1&isp=0&biz=3
返回
EZPlayer对象
+ (NSData *) decryptData: (NSData *)  data
verifyCode: (NSString *)  verifyCode 
自从
3.1.0 数据解密
参数
data需要解密的数据
verifyCode设备验证码
返回
解密的NSData对象，如果返回的数据是空的，请检查密码是否正确或者传入的数据是否正确。
+ (NSOperation *) deleteAlarm: (NSArray *)  alarmIds
completion: (void(^)(NSError *error))  completion 
自从
3.0.0 根据alarmId删除告警信息接口
参数
alarmIds告警信息Id数组(可以只有一个Id)，最多为10个Id，否则会报错
completion回调block，error为空时表示删除成功
返回
operation
+ (NSOperation *) deleteDevice: (NSString *)  deviceSerial
completion: (void(^)(NSError *error))  completion 
自从
3.0.0 根据设备序列号删除当前账号的设备接口
参数
deviceSerial设备序列号
completion回调block，error为空时表示删除成功
参见
该接口与终端绑定功能相关，会遇到删除时报106002的错误，请关闭终端绑定以后再试
返回
operation
+ (NSOperation *) deleteLeaveMessage: (NSArray *)  leaveIds
completion: (void(^)(NSError *error))  completion 
自从
3.2.0 根据leaveId删除留言消息
参数
leaveIds留言消息Id数组(最大数量为10，允许只有1个)
completion回调block，error为空表示删除成功
返回
operation
+ (BOOL) destoryLib
自从
3.0.0 销毁EZOpenSDK接口
返回
YES/NO
+ (void) enableP2P: (BOOL)  enable
自从
4.0.0 设置p2p功能是否开启接口，默认不开启p2p，用户自己选择是否开启
参数
enablep2p是否开启
+ (BOOL) ezvizLoginWithAppType: (EZAppType)  appType

跳转到指定萤石APP进行授权登录

参数
appType萤石APP类型
返回
跳转结果
+ (NSOperation *) formatStorage: (NSString *)  deviceSerial
storageIndex: (NSInteger)  storageIndex
completion: (void(^)(NSError *error))  completion 
自从
3.2.0 根据设备序列号和分区编号格式化分区（SD卡）
参数
deviceSerial设备序列号
storageIndex查询返回的分区号，0表示全部格式化，可能会有几块硬盘的情况
completion回调block，error为空表示设置成功
返回
operation
+ (NSString *) getAccesstoken

获取当前accessToken

返回
accessToken
+ (NSOperation *) getAlarmList: (NSString *)  deviceSerial
pageIndex: (NSInteger)  pageIndex
pageSize: (NSInteger)  pageSize
beginTime: (NSDate *)  beginTime
endTime: (NSDate *)  endTime
completion: (void(^)(NSArray *alarmList, NSInteger totalCount, NSError *error))  completion 
自从
4.2.0 根据设备序列号获取告警信息列表，设备序列号为nil时查询整个账户下的告警信息列表
参数
deviceSerial设备序列号
pageIndex分页当前页码（从0开始）
pageSize分页每页数量（建议20以内）
beginTime搜索时间范围开始时间
endTime搜索时间范围结束时间
completion回调block，正常时返回EZAlarmInfo的对象数据和查询时间范围内的告警个数的总数，错误时返回错误码
返回
operation
+ (NSOperation *) getDeviceInfo: (NSString *)  deviceSerial
completion: (void(^)(EZDeviceInfo *deviceInfo, NSError *error))  completion 
自从
4.3.0 根据序列号获取设备信息
参数
deviceSerial设备序列号
completion回调block，正常时返回EZDeviceInfo的对象，错误时返回错误码
返回
operation
+ (NSOperation *) getDeviceList: (NSInteger)  pageIndex
pageSize: (NSInteger)  pageSize
completion: (void(^)(NSArray *deviceList, NSInteger totalCount, NSError *error))  completion 
自从
4.2.0 获取用户所有的设备列表
参数
pageIndex分页当前页码（从0开始）
pageSize分页每页数量（建议20以内）
completion回调block，正常时返回EZDeviceInfo的对象数组和设备总数，错误时返回错误码
返回
operation
+ (NSOperation *) getDeviceUpgradeStatus: (NSString *)  deviceSerial
completion: (void(^)(EZDeviceUpgradeStatus *status, NSError *error))  completion 
自从
3.2.0 根据设备序列号获取设备升级时的进度状态
参数
deviceSerial设备序列号
completion回调block，正常时返回EZDeviceUpgradeStatus对象，错误时返回错误码
返回
operation
+ (NSOperation *) getDeviceVersion: (NSString *)  deviceSerial
completion: (void(^)(EZDeviceVersion *version, NSError *error))  completion 
自从
3.2.0 获取设备的版本信息接口
参数
deviceSerial设备序列号
completion回调block，正常时返回EZDeviceVersion的对象信息，错误时返回错误码
返回
operation
+ (NSOperation *) getLeaveMessageData: (EZLeaveMessage *)  message
completion: (void(^)(NSData *data, NSInteger resultCode))  completion 
自从
3.2.0 根据EZLeaveMessage对象信息获取语音留言消息数据接口
参数
message留言消息对象
completion回调block （resultCode = 1 表示语音下载成功，-1表示下载失败）
返回
operation
+ (NSOperation *) getLeaveMessageList: (NSString *)  deviceSerial
pageIndex: (NSInteger)  pageIndex
pageSize: (NSInteger)  pageSize
beginTime: (NSDate *)  beginTime
endTime: (NSDate *)  endTime
completion: (void(^)(NSArray *leaveMessageList, NSInteger totalCount, NSError *error))  completion 
自从
3.2.0 根据设备序列号获取设备的留言消息列表
参数
deviceSerial需要获取的设备序列号
beginTime开始时间
endTime结束时间
pageIndex分页页码
pageSize分页单页数量
completion回调block，正常时返回EZLeaveMessage的对象数组，错误时返回错误码
返回
operation
+ (NSOperation *) getSharedDeviceList: (NSInteger)  pageIndex
pageSize: (NSInteger)  pageSize
completion: (void(^)(NSArray *deviceList, NSInteger totalCount, NSError *error))  completion 
自从
4.2.0 获取分享给用户的设备列表接口
参数
pageIndex分页当前页码（从0开始）
pageSize分页每页数量（建议20以内）
completion回调block，正常时返回EZDeviceInfo的对象数组和设备总数，错误时返回错误码
返回
operation
+ (NSOperation *) getStorageStatus: (NSString *)  deviceSerial
completion: (void(^)(NSArray *storageStatus, NSError *error))  completion 
自从
3.2.0 根据设备序列号获取存储介质状态(如是否初始化，格式化进度等)
参数
deviceSerial设备序列号
completion回调block，正常时返回EZStorageInfo的对象数组，错误时返回错误码
返回
operation
+ (NSString *) getTerminalId
自从
4.3.0 获取终端（手机等）唯一识别码
返回
终端唯一识别码
+ (NSOperation *) getUnreadMessageCount: (NSString *)  deviceSerial
messageType: (EZMessageType)  type
completion: (void(^)(NSInteger count, NSError *error))  completion 
自从
3.2.0 根据设备序列号获取未读消息数，设备序列号为空时获取所有设备的未读消息数
参数
deviceSerial需要获取的设备序列号，为空时返回账户下所有设备的未读消息数
type消息类型：EZMessageTypeAlarm 告警消息（1），EZMessageTypeLeave 留言消息（2）
completion回调block，正常时返回未读数量，错误时返回错误码
返回
operation
+ (NSOperation *) getUserInfo: (void(^)(EZUserInfo *userInfo, NSError *error))  completion
自从
3.2.0 获取用户基本信息的接口
参数
completion回调block， 正常时返回EZUserInfo的对象，错误时返回错误码
返回
operation
+ (NSString *) getVersion
自从
3.0.0 获取SDK版本号接口
返回
版本号
+ (BOOL) gotoEzvizAppPage: (EZAppPageType)  pageType
appType: (EZAppType)  appType 

跳转到指定APP的指定界面

参数
pageType界面类型
appTypeAPP类型
返回
跳转结果
+ (BOOL) handleOpenUrl: (NSURL *)  url
delegate: (id< EZOpenSDKDelegate >)  delegate 

外部跳转处理方法，适用于iOS8以下,包括iOS8

参数
url跳转过来的url
delegate委托
返回
结果
+ (BOOL) handleOpenUrl: (NSURL *)  url
options: (NSDictionary *)  opetions
delegate: (id< EZOpenSDKDelegate >)  delegate 

外部跳转处理方法，适用于iOS9以上，包括iOS9

参数
url跳转过来的url
opetions参数，默认为空，目前未进行处理，预留
delegate委托
返回
结果
+ (BOOL) handleOpenUrl: (NSURL *)  url
sourceApplication: (NSString *)  sourceApplication
annotation: (id)  annotation
delegate: (id< EZOpenSDKDelegate >)  delegate 

外部跳转处理方法，适用于iOS8以下,包括iOS8

参数
url跳转过来的url
sourceApplication源APP
annotation注释
delegate委托
返回
结果
+ (BOOL) initLibWithAppKey: (NSString *)  appKey
自从
3.0.0 实例EZOpenSDK接口
参数
appKey传入申请的appKey
返回
YES/NO
+ (void) initPushService
自从
4.4.0 push初始化接口，不需要push服务则无需调用
+ (BOOL) isEzvizAppInstalledWithType: (EZAppType)  appType

根据应用类型判断是否安装了对应的应用

参数
appType应用类型
返回
YES:已安装，NO:没有安装或安装的萤石APP版本过低
+ (BOOL) isLogin

是否已经登录

返回
YES：已经登录；NO：未登录
+ (void) logout: (void(^)(NSError *error))  completion
自从
3.0.0 账户注销接口
参数
completion回调block，error为空表示登出成功
+ (void) openChangePasswordPage: (void(^)(NSInteger resultCode))  completion
自从
3.3.0 打开修改密码中间页
参数
completion回调block resultCode为0时表示修改密码成功
+ (void) openCloudPage: (NSString *)  deviceSerial
自从
3.2.0 打开云存储中间页
参数
deviceSerial设备序列号
+ (void) openLoginPage: (void(^)(EZAccessToken *accessToken))  block
自从
3.0.0 打开授权登录中间页面接口
参数
block回调block
+ (NSOperation *) probeDeviceInfo: (NSString *)  deviceSerial
deviceType: (NSString *)  deviceType
completion: (void(^)(EZProbeDeviceInfo *deviceInfo, NSError *error))  completion 
自从
3.2.0 尝试查询设备信息，设备Wifi配置前查询一次设备的信息
参数
deviceSerial设备序列号
deviceType设备型号，无法获取到设备型号则可传nil
completion回调block，正常时返回EZProbeDeviceInfo对象，错误码返回错误码
参见
全新的设备是没有注册到平台的，所以会出现设备不存在的情况，设备wifi配置成功以后会上报数据到萤石云平台，以后每次查询就不会出现设备不存在的情况了。
返回
operation
+ (BOOL) releasePlayer: (EZPlayer *)  player
自从
3.0.0 释放EZPlayer对象
参数
playerEZPlayer对象
返回
YES/NO
+ (NSOperation *) searchRecordFileFromCloud: (NSString *)  deviceSerial
cameraNo: (NSInteger)  cameraNo
beginTime: (NSDate *)  beginTime
endTime: (NSDate *)  endTime
completion: (void(^)(NSArray *couldRecords, NSError *error))  completion 
自从
4.2.0 查询云存储录像信息列表接口
参数
deviceSerial设备序列号
cameraNo通道号
beginTime查询时间范围开始时间
endTime查询时间范围结束时间
completion回调block，正常时返回EZCloudRecordFile的对象数组，错误时返回错误码
返回
operation
+ (NSOperation *) searchRecordFileFromDevice: (NSString *)  deviceSerial
cameraNo: (NSInteger)  cameraNo
beginTime: (NSDate *)  beginTime
endTime: (NSDate *)  endTime
completion: (void(^)(NSArray *deviceRecords, NSError *error))  completion 
自从
4.2.0 查询远程SD卡存储录像信息列表接口
参数
deviceSerial设备序列号
cameraNo通道号
beginTime查询时间范围开始时间
endTime查询时间范围结束时间
completion回调block，正常时返回EZDeviceRecordFile的对象数组，错误时返回错误码
返回
operation
+ (void) setAccessToken: (NSString *)  accessToken
自从
3.0.0 授权登录以后给EZOpenSDK设置accessToken接口
参数
accessToken授权登录获取的accessToken
+ (NSOperation *) setAlarmStatus: (NSArray *)  alarmIds
alarmStatus: (EZMessageStatus)  status
completion: (void(^)(NSError *error))  completion 
自从
3.0.0 设置告警信息为已读接口
参数
alarmIds告警信息Id数组(可以只有一个Id)，最多为10个id,否则会报错
status告警消息状态
completion回调block，error为空时表示设置成功
返回
operation
+ (BOOL) setDebugLogEnable: (BOOL)  enable
自从
4.0.0 设置是否打印debug日志,需在初始化sdk之前调用
参数
enable是否打印日志，默认关闭
返回
YES/NO
+ (NSOperation *) setDefence: (EZDefenceStatus)  defence
deviceSerial: (NSString *)  deviceSerial
completion: (void(^)(NSError *error))  completion 
自从
4.2.0 设备设置布防状态，兼容A1和IPC设备的布防
参数
defence布防状态, IPC布防状态只有0和1，A1有0:睡眠 8:在家 16:外出
deviceSerial设备序列号
completion回调block，error为空表示设置成功
返回
operation
+ (NSOperation *) setDeviceEncryptStatus: (NSString *)  deviceSerial
verifyCode: (NSString *)  verifyCode
encrypt: (BOOL)  isEncrypt
completion: (void(^)(NSError *error))  completion 
自从
4.2.0 通过设备验证码开关视频图片加密接口
参数
isEncrypt是否加密，只有NO(关闭)的时候需要设备验证码的相关参数(vaildateCode)
deviceSerial设备序列号
verifyCode设备验证码
completion回调block，error为空时表示操作成功
返回
operation
+ (NSOperation *) setDeviceName: (NSString *)  deviceName
deviceSerial: (NSString *)  deviceSerial
completion: (void(^)(NSError *error))  completion 
自从
3.2.0 根据设备序列号修改设备名称接口
参数
deviceSerial设备序列号
deviceName设备名称
completion回调block，error为空时表示修改成功
返回
operation
+ (NSOperation *) setLeaveMessageStatus: (NSArray *)  leaveIds
messageStatus: (EZMessageStatus)  status
completion: (void(^)(NSError *error))  completion 
自从
3.2.0 根据leaveId设置留言消息状态
参数
leaveIds留言消息Id数组(最大数量为10，允许只有1个)
status需要设置的留言状态，目前只支持 EZMessageStatusRead(已读)
completion回调block，error为空表示设置成功
返回
operation
+ (NSOperation *) setVideoLevel: (NSString *)  deviceSerial
cameraNo: (NSInteger)  cameraNo
videoLevel: (EZVideoLevelType)  videoLevel
completion: (void(^)(NSError *error))  completion 
自从
4.2.0 设置设备通道的清晰度
参数
deviceSerial设备序列号
cameraNo通道号
videoLevel通道清晰度，0-流畅，1-均衡，2-高清，3-超清
completion回调block，无error表示设置成功
参见
如果是正在播放时调用该接口，设置清晰度成功以后必须让EZPlayer调用stopRealPlay再调用startRealPlay重新取流才成完成画面清晰度的切换。
返回
operation
+ (BOOL) startAPConfigWifiWithSsid: (NSString *)  ssid
password: (NSString *)  password
deviceSerial: (NSString *)  deviceSerial
verifyCode: (NSString *)  verifyCode
result: (void(^)(BOOL ret))  callback 

AP配网接口

参数
ssidWiFi的ssid
passwordWiFi的密码
deviceSerial设备序列号
verifyCode设备验证码
callback结果回调
返回
成功或失败
+ (BOOL) startConfigWifi: (NSString *)  ssid
password: (NSString *)  password
deviceSerial: (NSString *)  deviceSerial
deviceStatus: (void(^)(EZWifiConfigStatus status))  statusBlock 
自从
3.0.0 WiFi配置开始接口
参数
ssid连接WiFi SSID
password连接WiFi 密码
deviceSerial连接WiFi的设备的设备序列号
statusBlock返回连接设备的WiFi配置状态
返回
YES/NO
+ (BOOL) startConfigWifi: (NSString *)  ssid
password: (NSString *)  password
deviceSerial: (NSString *)  deviceSerial
mode: (NSInteger)  mode
deviceStatus: (void(^)(EZWifiConfigStatus status, NSString *deviceSerial))  statusBlock 
自从
4.8.3 WiFi配置开始接口
参数
ssid连接WiFi SSID
password连接WiFi 密码
deviceSerial连接WiFi的设备的设备序列号,批量配置时填nil
mode配网的方式，EZWiFiConfigMode中列举的模式进行任意组合,例如:EZWiFiConfigSmart|EZWiFiConfigWave
statusBlock返回设备序列号以及当前连接状态
返回
YES/NO
+ (void) stopAPConfigWifi

停止AP配网

+ (BOOL) stopConfigWifi
自从
3.0.0 Wifi配置停止接口
返回
YES/NO
+ (NSOperation *) upgradeDevice: (NSString *)  deviceSerial
completion: (void(^)(NSError *error))  completion 
自从
3.2.0 通过设备序列号对设备进行升级操作，前提是该设备有更新软件的提示
参数
deviceSerial设备序列号
completion回调block，error为空表示操作成功
返回
operation
该类的文档由以下文件生成:
生成于 2018年 十一月 30日 星期五 14:03:05 , 为 EZOpenSDK使用   doxygen 1.8.7