EZOpenSDK  v4.7.1
 All Classes Functions Properties
Class Methods | List of all members
EZGlobalSDK Class Reference

EZGlobalSDK API. Note: 110001 (parameter error), 110002 (AccessToken has expired), 149999, 150000 (server exception) are the general error code returned by the HTTP API (return value is NSOperation, for most of the HTTP API), 400002 is the general error code of parameter error. More...

#import <EZGlobalSDK.h>

Inheritance diagram for EZGlobalSDK:

Class Methods

(BOOL) + initLibWithAppKey:
 
(BOOL) + initLibWithAppKey:url:authUrl:
 
(void) + setAccessToken:
 
(BOOL) + destoryLib
 
(NSString *) + getVersion
 
(void) + enableP2P:
 
(NSOperation *) + getAreaList:
 
(void) + openLoginPage:completion:
 
(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:completion:
 
(NSOperation *) + getDeviceUpgradeStatus:completion:
 
(NSOperation *) + upgradeDevice:completion:
 
(NSOperation *) + getLeaveMessageData:completion:
 
(void) + openCloudPage:
 
(void) + openChangePasswordPage:
 
(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
 
(NSOperation *) + getHiddnsDeviceInfo:domain:completion:
 
(NSOperation *) + setHiddnsDomain:domain:completion:
 
(NSOperation *) + setHiddnsModeAuto:completion:
 
(NSOperation *) + setHiddnsModeManual:httpPort:cmdPort:completion:
 
(NSOperation *) + getHiddnsDeviceList:pageSize:completion:
 
(NSOperation *) + shareHiddnsDevice:account:completion:
 
(NSOperation *) + getShareHiddnsDeviceList:pageSize:completion:
 

Detailed Description

EZGlobalSDK API. Note: 110001 (parameter error), 110002 (AccessToken has expired), 149999, 150000 (server exception) are the general error code returned by the HTTP API (return value is NSOperation, for most of the HTTP API), 400002 is the general error code of parameter error.

Method Documentation

+ (NSOperation *) addDevice: (NSString *)  deviceSerial
verifyCode: (NSString *)  verifyCode
completion: (void(^)(NSError *error))  completion 
Since
1.0.0 Adding device according to device serial No. and verification code
Parameters
deviceSerialDevice serial No.
verifyCodeDevice verification code
completionCallback block. It indicates success when the error is empty
Exceptions
Errorcode type: 120002, 120006, 120007, 120008, 120014, refer to EZErrorCode in EZConstants header file for details
Returns
operation
+ (NSOperation *) captureCamera: (NSString *)  deviceSerial
cameraNo: (NSInteger)  cameraNo
completion: (void(^)(NSString *url, NSError *error))  completion 
Since
1.0.0 Getting captured picture URL
Parameters
deviceSerialDevice serial No.
cameraNoCamera No.
completionCallback block. URL address information will returned when normal, while error code will be returned when there is an error
Exceptions
Errorcode type: 120001, 120002, 120006, 120008, refer to EZErrorCode in EZConstants header file for details
See also
This API is time consuming, it's not suggested for a large amount of devices to capture at the same time. SDK supports sending only 6 HTTP request at the same time, and this API will occupy HTTP request resource continually. When HTTP request is seriously delayed, firstly consider if it caused by sending multiple API for capturing at the same time. Captured picture will be kept in server for 2 hours
Returns
operation
+ (void) clearStreamInfoCache

Clear cache of streaming

+ (NSOperation *) controlPTZ: (NSString *)  deviceSerial
cameraNo: (NSInteger)  cameraNo
command: (EZPTZCommand)  command
action: (EZPTZAction)  action
speed: (NSInteger)  speed
result: (void(^)(NSError *error))  resultBlock 
Since
1.0.0 PTZ control
Parameters
deviceSerialDevice serial No.
cameraNoCamera No.
commandPTZ control command
actionStart/ Stop
speedPTZ speed: ranges from 1 to 7, integer
resultBlockCallback block. It indicates success when the error is empty
Exceptions
Errorcode type: to be completed
+ (void) controlVideoFlip: (NSString *)  deviceSerial
cameraNo: (NSInteger)  cameraNo
command: (EZDisplayCommand)  command
result: (void(^)(NSError *error))  resultBlock 
Since
1.0.0 Controlling camera display
Parameters
deviceSerialDevice serial No.
cameraNoCamera No.
commandDisplay control command
resultBlockCallback block. It indicates success when the error is empty
Exceptions
Errorcode type: to be completed
+ (EZPlayer *) createPlayerWithDeviceSerial: (NSString *)  deviceSerial
cameraNo: (NSInteger)  cameraNo 
Since
1.0.0 Building EZPlayer according cameraId
Parameters
deviceSerialDevice serial No.
cameraNoCamera No.
Returns
EZPlayer
+ (EZPlayer *) createPlayerWithUrl: (NSString *)  url
Since
1.0.0 Build EZPlayer according to URL (mainly for Gallery playing)
Parameters
urlPlay URL
Returns
EZPlayer
+ (NSData *) decryptData: (NSData *)  data
verifyCode: (NSString *)  verifyCode 
Since
3.1.0 Data decryption
Parameters
dataData required to be decrypted
verifyCodeDevice verification code
Returns
Decrypted NSData
+ (NSOperation *) deleteAlarm: (NSArray *)  alarmIds
completion: (void(^)(NSError *error))  completion 
Since
1.0.0 Deleting alarm information according alarmId
Parameters
alarmIdsAlarm information ID array Max. number is 10, min. number is 1, otherwise an error will be reported
completionCallback block. It indicates deleting succeeded when the error is empty
Exceptions
Errorcode type: 110004, 120202, refer to EZErrorCode in EZConstants header file for details
Returns
operation
+ (NSOperation *) deleteDevice: (NSString *)  deviceSerial
completion: (void(^)(NSError *error))  completion 
Since
1.0.0 Deleting current account according to device serial No.
Parameters
deviceSerialDevice serial No.
completionCallback block. It indicates deleting succeeded when the error is empty
Exceptions
Errorcode type: 106002, refer to EZErrorCode in EZConstants header file for details
See also
This API is related to terminal binding. When the error 106002 is reported, disable the terminal binding and try again
Returns
operation
+ (NSOperation *) deleteLeaveMessage: (NSArray *)  leaveIds
completion: (void(^)(NSError *error))  completion 
Since
1.0.0 Deleting leave message according to leaveId
Parameters
leaveIdsLeave message ID array (max. number is 10, and min. number is 1)
completionCallback block. It indicates success when the error is empty
Exceptions
Errorcode type: 110004, 120202, refer to EZErrorCode in EZConstants header file for details
Returns
operation
+ (BOOL) destoryLib
Since
1.0.0 Destroying EZOpenSDK method
Returns
YES/NO
+ (void) enableP2P: (BOOL)  enable
Since
1.0.0 Configuring whether to enable P2P function. It is disabled by default, user can choose whether to enable
Parameters
enableWhether P2P is enabled
+ (NSOperation *) formatStorage: (NSString *)  deviceSerial
storageIndex: (NSInteger)  storageIndex
completion: (void(^)(NSError *error))  completion 
Since
1.0.0 Formatting partition according to device serial No. and partition No. (SD card)
Parameters
deviceSerialDevice serial No.
storageIndexSearch returned partition No.: 0- Formatting all, when there are several HDDs
completionCallback block. It indicates success when the error is empty
Exceptions
Errorcode type: 110004, 120002, 120006, 120007, 120008, 120014, 120016, 120018, refer to EZErrorCode in EZConstants header file for details
Returns
operation
+ (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 
Since
1.0.0 Getting alarm information list according to device serial No. It indicates to search all the alarm information list when the device serial No. is nil
Parameters
deviceSerialDevice serial No.
pageIndexPage No. (starts from 0)
pageSizeNumber of alarm information in each page (no more than 20)
beginTimeStart time, it can be empty, and nil indicates empty
endTimeEnd time, it can be empty, and nil indicates empty
completionCallback block. EZAlarmInfo data and alarm quantity of searched time range will be returned when normal, while error code will be returned when there is an error
Exceptions
Errorcode type: 110004, 120002, 120014, 120018, refer to EZErrorCode in EZConstants header file for details
Returns
operation
+ (NSOperation *) getAreaList: (void(^)(NSArray *areaList, NSError *error))  completion
Since
1.0.0 Getting area list
Parameters
completionCallback block
Exceptions
Errorcode type: to be completed
Returns
operation
+ (NSOperation *) getDeviceInfo: (NSString *)  deviceSerial
completion: (void(^)(EZDeviceInfo *deviceInfo, NSError *error))  completion 
Since
4.3.0 Getting device information according to serial No.
Parameters
deviceSerialDevice serial No.
completionCallback block. Returns EZDeviceInfo when it is normal, and returns error code when exception occurs
Returns
operation
+ (NSOperation *) getDeviceList: (NSInteger)  pageIndex
pageSize: (NSInteger)  pageSize
completion: (void(^)(NSArray *deviceList, NSInteger totalCount, NSError *error))  completion 
Since
1.0.0 Getting all the device list
Parameters
pageIndexCurrent page No. (starts from 0)
pageSizeNumber of device information in each page (no more than 20)
completionCallback block. EZDeviceInfo array and device quantity will be returned when normal, while error code will be returned when there is an error
Exceptions
Errorcode type: 110004, refer to EZErrorCode in EZConstants header file for details
Returns
operation
+ (NSOperation *) getDeviceUpgradeStatus: (NSString *)  deviceSerial
completion: (void(^)(EZDeviceUpgradeStatus *status, NSError *error))  completion 
Since
1.0.0 Getting device upgrade progress according to device serial No.
Parameters
deviceSerialDevice serial No.
completionCallback block. EZDeviceUpgradeStatus will be returned when normal, while error code will be returned when there is an error
Exceptions
Errorcode type: 120002, 120006, 120007, 120008, 120014, refer to EZErrorCode in EZConstants header file for details
Returns
operation
+ (NSOperation *) getDeviceVersion: (NSString *)  deviceSerial
completion: (void(^)(EZDeviceVersion *version, NSError *error))  completion 
Since
1.0.0 Getting device version information
Parameters
deviceSerialDevice serial No.
completionCallback block. The information of EZDeviceVersion will be returned, when normal1, while the error code will be returned, when there is an error
Exceptions
Errorcode type: 110004, 120002, 120014, 120018, refer to EZErrorCode in EZConstants header file for details
Returns
operation
+ (NSOperation *) getHiddnsDeviceInfo: (NSString *)  deviceSerial
domain: (NSString *)  domain
completion: (void(^)(EZHiddnsDeviceInfo *ddnsDeviceInfo, NSError *error))  completion 

Getting ddns information according to device serial No. and device domain name

Parameters
deviceSerialDevice serial No.
domainDevice domain name
completionCallback block
Returns
operation
+ (NSOperation *) getHiddnsDeviceList: (NSInteger)  pageIndex
pageSize: (NSInteger)  pageSize
completion: (void(^)(NSArray *ddnsDeviceList, NSInteger totalCount, NSError *error))  completion 

Getting DDNS information of all the devices under this account

Parameters
pageIndexStart page No., starts from 0 by default
pageSizeDDNS information quantity of each page, it is 10 by default, and max. number is 50
completionCallback block EZHiddnsDeviceInfo in ddnsDeviceList
Returns
operation
+ (NSOperation *) getLeaveMessageData: (EZLeaveMessage *)  message
completion: (void(^)(NSData *data, NSInteger resultCode))  completion 
Since
1.0.0 Getting voice message data according to EZLeaveMessage information
Parameters
messageLeave message
completionCallback block, resultCode= 1 indicates downloading succeeded, -1 indicates downloading failed)
Returns
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 
Since
1.0.0 Getting leave message list according to device serial No.
Parameters
deviceSerialDevice serial No.
beginTimeStart time
endTimeEnd time
pageIndexPage No.
pageSizeNumber of message information in each page
completionCallback block. EZLeaveMessage array will be returned when normal, while error code will be return when there is an error
Exceptions
Errorcode type: 110004, 120002, 120014, 120018, 120202, refer to EZErrorCode in EZConstants header file for details
Returns
operation
+ (NSOperation *) getSharedDeviceList: (NSInteger)  pageIndex
pageSize: (NSInteger)  pageSize
completion: (void(^)(NSArray *deviceList, NSInteger totalCount, NSError *error))  completion 
Since
1.0.0 Getting shared device list
Parameters
pageIndexCurrent page No. (starts from 0)
pageSizeNumber of device information in each page (no more tha 20)
completionCallback block. EZDeviceInfo array and device quantity will be returned when normal, while error code will be returned when there is an error
Exceptions
Errorcode type: 110004, refer to EZErrorCode in EZConstants header file for details
Returns
operation
+ (NSOperation *) getShareHiddnsDeviceList: (NSInteger)  pageIndex
pageSize: (NSInteger)  pageSize
completion: (void(^)(NSArray *ddnsDeviceList, NSInteger totalCount, NSError *error))  completion 

Getting DDNS information of all the devices shared by other account

Parameters
pageIndexStart page No., starts from 0 by default
pageSizeDDNS information quantity of each page, it is 10 by default, and max. quantity is 50
completionCallback block, EZHiddnsDeviceInfo in ddnsDeviceList
Returns
operation
+ (NSOperation *) getStorageStatus: (NSString *)  deviceSerial
completion: (void(^)(NSArray *storageStatus, NSError *error))  completion 
Since
1.0.0 Getting storage device status according to device serial No. (e.g. whether it has been initialized, and the formatting progress)
Parameters
deviceSerialDevice serial No.
completionCallback block. EZStorageInfo array will be returned when normal, while error code will be returned when there is an error
Exceptions
Errorcode type: 110004, 120002, 120006, 120007, 120008, 120014, 120018, refer to EZErrorCode in EZConstants header file for details
Returns
operation
+ (NSString *) getTerminalId
Since
4.3.0 Getting unique ID of terminal
Returns
Terminal unique ID
+ (NSOperation *) getUnreadMessageCount: (NSString *)  deviceSerial
messageType: (EZMessageType)  type
completion: (void(^)(NSInteger count, NSError *error))  completion 
Since
1.0.0 Getting unread message quantity according to device serial No. When device serial No. is empty, get unread message quantity of all the devices
Parameters
deviceSerialDevice serial No. When it is empty, the unread message quantity of all the devices will be returned
typeMessage type: EZMessageTypeAlarm alarm message (1), EZMessageTypeLeave leave message (2)
completionCallback block. Unread message quantity will be returned when normal, while error code will be returned when there is an error
Exceptions
Errorcode type: 110004, 120002, 120014, 120018, 120202, refer to EZErrorCode in EZConstants header file for details
Returns
operation
+ (NSOperation *) getUserInfo: (void(^)(EZUserInfo *userInfo, NSError *error))  completion
Since
1.0.0 Getting user basic information
Parameters
completionCallback block. EZUserInfo will be returned when normal, while error code will be returned when there is an error
Exceptions
Errorcode type: 110004, refer to EZErrorCode in EZConstants header file for details
Returns
operation
+ (NSString *) getVersion
Since
1.0.0 Getting SDK version No.
Returns
Version No.
+ (BOOL) initLibWithAppKey: (NSString *)  appKey
Since
4.4.0 Instance EZOpenSDK API
Parameters
appKeyInput requested appKey
Returns
YES/NO
+ (BOOL) initLibWithAppKey: (NSString *)  appKey
url: (NSString *)  url
authUrl: (NSString *)  authUrl 

Instance EZOpenSDK API,select specially api url and auth url

Parameters
appKeyInput requested appKey
urlapi url
authUrlauth url
Returns
YES/NO
+ (void) initPushService
Since
4.4.0 push initialization API. No need to call it when push service is not required
+ (void) logout: (void(^)(NSError *error))  completion
Since
1.0.0 Logging out
Parameters
completionCallback block. It indicates success when the error is empty
Exceptions
Errorcode type: to be completed
+ (void) openChangePasswordPage: (void(^)(NSInteger resultCode))  completion
Since
1.0.0 Opening password editing page
Parameters
completionCallback block, resultCode=0 indicates editing password succeeded
+ (void) openCloudPage: (NSString *)  deviceSerial
Since
1.0.0 Opening cloud storage page
Parameters
deviceSerialDevice serial No.
+ (void) openLoginPage: (NSString *)  areaId
completion: (void(^)(EZAccessToken *accessToken))  block 
Since
1.0.0 Opening authorized login page
Parameters
blockCallback block
+ (NSOperation *) probeDeviceInfo: (NSString *)  deviceSerial
completion: (void(^)(EZProbeDeviceInfo *deviceInfo, NSError *error))  completion 
Since
1.0.0 Search device information before configuring Wi-Fi
Parameters
deviceSerialDevice serial No.
completionCallback block, EZProbeDeviceInfo will be returned when normal, while error code will be returned when there is an error
Exceptions
Errorcode type: 110004, 120002, 120014, 120020, 120021, 120022, 120023, 120024, 120029, refer to EZErrorCode in EZConstants header file for details
See also
Since the new device is not registered, so the search result that the device does not exist may be returned. When the device Wi-Fi is configured successfully, the data will be reported to the system, and such situation won't occur.
Returns
operation
+ (BOOL) releasePlayer: (EZPlayer *)  player
Since
1.0.0 Release EZPlayer
Parameters
playerEZPlayer
Returns
YES/NO
+ (NSOperation *) searchRecordFileFromCloud: (NSString *)  deviceSerial
cameraNo: (NSInteger)  cameraNo
beginTime: (NSDate *)  beginTime
endTime: (NSDate *)  endTime
completion: (void(^)(NSArray *couldRecords, NSError *error))  completion 
Since
1.0.0 Searching cloud storage video information list
Parameters
deviceSerialDevice serial No.
cameraNoCamera No.
beginTimeStart time
endTimeEnd time
completionCallback block. EZCloudRecordFile array will be returned when normal, while error code will be returned when there is an error
Exceptions
Errorcode type: to be completed
Returns
operation
+ (NSOperation *) searchRecordFileFromDevice: (NSString *)  deviceSerial
cameraNo: (NSInteger)  cameraNo
beginTime: (NSDate *)  beginTime
endTime: (NSDate *)  endTime
completion: (void(^)(NSArray *deviceRecords, NSError *error))  completion 
Since
1.0.0 Searching storage video information list of remote SD card
Parameters
deviceSerialDevice serial No.
cameraNoCamera No.
beginTimeStart time
endTimeEnd time
completionCallback block. EZDeviceRecordFile array will be returned when normal, while error code will be returned when there is an error
Exceptions
Errorcode type:
Returns
operation
+ (void) setAccessToken: (NSString *)  accessToken
Since
1.0.0 Configuring accessToken for EZOpenSDK after authorized login
Parameters
accessTokenReceived accessToken after authorized login
+ (NSOperation *) setAlarmStatus: (NSArray *)  alarmIds
alarmStatus: (EZMessageStatus)  status
completion: (void(^)(NSError *error))  completion 
Since
1.0.0 Configuring the alarm information as read
Parameters
alarmIdsAlarm information ID array. Max. number is 10, min. number is 1, otherwise an error will be reported
statusAlarm information status
completionCallback block. It indicates success when the error is empty
Exceptions
Errorcode type: 110004, 120202, refer to EZErrorCode in EZConstants header file for details
Returns
operation
+ (BOOL) setDebugLogEnable: (BOOL)  enable
Since
1.0.0 Configuring whether to print debug log
Parameters
enableWhether to print log, it's disabled by default
Returns
YES/NO
+ (NSOperation *) setDefence: (EZDefenceStatus)  defence
deviceSerial: (NSString *)  deviceSerial
completion: (void(^)(NSError *error))  completion 
Since
1.0.0 Device arming status, which is compatible with security control panel and network camera
Parameters
defenceArming status. For network camera: 0 and 1, while for security control panel: 0- Sleeping, 8- At home, 16- Leaving home
deviceSerialDevice serial No.
completionCallback block. It indicates success when there is no error
Exceptions
Errorcode type: 110004, 120002, 120014, 120018, Refer to EZErrorCode in EZOpenSDK header file for details
Returns
operation
+ (NSOperation *) setDeviceEncryptStatus: (NSString *)  deviceSerial
verifyCode: (NSString *)  verifyCode
encrypt: (BOOL)  isEncrypt
completion: (void(^)(NSError *error))  completion 
Since
1.0.0 Enabling and disabling encryption of video and picture via device verification code
Parameters
isEncryptWhether to encrypt. Device verification code is required only when disabling encryption(vaildateCode)
deviceSerialDevice serial No.
verifyCodeDevice verification code
completionCallback block. It indicates success when the error is empty
Exceptions
Errorcode type: 110004, 120002, 120006, 120007, 120008, 120014, 120018, refer to EZErrorCode in EZConstants header file for details
Returns
operation
+ (NSOperation *) setDeviceName: (NSString *)  deviceName
deviceSerial: (NSString *)  deviceSerial
completion: (void(^)(NSError *error))  completion 
Since
1.0.0 Editing device name according to device serial No.
Parameters
deviceSerialDevice serial No.
deviceNameDevice name
completionCallback block. It indicates success when the error is empty
Exceptions
Errorcode type: 110004, 120002, 120014, 120018, refer to EZErrorCode in EZConstants header file for details
Returns
operation
+ (NSOperation *) setHiddnsDomain: (NSString *)  deviceSerial
domain: (NSString *)  domain
completion: (void(^)(NSError *error))  completion 

This API is used to configure the ddns domain name for device, including the shared device

Parameters
deviceSerialDevice serial No.
domainDevice domain name. Domain name edition rule: it cannot be empty, 6 to 32 bits, contains lowercase letter, number, and -, first one must be a letter, and last one cannot be -.
completionCallback block
Returns
operation
+ (NSOperation *) setHiddnsModeAuto: (NSString *)  deviceSerial
completion: (void(^)(NSError *error))  completion 

Configure the device DDNS mapping mode as automatic

Parameters
deviceSerialDevice serial No.
completionCallback block
Returns
operation
+ (NSOperation *) setHiddnsModeManual: (NSString *)  deviceSerial
httpPort: (NSInteger)  httpPort
cmdPort: (NSInteger)  cmdPort
completion: (void(^)(NSError *error))  completion 

Configure the device DDNS mapping mode as manual

Parameters
deviceSerialDevice serial No.
httpPorthttp port
cmdPortcommand port
completionCallback block
Returns
operation
+ (NSOperation *) setLeaveMessageStatus: (NSArray *)  leaveIds
messageStatus: (EZMessageStatus)  status
completion: (void(^)(NSError *error))  completion 
Since
1.0.0 Configuring leave message status according to leaveId
Parameters
leaveIdsLeave message ID array (max. number is 10, and min. number is 1)
statusLeave message status, which requires to be configured. Only supports EZMessageStatusRead (read)
completionCallback block. It indicates success when the error is empty
Exceptions
Errorcode type: 110004, 120202, refer to EZErrorCode in EZConstants header file for details
Returns
operation
+ (NSOperation *) setVideoLevel: (NSString *)  deviceSerial
cameraNo: (NSInteger)  cameraNo
videoLevel: (NSInteger)  videoLevel
completion: (void(^)(NSError *error))  completion 
Since
1.0.0 Device channel definition
Parameters
deviceSerialDevice serial No.
cameraNoCamera No.
videoLevelChannel definition:
completionCallback block. It indicates success when there is no error
See also
If you call this API during playing, after configuring the definition, EZPlayer should call stopRealPlay and then call startRealPlay for streaming again to complete switching definition
Returns
operation
+ (NSOperation *) shareHiddnsDevice: (NSString *)  deviceSerial
account: (NSString *)  account
completion: (void(^)(NSError *error))  completion 

Sharing DDNS information of the device with other account

Parameters
deviceSerialDevice serial No.
accountAccount to receive shared information, it can be email address, or mobile phone(including dialling code) , or user name which is not 被分享账户, 可以是邮箱地址或手机号码(包含国家代码)或不是全数字的用户名
completionCallback block
Returns
operation
+ (BOOL) startConfigWifi: (NSString *)  ssid
password: (NSString *)  password
deviceSerial: (NSString *)  deviceSerial
deviceStatus: (void(^)(EZWifiConfigStatus status))  statusBlock 
Since
1.0.0 Starting Wi-Fi configuration
Parameters
ssidWi-Fi connection SSID
passwordWi-Fi connection password
deviceSerialSerial No. of device connected to Wi-Fi
statusBlockReturn Wi-Fi configuration status of connected device
Returns
YES/NO
+ (BOOL) stopConfigWifi
Since
1.0.0 Stopping Wi-Fi configuration
Returns
YES/NO
+ (NSOperation *) upgradeDevice: (NSString *)  deviceSerial
completion: (void(^)(NSError *error))  completion 
Since
1.0.0 Upgrade the device according to device serial No., on condition that there is a prompt to upgrade for the device
Parameters
deviceSerialDevice serial No.
completionCallback block. It indicates success when the error is empty
Exceptions
Errorcode type: 120002, 120006, 120007, 120008, 120014, refer to EZErrorCode in EZConstants header file for details
Returns
operation

The documentation for this class was generated from the following file: