1.0.1 • Published 2 months ago

capacitor-plugin-tjyjwt v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
2 months ago

capacitor-plugin-tjyjwt

给特种检务通app,集成执法仪的SDK能力,通过热点链接远程控制执法仪。

Install

npm install capacitor-plugin-tjyjwt
npx cap sync

API

connect(...)

connect(options?: { params: string; } | undefined) => Promise<connectResult>

连接设备的接口,返回值是异步,需要根据设备响应后信息再返回

ParamTypeDescription
options{ params: string; }无实际作用,作保留用

Returns: Promise<connectResult>


snap(...)

snap(options?: { params: string; } | undefined) => Promise<connectResult>

调用设备拍照功能,拍照后照片保存在设备。返回值同样是异

ParamTypeDescription
options{ params: string; }无实际作用,作保留用

Returns: Promise<connectResult>


record(...)

record(options: { starting: boolean; }) => Promise<connectResult>

调用设备录像功能,返回值同样是异步

ParamTypeDescription
options{ starting: boolean; }starting: true表示开始录像,false表示停止录像

Returns: Promise<connectResult>


stopConnecting(...)

stopConnecting(options?: { params: string; } | undefined) => Promise<void>

断开设备连接

ParamTypeDescription
options{ params: string; }无实际作用,作保留用

setParameters(...)

setParameters(options: { params: Partial<FTPParameters>; }) => Promise<void>

设置参数到设备 设备在连接的时候会返回初始化的参数,通过onParamsListener监听事件接口回调到前端,参数的字段是zfyParameters

ParamTypeDescription
options{ params: Partial<FTPParameters>; }params: 设置参数信息,json格式

ftpConnect(...)

ftpConnect(options?: { params: string; } | undefined) => Promise<Result>

打开FTP连接,一般来说原生在获取设备参数后会自动调用这个方法连接上设备的FTP 账号密码和端口都是通过初始化的设备参数获取。同时开放此方法给前端自由调用

ParamTypeDescription
options{ params: string; }无实际作用,作保留用

Returns: Promise<Result>


ftpListFiles(...)

ftpListFiles(options: { type: FTPFileEnum; }) => Promise<FTPListFileResult>

获取设备上的文件,目前可查询图片和视频

ParamTypeDescription
options{ type: FTPFileEnum; }type: PICTURE是图片类型,VIDEO是视频类型。注意枚举对应的值不要修改,用于查询

Returns: Promise<FTPListFileResult>


ftpRetrieveFile(...)

ftpRetrieveFile(options: { fileName: string; ftpFilePath: string; }) => Promise<FTPRetrieveFile>

下载执法仪的文件到本机

ParamTypeDescription
options{ fileName: string; ftpFilePath: string; }fileName: 保存到本地的文件名,注意这个文件名是可以自定义的,最后以前端命名的文件名保存;ftpFilePath: 需要下载的文件的FTP地址,由查询时候返回的FtpFilePath字段带出给前端。

Returns: Promise<FTPRetrieveFile>


playRTSP(...)

playRTSP(options?: { params: string; } | undefined) => Promise<void>

播放RTSP视频流,注意要连接设备后才能获取RTSP的地址(由原生获取,前端保证在连接后调用即可)

ParamTypeDescription
options{ params: string; }无实际作用,作保留用

stopRTSP(...)

stopRTSP(options?: { params: string; } | undefined) => Promise<void>

停止播放RTSP,并释放资源,建议在应用退到后台、离开界面的时候释放资源

ParamTypeDescription
options{ params: string; }无实际作用,作保留用

addListener('onParamsListener', ...)

addListener(eventName: 'onParamsListener', listenerFunc: (data: { zfyParameters: Partial<FTPParameters>; }) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

监听事件名称:onParamsListener,接口将设备参数信息回调给前端,参数的字段是data.zfyParameters

ParamTypeDescription
eventName'onParamsListener'监听事件的名称
listenerFunc(data: { zfyParameters: Partial<FTPParameters>; }) => voidzfyParameters: 接口回调的参数信息,json格式

Returns: Promise<PluginListenerHandle> & PluginListenerHandle


addListener('onVideoDismiss', ...)

addListener(eventName: 'onVideoDismiss', listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle

监听事件名称:onVideoDismiss,关闭视频流弹窗时,接口通知前端

ParamTypeDescription
eventName'onVideoDismiss'监听事件的名称
listenerFunc() => void回调方法

Returns: Promise<PluginListenerHandle> & PluginListenerHandle


Interfaces

connectResult

PropTypeDescription
retboolean是否成功,注意这个是有执法仪返回,和isSuccess性质不一样
valuestring由执法仪返回的信息

FTPParameters

PropTypeDescription
DevIdstring设备编号
FtpHttpPortnumberhttp端口
FtpIpstringFTP的ip
FtpPortnumberFTP端口
FtpPwdstring密码
FtpUserstring用户名
IndicatorLightnumber指示灯
InfraredAutonumber自动红外
LocationFreqnumber定位回传频率
NetTransBitstring图传设置(中文)
NetTransResnumber图传设置(编码)
PlaybackPwdstring设备(回放)密码设置
PostRecPostRecEnum延录
PreRec0 | 1预录
ServerIPstring服务器IP
ServerPortnumber服务器端口号
SnapResnumber拍照分辨率
SnapShotSnapShotEnum连拍张数
SnapShotTimeSnapShotTimeEnum定时拍照
Userstring用户号
VideoQualityVideoQualityEnum视频质量
VideoResVideoResEnum视频分辨率
VidPtimeVidPtimeEnum视频分段
Fbuttonnumber未知
Typestring未知

Result

PropTypeDescription
isSuccessboolean表示操作是否成功
messagestring插件返回给前端的提示信息,主要用于快速识别异常的原因,面向开发人员的信息

FTPListFileResult

PropTypeDescription
dataFTPFileModule[]文件的列表

FTPFileModule

PropTypeDescription
FileNamestring文件在执法仪上的名字
FileSizenumber文件的大小
Timesstring文件的时间
FtpFilePathstring文件执法仪上的FTP地址,下载文件需要根据这个地址找到文件下载

FTPRetrieveFile

PropTypeDescription
localFilePathstring文件下载保存到本地的路径

PluginListenerHandle

PropType
remove() => Promise<void>

Type Aliases

Partial

Make all properties in T optional

{ P in keyof T?: TP; }

Enums

PostRecEnum

MembersValue
'关闭'0
'10秒'1
'30秒'2
'1分钟'3
'2分钟'4
'5分钟'5
'10分钟'6
'30分钟'7

SnapShotEnum

MembersValue
'1张'0
'3张'1
'5张'2
'10张'3
'20张'4
'30张'5

SnapShotTimeEnum

MembersValue
'关闭'0
'30秒'1
'1分钟'2
'2分钟'3
'4分钟'4
'5分钟'5

VideoQualityEnum

MembersValue
'高'0
'中'1
'低'2

VideoResEnum

MembersValue
"1080P 1920*1080"0
"720P 1280*720"1
"480P 720*480"2
"2K"3

VidPtimeEnum

MembersValue
'自动'0
'1分钟'1
'3分钟'2
'5分钟'3
'10分钟'4
'20分钟'5
'30分钟'6

FTPFileEnum

MembersValueDescription
PICTURE"/PICTURE"图片类型
VIDEO"/MP4"视频类型
1.0.1

2 months ago

1.0.0

2 months ago

0.0.16

2 months ago

0.0.15

3 months ago

0.0.14

3 months ago

0.0.11

3 months ago

0.0.12

3 months ago

0.0.13

3 months ago

0.0.10

3 months ago

0.0.9

3 months ago

0.0.8

3 months ago

0.0.7

3 months ago

0.0.6

3 months ago

0.0.5

3 months ago

0.0.4

3 months ago

0.0.3

3 months ago

0.0.1

3 months ago