DeviceAPI class

Constructors

DeviceAPI()

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

findAllRecordFile({required List<Map<String, dynamic>> list, required String deviceId, required DevRecordParam param, required RecordFileOrder order}) → Future<List<Map<String, dynamic>>>
findCloudRecordFile({required CloudRecordByTime param, required List<Map<String, dynamic>> list}) → Future<List<Map<String, dynamic>>>
getRecrdParam({required RecordFileOrder order, required List<Map<String, dynamic>> list, required DevRecordParam param}) → DevRecordParam
生成新的查询录像文件的json对象
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
obtainArrangementMethod({required List<Map<String, dynamic>> list}) → RecordFileOrder
ascendingOrder录像段文件是从时间点小的到时间点大的开始排序还是反过来的
toString() → String
A string representation of this object.
inherited
xcAddSharedDeviceInfoToDC(DevAdd device) → Future<void>
将设备信息缓存到SDK(分享设备)
xcDeleteDevsInfo({required String deviceIds}) → Future<void>
从SDK本地缓存中清除设备信息 szDevIds设备序列号，支持批量，用';'隔开
xcDevClearPreset({required String deviceId, required int channel, required int preset}) → Future<int>
删除预置点 deviceId 设备id channel通道号 preset 预置点id
xcDevDeleteDevPtzTour({required String deviceId, required int channel, required int tourIndex}) → Future<int>
删除巡航路线 deviceId设备id channel 通道 tourIndex 巡航点id.
xcDevGetChnConfig({required String deviceId, required int channelNo, required String commandName, required int command, required int timeout}) → Future<Map<String, dynamic>>
获取设备通道配置 deviceId序列号 channelNo通达号 commandName配置命令字 command消息ID 通用配置1042 timeout超时时间 seq索引，自定义值 return code:0 , data:function byteStream:json数据
xcDevGetCurNetType({required String deviceId}) → Future<int>
@brief 获取当前设备网络类型（同步接口） @param szDevId 设备序列号或IP+Port @return >=0:对应不同类型;<0:未登录状态。对应EDEV_CNN_TYPE
xcDevGetLocalPassword({required String deviceId}) → Future<String>
获取本地缓存设备登录密码 deviceId序列号
xcDevGetLocalUserName({required String deviceId}) → Future<String>
获取本地缓存设备登录名 deviceId序列号
xcDevGetSysConfig({required String deviceId, required String commandName, int command = 1042, int timeout = 15000}) → Future<Map<String, dynamic>>
获取设备系统配置 deviceId序列号 commandName配置命令字 command消息ID 通用配置1042 timeout超时时间 seq索引，自定义值 return code:0 , str:function data:json数据
xcDevGotoPreset({required String deviceId, required int channel, required int preset}) → Future<int>
跳转到预置点,点击某个预置点 deviceId 设备id channel通道号 preset 预置点id
xcDeviceCheckOldPwdIsCorrect({required String deviceId, required String oldPwd, required String deviceLoginName}) → Future<bool>
验证老密码正确
xcDeviceCheckPwdQuestion({required String deviceId, required String answer1, required String answer2}) → Future
验证密保问题
xcDeviceIsSearched({required String deviceId}) → Future<bool>
同步接口,判断设备是否在局域网搜索过,搜索过的话 预览高清
xcDeviceLogin({required String deviceId}) → Future<bool>
登陆设备 deviceId 设备序列号 or ip+port userName 用户名 pwd 密码 seq 自定义值 return code:0
xcDevicePwdHadSetQuestionList({required String deviceId}) → Future
获取设备密码已经设置的安全问题及答案
xcDevicePwdQuestionList({required String deviceId}) → Future<Map>
获取设备密码问题列表 SetSafeQuestionManager.h .m iOS参考
xcDeviceResetPwd({required String deviceId, required String oldPwd, required String newPwd, required String deviceLoginName}) → Future<bool>
旧密码验证通过后，重置设备密码
xcDeviceResetPwdNotLogin({required String deviceId, required String userName, required String pwd}) → Future
密保问题通过后，重置设备密码
xcDeviceSafeAbility({required String deviceId}) → Future<Map>
获取设备安全能力级 GetSafetyAbility 设备安全能力级 getSafetyAbility?.question; //是否支持通过问题找回答案 getSafetyAbility?.verifyQRCode; //是否支持通过扫码找回答案
xcDeviceSafeAbilityNotLogin({required String deviceId}) → Future<Map>
获取设备安全能力级(未登录的情况) GetSafetyAbility 设备安全能力级 getSafetyAbility?.question; //是否支持通过问题找回答案 getSafetyAbility?.verifyQRCode; //是否支持通过扫码找回答案
xcDeviceSDCalendar({required String deviceId, required DateTime monthDateTime, required String fileType, required String eventType, String rev = '', int timeout = 5000}) → Future<List<String>>
查询设备端媒体日历(SD卡) deviceId 设备序列号或IP+Port monthDateTime 查询日期，到月即可 eg:DateTime(2023,6) fileType 媒体文件类型 mp4：MP4录像，jpg：图片， idximg：索引图片， h264：录像 eventType 事件类型
xcDeviceSetLanguage({required String deviceId, required String language}) → Future<bool>
设置设备语言 return 设置是否成功
xcDeviceSleep({required String deviceId}) → Future<void>
设备休眠. 没有回调,默认成功, 业务上过 6s 重新获取状态
xcDeviceSupportLanguage({required String deviceId}) → Future<List<String>>
查询设备支持的语言列表 return eg:====> [ ：nglish ：impChinese ：hineseEnglish ：panish ：
xcDeviceSystemConfigNotLogin({required String deviceId, required String commandName, required String configJs, required int configJsLength, required int cmdReq, required int timeout}) → Future
设备系统配置操作（不登录） deviceId 设备序列号或IP+Port commandName 配置命令字 configJs 设置的Json数据 configJsLength 设置的Json数据长度 nCmdReq 消息值 nTimeout 超时时间 nSeq 自定义值
xcDeviceSystemFunctionAbility({required String deviceId}) → Future<Map>
获取设备能力级
xcDeviceWakeup({required String deviceId, int timeout = 15000}) → Future<int>
设备唤醒 deviceId 设备序列号 timeout 超时时间
xcDevSetChnConfig({required String deviceId, required int channelNo, required String commandName, required String config, required int configLen, required int command, required int timeout}) → Future<int>
设置设备通道配置 deviceId序列号 channelNo通达号 commandName配置命令字 config设置的Json数据 configLen设置的Json数据长度 command消息ID 通用配置1040 timeout超时时间 seq索引，自定义值 return code:0 , data:function byteStream:json数据
xcDevSetPreset({required String deviceId, required int channel, required int preset}) → Future<int>
设置(添加)预置点 deviceId 设备id channel通道号 preset 预置点id
xcDevSetPtzTourPoint({required String deviceId, required int channel, required int presetPoint, required int tourIndex, int step = 1, bool add = true}) → Future<int>
把预置点设置为巡航点 deviceId设备id channel 通道 presetPoint 预置点id tourIndex 巡航点id. 从 0 开始,app自定义 add 增加 或 删除
xcDevSetSysConfig({required String deviceId, required String commandName, required String config, required int configLen, required int command, required int timeout}) → Future<int>
设置设备系统配置 deviceId序列号 commandName配置命令字 config设置的Json数据 configLen设置的Json数据长度 command消息ID 通用配置1040 timeout超时时间 seq索引，自定义值 return code:0 , str:function data:json数据
xcDevSetSysConfigWithPData({required String deviceId, required String commandName, required String config, required int configLen, required int command, required int timeout}) → Future<Map>
设置设备系统配置 deviceId序列号 commandName配置命令字 config设置的Json数据 configLen设置的Json数据长度 command消息ID 通用配置1040 timeout超时时间 seq索引，自定义值 return code:0 , str:function data:json数据
xcDevStartPtzTour({required String deviceId, required int channel, required int tourIndex, int times = 1}) → Future<int>
开始巡航 deviceId设备id channel 通道 tourIndex 巡航点id.
xcDevStopPtzTour({required String deviceId, required int channel, required int tourIndex}) → Future<int>
停止巡航 deviceId设备id channel 通道 tourIndex 巡航点id.
xcFindAllCloudRecordFile({required CloudRecordByTime param}) → Future<List<Map<String, dynamic>>>
云回放查找录像文件,时间段内所有文件录像一次性返回，递归去查 param CloudRecordByTime seq 可选 return Map
xcFindAllRecordFile({required String deviceId, required DevRecordParam param}) → Future<List<Map<String, dynamic>>>
查询整段时间段内所有录像文件 录像文件录像文件名,和时间轴联动,展示缩略图 deviceId设备序列号 or ip+port param json参数 seq 自定义值 return str:jsonName data:json数据
xcFindCloudRecordAxis({required CloudRecordAXis param}) → Future<Map<String, dynamic>>
云回放查找录像文件 param CloudRecordByTime seq 可选 return Map
xcFindCloudRecordFile({required CloudRecordByTime param}) → Future<List<Map<String, dynamic>>>
云回放查找录像文件,一次最多返回500条，剩下录像文件还需要再次查询(用最后一条报警消息的结束时间+1) param CloudRecordByTime seq 可选 return Map
xcFindRecordFile({required String deviceId, required DevRecordParam param}) → Future<List<Map<String, dynamic>>>
查询整段时间段内录像文件,最多返回500条,录像文件录像文件名,和时间轴联动,展示缩略图 deviceId设备序列号 or ip+port param json参数 seq 自定义值 return str:jsonName data:json数据
xcFindRecordFileByTime({required String deviceId, required DevRecordByTimeParam param}) → Future<List<int>>
查询一个时间段内每一分钟 录像 是否有录像,录像类型,用于绘制时间轴 deviceId 设备序列号 or ip+port paramjson参数 seq 自定义值 return code:0 byteData:1,1,10,0,0,0
xcFormatDevFileRecord({required String jsonName, required Map<String, dynamic> data}) → List<Map<String, dynamic>>
xcGetDeviceAppBindFlag({required String deviceId}) → Future<int>
获取app绑定标志 return Future
xcGetDeviceInfo({required String deviceId, required String type}) → Future<String>
查询设备信息 deviceId 设备序列号或IP+Port type 目前支持 SystemInfo 、 SystemFunction
xcGetDeviceRandomUserInfoNotLogin({required String deviceId}) → Future<Map>
获取随机设备随机密码 不登录
xcGetDeviceState({required String deviceId, required int stateType}) → Future<int>
单个获取设备在线状态(同步接口), 比如低功耗设备 deviceId 设备序列号 stateType 状态类型(上层定义) eg. EFunDevStateType_IDR = 8, //门铃状态
xcGetDeviceToken({required String deviceId}) → Future<String>
获取设备token deviceId 设备序列号或IP+Port
xcLoginOut({required String deviceId}) → Future<bool>
设备登出 deviceId 设备序列号或IP+Port return Future
xcParseRandomUserInfo({required String deviceId, required String encodeDataStr}) → Future<String>
解析设备随机用户信息 deviceId 设备序列号或IP+Port encodeDataStr 被加密的数据 return 解析成功后会返回到OriginResponse对象中的data属性
xcPtzControl({required String deviceId, required int channelIndex, required String szPTZCommand, required int bStop, required int nSpeed}) → Future<int>
云台控制 deviceId设备序列号 or ip+port channelIndex 通道号 command云台控制命令 stop0：开始运动 1：停止运动 speed 移动速度 seq 自定义值 return code:0 (无需等待回调,直接返回接口调用结果即可)
xcQueryCloudCryNum({required String deviceId}) → Future<String>
查询设备特征校验码 deviceId 设备序列号或IP+Port
xcSaveDevicePwdQuestion({required String deviceId, required PwdQuestionSaveModel saveModel}) → Future
设置密保问题、答案及验证方式
xcSaveDevicePwdQuestionDetail({required String deviceId, required String answer1, required int answer1Index, required String answer2, required int answer2Index, required String phoneOrEmail, required int codeCheckType}) → Future
设置密保问题、答案及验证方式 这个接口是 xcSaveDevicePwdQuestion 接口的封装 phoneOrEmail 手机号或者邮箱 codeCheckType 发送方式 0 通过app发送， 1 通过email发送
xcSearchDevices({int timeout = 1500}) → Future<List<Map<String, dynamic>>>
局域网搜索设备
xcSetDeviceAppBindFlag({required String deviceId, required bool isBind}) → Future<bool>
设置app绑定标志 isBind 是否绑定 return Future
xcSetDeviceToken({required String deviceId, required String token}) → Future<void>
设置设备token deviceId 设备序列号或IP+Port token 设备token
xcSetLocalUserNameAndPwd({required String deviceId, required String userName, required String pwd}) → Future<int>
把设备登录名和设备登录密码缓存到本地 deviceId 设备序列号 or ip+port userName 用户名 pwd 密码 seq 自定义值 return code:0 (无需等待回调,直接返回接口调用结果即可)
xcStartSendFileToDevice({required String deviceId, required String paramJsStr, required String filePath, int timeout = 5000}) → Future<String>
发送文件到设备端 回调码 13010 deviceId 设备序列号 paramJsStr 请求的Json内容 filePath 文件路径 timeout 超时时间
xcStartWifiConfig({required WifiConfig wifiConfig}) → Future<String>
开始WIFI配网 ssid ssid wifiPwd WIFI密码 pwdType 原生返回 ipAddress ip netMask 网关 dns1 dns1 dns2 dns2 timeOut 超时时间 seq 自定义值 return 返回多个字段
xcStopSendFileToDevice({required int handle}) → Future<String>
关闭发送文件到设备端 handle 由xcStartSendFileToDevice这个接口返回的操作句柄
xcStopWifiConfig() → Future<void>
停止WIFI配网 无需返回值

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

instance → DeviceAPI
no setter