FinClip为企业提供小程序生态圈技术产品,开发者可在FinClip小程序开发帮助中心找到相关FinClip小程序指引

# API 总览

# 1. 基础

名称 功能说明 版本 备注
ft.env 环境变量 1.0.0
ft.canIUse 判断小程序的API,回调,参数,组件等是否在当前版本可用 1.0.0
ft.base64ToArrayBuffer 将 Base64 字符串转成 ArrayBuffer 对象 1.0.0
ft.arrayBufferToBase64 将 ArrayBuffer 对象转成 Base64 字符串 1.0.0
ft.base64ToTempFilePath 将图片的base64数据保存到本地沙盒,并返回本地缓存路径 1.0.0
ft.fileToBase64 将文件转换为 Base64 字符串 1.0.0

# 1.1 系统

名称 功能说明 版本 备注
ft.getSystemInfoSync wx.getSystemInfo 的同步版本 1.0.0
ft.getSystemInfoAsync 异步获取系统信息 1.0.0
ft.getSystemInfo 获取系统信息 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
ft.openAppAuthorizeSetting 跳转系统微信授权管理页
ft.openSystemBluetoothSetting 跳转系统蓝牙设置页
ft.getWindowInfo 获取窗口信息
ft.getSystemSetting 获取设备设置
ft.getSkylineInfoSync wx.getSkylineInfo 的同步版本
ft.getSkylineInfo 获取当前运行环境对于 Skyline 渲染引擎 的支持情况
ft.getDeviceInfo 获取设备基础信息

# 1.2 更新

名称 功能说明 版本 备注
ft.getUpdateManager 获取全局唯一的版本更新管理器,用于管理小程序更新 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
ft.updateWeChatApp 更新客户端版本

# 1.2.1 UpdateManager

名称 功能说明 版本 备注
UpdateManager.applyUpdate 强制小程序重启并使用新版本 1.0.0
UpdateManager.onCheckForUpdate 监听向微信后台请求检查更新结果事件 1.0.0
UpdateManager.onUpdateFailed 监听小程序更新失败事件 1.0.0
UpdateManager.onUpdateReady 监听小程序有版本更新事件 1.0.0

# 1.3 小程序

# 1.3.1 生命周期

名称 功能说明 版本 备注
ft.getLaunchOptionsSync 获取小程序启动时的参数 1.0.0
ft.getEnterOptionsSync 获取本次小程序启动时的参数 1.0.0

# 1.3.2 应用级事件

名称 功能说明 版本 备注
ft.onPageNotFound 监听小程序要打开的页面不存在事件 1.0.0
ft.onError 监听小程序错误事件 1.0.0
ft.onAppShow 监听小程序切前台事件 1.0.0
ft.onAppHide 监听小程序切后台事件 1.0.0
ft.offPageNotFound 取消监听小程序要打开的页面不存在事件 1.0.0
ft.offError 取消监听小程序错误事件 1.0.0
ft.offAppShow 取消监听小程序切前台事件 1.0.0
ft.offAppHide 取消监听小程序切后台事件 1.0.0
ft.onThemeChange 监听系统主题改变事件 1.0.0
ft.onUnhandledRejection 监听未处理的 Promise 拒绝事件 1.0.0
ft.offUnhandledRejection 取消监听未处理的 Promise 拒绝事件 1.0.0
ft.offThemeChange 取消监听系统主题改变事件 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
ft.onAudioInterruptionEnd 监听音频中断结束事件
ft.onAudioInterruptionBegin 监听音频因为受到系统占用而被中断开始事件
ft.offAudioInterruptionEnd 取消监听音频中断结束事件
ft.offAudioInterruptionBegin 取消监听音频因为受到系统占用而被中断开始事件
ft.onLazyLoadError 监听应用异步组件加载失败回调
ft.offLazyLoadError 取消监听应用异步组件加载失败回调

# 1.4 调试

名称 功能说明 版本 备注
ft.setEnableDebug 设置是否打开调试开关 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
ft.getRealtimeLogManager 获取实时日志管理器对象
ft.getLogManager 获取日志管理器对象

# 1.4.1 console

名称 功能说明 版本 备注
console.debug 向调试面板中打印 debug 日志 1.0.0
console.error 向调试面板中打印 error 日志 1.0.0
console.group 在调试面板中创建一个新的分组 1.0.0
console.groupEnd 结束由 console.group 创建的分组 1.0.0
console.info 向调试面板中打印 info 日志 1.0.0
console.log 向调试面板中打印 log 日志 1.0.0
console.warn 向调试面板中打印 warn 日志 1.0.0

# 1.4.2 LogManager

请注意

以下 API 暂不支持

名称 功能说明
LogManager.debug 写 debug 日志
LogManager.info 写 info 日志
LogManager.log 写 log 日志
LogManager.warn 写 warn 日志

# 1.4.3 RealtimeLogManager

请注意

以下 API 暂不支持

名称 功能说明
RealtimeLogManager.error 写 error 日志
RealtimeLogManager.getCurrentState 实时日志会将一定时间间隔内缓存的日志聚合上报,如果该时间内缓存的内容超出限制,则会被丢弃
RealtimeLogManager.in 设置实时日志page参数所在的页面
RealtimeLogManager.tag 获取给定标签的日志管理器实例
RealtimeLogManager.info 写 info 日志
RealtimeLogManager.warn 写 warn 日志
RealtimeLogManager.setFilterMsg 设置过滤关键字
RealtimeLogManager.addFilterMsg 添加过滤关键字

# 1.4.4 RealtimeTagLogManager

请注意

以下 API 暂不支持

名称 功能说明
RealtimeTagLogManager.info 写 info 日志
RealtimeTagLogManager.warn 写 warn 日志
RealtimeTagLogManager.error 写 error 日志
RealtimeTagLogManager.insetFilterMsgfo 设置过滤关键字
RealtimeTagLogManager.addFilterMsg 添加过滤关键字

# 1.5 性能

请注意

以下 API 暂不支持

名称 功能说明
ft.getPerformance 获取当前小程序性能相关的信息
ft.reportPerformance 小程序测速上报
ft.preloadWebview 预加载下个页面的 WebView
ft.preloadSkylineView 预加载下个页面所需要的 Skyline 运行环境
ft.preloadAssets 为视图层预加载媒体资源文件

# 1.5.1 EntryList

请注意

以下 API 暂不支持

名称 功能说明
EntryList.getEntries 该方法返回当前列表中的所有性能数据
EntryList.getEntriesByType 获取当前列表中所有类型为 [entryType] 的性能数据
EntryList.getEntriesByName 获取当前列表中所有名称为 [name] 且类型为 [entryType] 的性能数据

# 1.5.2 Performance

请注意

以下 API 暂不支持

名称 功能说明
Performance.getEntries 该方法返回当前缓冲区中的所有性能数据
Performance.getEntriesByType 获取当前缓冲区中所有类型为 [entryType] 的性能数据
Performance.getEntriesByName 获取当前缓冲区中所有名称为 [name] 且类型为 [entryType] 的性能数据
Performance.createObserver 创建全局性能事件监听器
Performance.setBufferSize 设置缓冲区大小,默认缓冲 30 条性能数据
PerformanceEntry 单条性能数据

# 1.5.3 PerformanceObserver

请注意

以下 API 暂不支持

名称 功能说明
PerformanceObserver.disconnect 停止监听
PerformanceObserver.observe 开始监听

# 1.6 分包加载

请注意

以下 API 暂不支持

名称 功能说明
ft.preDownloadSubpackage 触发分包预下载

# 1.6.1 PreDownloadSubpackageTask

请注意

以下 API 暂不支持

名称 功能说明
PreDownloadSubpackageTask.onProgressUpdate 监听分包加载进度变化事件

# 1.7 加密

请注意

以下 API 暂不支持

名称 功能说明
ft.getUserCryptoManager 获取用户加密模块

# 1.7.1 UserCryptoManager

请注意

以下 API 暂不支持

名称 功能说明
UserCryptoManager.getLatestUserKey 获取最新的用户加密密钥
UserCryptoManager.getRandomValues 获取密码学安全随机数

# 2. 路由

名称 功能说明 版本 备注
ft.switchTab 跳转到 tabBar 页面,并关闭其他所有非 tabBar 页面 1.0.0
ft.reLaunch 关闭所有页面,打开到应用内的某个页面 1.0.0
ft.redirectTo 关闭当前页面,跳转到应用内的某个页面 1.0.0
ft.navigateTo 保留当前页面,跳转到应用内的某个页面 1.0.0
ft.navigateBack 关闭当前页面,返回上一页面或多级页面 1.0.0

# 2.1 EventChannel

名称 功能说明 版本 备注
EventChannel.emit 触发一个事件 1.0.0
EventChannel.off 取消监听一个事件 1.0.0
EventChannel.on 持续监听一个事件 1.0.0
EventChannel.once 监听一个事件一次,触发后失效 1.0.0

# 3. 跳转

名称 功能说明 版本 备注
ft.navigateToMiniProgram 打开另一个小程序 1.0.0
ft.navigateBackMiniProgram 返回到上一个小程序 1.0.0
ft.exitMiniProgram 退出当前小程序 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
ft.openEmbeddedMiniProgram 打开半屏小程序

# 4. 转发

名称 功能说明 版本 备注
ft.showShareMenu 显示当前页面的转发按钮 1.0.0
ft.hideShareMenu 隐藏当前页面的转发按钮 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
ft.updateShareMenu 更新转发属性
ft.showShareImageMenu 打开分享图片弹窗,可以将图片发送给朋友、收藏或下载
ft.shareVideoMessage 转发视频到聊天
ft.shareFileMessage 转发文件到聊天
ft.onCopyUrl 监听用户点击右上角菜单的「复制链接」按钮时触发的事件
ft.offCopyUrl 取消监听用户点击右上角菜单的「复制链接」按钮时触发的事件
ft.getShareInfo 获取转发详细信息
ft.authPrivateMessage 验证私密消息

# 5. 界面

# 5.1 交互

名称 功能说明 版本 备注
ft.showToast 显示消息提示框 1.0.0
ft.showModal 显示模态对话框 1.0.0
ft.showLoading 显示 loading 提示框 1.0.0
ft.showActionSheet 显示操作菜单 1.0.0
ft.hideToast 隐藏消息提示框 1.0.0
ft.hideLoading 隐藏 loading 提示框 1.0.0
ft.enableAlertBeforeUnload 开启小程序页面返回询问对话框 2.11.5
ft.disableAlertBeforeUnload 关闭小程序页面返回询问对话框 2.11.5

# 5.2 导航栏

名称 功能说明 版本 备注
ft.showNavigationBarLoading 在当前页面显示导航条加载动画 1.0.0
ft.setNavigationBarTitle 动态设置当前页面的标题 1.0.0
ft.setNavigationBarColor 设置页面导航条颜色 1.0.0
ft.hideNavigationBarLoading 在当前页面隐藏导航条加载动画 1.0.0
ft.hideHomeButton 隐藏返回首页按钮 1.0.0

# 5.3 背景

名称 功能说明 版本 备注
ft.setBackgroundTextStyle 动态设置下拉背景字体、loading 图的样式 1.0.0
ft.setBackgroundColor 动态设置窗口的背景色 1.0.0

# 5.4 Tab Bar

名称 功能说明 版本 备注
ft.showTabBarRedDot 显示 tabBar 某一项的右上角的红点 1.0.0
ft.showTabBar 显示 tabBar 1.0.0
ft.setTabBarStyle 动态设置 tabBar 的整体样式 1.0.0
ft.setTabBarItem 动态设置 tabBar 某一项的内容,2.7.0 起图片支持临时文件和网络文件 1.0.0
ft.setTabBarBadge 为 tabBar 某一项的右上角添加文本 1.0.0
ft.removeTabBarBadge 移除 tabBar 某一项右上角的文本 1.0.0
ft.hideTabBarRedDot 隐藏 tabBar 某一项的右上角的红点 1.0.0
ft.hideTabBar 隐藏 tabBar 1.0.0

# 5.5 字体

名称 功能说明 版本 备注
ft.loadFontFace 动态加载网络字体,文件地址需为下载类型 1.0.0

# 5.6 下拉刷新

名称 功能说明 版本 备注
ft.stopPullDownRefresh 停止当前页面下拉刷新 1.0.0
ft.startPullDownRefresh 开始下拉刷新 1.0.0

# 5.7 滚动

名称 功能说明 版本 备注
ft.pageScrollTo 将页面滚动到目标位置,支持选择器和滚动距离两种方式定位 1.0.0

# 5.7.1 ScrollViewContext

请注意

以下 API 暂不支持

名称 功能说明
ScrollViewContext.scrollIntoView 滚动至指定位置
ScrollViewContext.scrollTo 滚动至指定位置

# 5.8 动画

名称 功能说明 版本 备注
ft.createAnimation 创建一个动画实例 animation 1.0.0

# 5.8.1 Animation

名称 功能说明 版本 备注
Animation.export 导出动画队列 1.0.0
Animation.step 表示一组动画完成 1.0.0
Animation.matrix 同 transform-function matrix 1.0.0
Animation.matrix3d 同 transform-function matrix3d 1.0.0
Animation.rotate 从原点顺时针旋转一个角度 1.0.0
Animation.rotate3d 从 固定 轴顺时针旋转一个角度 1.0.0
Animation.rotateX 从 X 轴顺时针旋转一个角度 1.0.0
Animation.rotateY 从 Y 轴顺时针旋转一个角度 1.0.0
Animation.rotateZ 从 Z 轴顺时针旋转一个角度 1.0.0
Animation.scale 缩放 1.0.0
Animation.scale3d 缩放 1.0.0
Animation.scaleX 缩放 X 轴 1.0.0
Animation.scaleY 缩放 Y 轴 1.0.0
Animation.scaleZ 缩放 Z 轴 1.0.0
Animation.skew 对 X、Y 轴坐标进行倾斜 1.0.0
Animation.skewX 对 X 轴坐标进行倾斜 1.0.0
Animation.skewY 对 Y 轴坐标进行倾斜 1.0.0
Animation.translate 平移变换 1.0.0
Animation.translate3d 对 xyz 坐标进行平移变换 1.0.0
Animation.translateX 对 X 轴平移 1.0.0
Animation.translateY 对 Y 轴平移 1.0.0
Animation.translateZ 对 Z 轴平移 1.0.0
Animation.opacity 设置透明度 1.0.0
Animation.backgroundColor 设置背景色 1.0.0
Animation.width 设置宽度 1.0.0
Animation.height 设置高度 1.0.0
Animation.left 设置 left 值 1.0.0
Animation.right 设置 right 值 1.0.0
Animation.top 设置 top 值 1.0.0
Animation.bottom 设置 bottom 值 1.0.0

# 5.9 置顶

请注意

以下 API 暂不支持

名称 功能说明
ft.setTopBarText 动态设置置顶栏文字内容

# 5.10 自定义组件

名称 功能说明 版本 备注
ft.nextTick 延迟一部分操作到下一个时间片再执行 1.0.0

# 5.11 菜单

名称 功能说明 版本 备注
ft.getMenuButtonBoundingClientRect 获取菜单按钮(右上角胶囊按钮)的布局位置信息 1.0.0

# 5.12 窗口

名称 功能说明 版本 备注
ft.onWindowResize 监听窗口尺寸变化事件 1.0.0
ft.offWindowResize 取消监听窗口尺寸变化事件 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
ft.setWindowSize 设置窗口大小,该接口仅适用于 PC 平台,使用细则请参见指南

# 5.13 worklet 动画

请注意

以下 API 暂不支持

名称 功能说明
ft.worklet 获取 worklet 对象

# 5.13.1 worklet

请注意

以下 API 暂不支持

名称 功能说明
worklet.cancelAnimation 取消由 SharedValue 驱动的动画
worklet.derived 衍生值 DerivedValue,可基于已有的 SharedValue 生成其它共享变量
worklet.shared 共享变量 SharedValue,用于跨线程共享数据和驱动动画
worklet.decay 基于滚动的动画
worklet.spring 基于物理的动画
worklet.timing 基于时间的动画
worklet.delay 延迟执行动画
worklet.repeat 重复执行动画
worklet.sequence 组合动画序列,依次执行传入的动画
worklet.runOnJS worklet 函数运行在 UI 线程时,捕获的外部函数可能为 worklet 类型或普通函数,为了更明显的对其区分,要求必须使用 runOnJS 调回 JS 线程的普通函数
worklet.runOnUI 在 UI 线程执行 worklet 函数

# 6. 网络

# 6.1 发起请求

名称 功能说明 版本 备注
ft.request 发起 HTTPS 网络请求 1.0.0

# 6.1 RequestTask

名称 功能说明 版本 备注
RequestTask.abort 中断请求任务 1.0.0
RequestTask.offHeadersReceived 取消监听 HTTP Response Header 事件 1.0.0
RequestTask.onHeadersReceived 监听 HTTP Response Header 事件 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
RequestTask.onChunkReceived 监听 Transfer-Encoding Chunk Received 事件
RequestTask.offChunkReceived 移除 Transfer-Encoding Chunk Received 事件的监听函数

# 6.2 下载

名称 功能说明 版本 备注
ft.downloadFile 下载文件资源到本地 1.0.0

# 6.2.1 DownloadTask

名称 功能说明 版本 备注
DownloadTask.abort 中断下载任务 1.0.0
DownloadTask.offHeadersReceived 移除 HTTP Response Header 事件的监听函数 1.0.0
DownloadTask.onHeadersReceived 监听 HTTP Response Header 事件。会比请求完成事件更早 1.0.0
DownloadTask.offProgressUpdate 移除下载进度变化事件的监听函数 1.0.0
DownloadTask.onProgressUpdate 监听下载进度变化事件 1.0.0

# 6.3 上传

名称 功能说明 版本 备注
ft.uploadFile 将本地资源上传到服务器 1.0.0

# 6.3.1 UploadTask

名称 功能说明 版本 备注
UploadTask.abort 中断上传任务 1.0.0
UploadTask.offHeadersReceived 移除 HTTP Response Header 事件的监听函数 1.0.0
UploadTask.onHeadersReceived 监听 HTTP Response Header 事件。会比请求完成事件更早 1.0.0
UploadTask.offProgressUpdate 移除上传进度变化事件的监听函数 1.0.0
UploadTask.onProgressUpdate 监听上传进度变化事件 1.0.0

# 6.4 WebSocket

名称 功能说明 版本 备注
ft.sendSocketMessage 通过 WebSocket 连接发送数据 1.0.0
ft.onSocketOpen 监听 WebSocket 连接打开事件 1.0.0
ft.onSocketMessage 监听 WebSocket 接受到服务器的消息事件 1.0.0
ft.onSocketError 监听 WebSocket 错误事件 1.0.0
ft.onSocketClose 监听 WebSocket 连接关闭事件 1.0.0
ft.connectSocket 创建一个 WebSocket 连接 1.0.0
ft.closeSocket 关闭 WebSocket 连接 1.0.0

# 6.4.1 SocketTask

名称 功能说明 版本 备注
SocketTask.close 关闭 WebSocket 连接 1.0.0
SocketTask.onClose 监听 WebSocket 连接关闭事件 1.0.0
SocketTask.onError 监听 WebSocket 错误事件 1.0.0
SocketTask.onMessage 监听 WebSocket 接受到服务器的消息事件 1.0.0
SocketTask.onOpen 监听 WebSocket 连接打开事件 1.0.0
SocketTask.send 通过 WebSocket 连接发送数据 1.0.0

# 6.5 mDNS

请注意

以下 API 暂不支持

名称 功能说明
ft.stopLocalServiceDiscovery 停止搜索 mDNS 服务
ft.startLocalServiceDiscovery 开始搜索局域网下的 mDNS 服务
ft.onLocalServiceResolveFail 监听 mDNS 服务解析失败的事件
ft.onLocalServiceLost 监听 mDNS 服务离开的事件
ft.onLocalServiceFound 监听 mDNS 服务发现的事件
ft.onLocalServiceDiscoveryStop 监听 mDNS 服务停止搜索的事件
ft.offLocalServiceResolveFail 取消监听 mDNS 服务解析失败的事件
ft.offLocalServiceLost 取消监听 mDNS 服务离开的事件
ft.offLocalServiceFound 取消监听 mDNS 服务发现的事件
ft.offLocalServiceDiscoveryStop 取消监听 mDNS 服务停止搜索的事件

# 6.6 TCP 通信

名称 功能说明 版本 备注
ft.createTCPSocket 创建一个 TCP Socket 实例 1.0.0

# 6.6.1 TCPSocket

名称 功能说明 版本 备注
TCPSocket.onMessage 监听当接收到数据的时触发该事件 1.0.0
TCPSocket.write 在 socket 上发送数据 1.0.0
TCPSocket.close 关闭连接 1.0.0
TCPSocket.connect 在给定的套接字上启动连接 1.0.0
TCPSocket.offConnect 移除当一个 socket 连接成功建立的时候触发该事件的监听函数 1.0.0
TCPSocket.offClose 移除一旦 socket 完全关闭就发出该事件的监听函数 1.0.0
TCPSocket.offError 移除当错误发生时触发的监听函数 1.0.0
TCPSocket.offMessage 移除当接收到数据的时触发该事件的监听函数 1.0.0
TCPSocket.onClose 监听一旦 socket 完全关闭就发出该事件 1.0.0
TCPSocket.onConnect 监听当一个 socket 连接成功建立的时候触发该事件 1.0.0
TCPSocket.onError 监听当错误发生时触发 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
TCPSocket.bindWifi 将 TCP Socket 绑定到当前 wifi 网络,成功后会触发 onBindWifi 事件(仅安卓支持)
TCPSocket.offBindWifi 移除当一个 socket 绑定当前 wifi 网络成功时触发该事件的监听函数
TCPSocket.onBindWifi 监听当一个 socket 绑定当前 wifi 网络成功时触发该事件

# 6.7 UDP 通信

名称 功能说明 版本 备注
ft.createUDPSocket 创建一个 UDP Socket 实例 1.0.0

# 6.7.1 UDPSocket

名称 功能说明 版本 备注
UDPSocket.bind 绑定一个系统随机分配的可用端口,或绑定一个指定的端口号 1.0.0
UDPSocket.close 关闭 UDP Socket 实例,相当于销毁 1.0.0
UDPSocket.offClose 取消监听关闭事件 1.0.0
UDPSocket.offError 取消监听错误事件 1.0.0
UDPSocket.offListening 取消监听开始监听数据包消息的事件 1.0.0
UDPSocket.offMessage 取消监听收到消息的事件 1.0.0
UDPSocket.onClose 监听关闭事件 1.0.0
UDPSocket.onError 监听错误事件 1.0.0
UDPSocket.onListening 监听开始监听数据包消息的事件 1.0.0
UDPSocket.onMessage 监听收到消息的事件 1.0.0
UDPSocket.connect 预先连接到指定的 IP 和 port,需要配合 write 方法一起使用 1.0.0
UDPSocket.write 用法与 send 方法相同,如果没有预先调用 connect 则与 send 无差异(注意即使调用了 connect 也需要在本接口填入地址和端口参数) 1.0.0
UDPSocket.setTTL 设置 IP_TTL 套接字选项,用于设置一个 IP 数据包传输时允许的最大跳步数 1.0.0
UDPSocket.send 向指定的 IP 和 port 发送消息 1.0.0

# 7. 支付

名称 功能说明 版本 备注
ft.requestPayment 发起支付

请注意

以下 API 暂不支持

名称 功能说明
ft.requestPluginPayment 插件中发起支付

# 8. 数据缓存

名称 功能说明 版本 备注
ft.setStorageSync wx.setStorage 的同步版本 1.0.0
ft.setStorage 将数据存储在本地缓存中指定的 key 中 1.0.0
ft.removeStorageSync wx.removeStorage 的同步版本 1.0.0
ft.removeStorage 从本地缓存中移除指定 key 1.0.0
ft.getStorageSync wx.getStorage 的同步版本 1.0.0
ft.getStorageInfoSync wx.getStorageInfo 的同步版本 1.0.0
ft.getStorageInfo 异步获取当前storage的相关信息 1.0.0
ft.getStorage 从本地缓存中异步获取指定 key 的内容 1.0.0
ft.clearStorageSync wx.clearStorage 的同步版本 1.0.0
ft.clearStorage 清理本地数据缓存 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
ft.revokeBufferURL 根据 URL 销毁存在内存中的数据
ft.createBufferURL 根据传入的 buffer 创建一个唯一的 URL 存在内存中
ft.batchSetStorageSync 将数据批量存储在本地缓存中指定的 key 中
ft.batchSetStorage 将数据批量存储在本地缓存中指定的 key 中
ft.batchGetStorageSync 从本地缓存中同步批量获取指定 key 的内容
ft.batchGetStorage 从本地缓存中同步批量获取指定 key 的内容

# 8.1 周期性更新

请注意

以下 API 暂不支持

名称 功能说明
ft.setBackgroundFetchToken 设置自定义登录态,在周期性拉取数据时带上,便于第三方服务器验证请求合法性
ft.onBackgroundFetchData 监听收到 backgroundFetch 数据时的回调
ft.getBackgroundFetchToken 获取设置过的自定义登录态
ft.getBackgroundFetchData 拉取 backgroundFetch 客户端缓存数据

# 8.2 缓存管理器

请注意

以下 API 暂不支持

名称 功能说明
ft.createCacheManager 创建缓存管理器

# 8.2.1 CacheManager

请注意

以下 API 暂不支持

名称 功能说明
CacheManager.addRule 添加规则
CacheManager.addRules 批量添加规则,规则写法可参考 CacheManager.addRule
CacheManager.clearCaches 清空所有缓存
CacheManager.clearRules 清空所有规则,同时会删除对应规则下所有缓存
CacheManager.deleteCache 删除缓存
CacheManager.deleteCaches 批量删除缓存
CacheManager.deleteRule 删除规则,同时会删除对应规则下所有缓存
CacheManager.deleteRules 删除规则,同时会删除对应规则下所有缓存
CacheManager.match 匹配命中的缓存规则,一般需要和 request 事件搭配使用
CacheManager.off 取消事件监听
CacheManager.on 监听事件
CacheManager.start 开启缓存,仅在 mode 为 none 时生效,调用后缓存管理器的 state 会置为 1
CacheManager.stop 关闭缓存,仅在 mode 为 none 时生效,调用后缓存管理器的 state 会置为 0

# 9. 数据分析

请注意

以下 API 暂不支持

名称 功能说明
ft.reportMonitor 自定义业务数据监控上报接口
ft.reportEvent 事件上报
ft.reportAnalytics 自定义分析数据上报接口
ft.getExptInfoSync 给定实验参数数组,获取对应的实验参数值

# 10. 画布

名称 功能说明 版本 备注
ft.createOffscreenCanvas 创建离屏 canvas 实例 1.0.0
ft.createCanvasContext 创建 canvas 的绘图上下文 CanvasContext 对象 1.0.0
ft.canvasToTempFilePath 把当前画布指定区域的内容导出生成指定大小的图片 1.0.0
ft.canvasPutImageData 将像素数据绘制到画布 1.0.0
ft.canvasGetImageData 获取 canvas 区域隐含的像素数据 1.0.0

# 10.1 Canvas

名称 功能说明 版本 备注
Canvas.createImage 创建一个 image 对象,仅 createSelectorQuery 获取到的 canvas 有该方法 1.0.0
Canvas.getContext 该方法返回 Canvas 的绘图上下文 1.0.0
Canvas.createImageData 创建一个 ImageData 对象 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
Canvas.cancelAnimationFrame 取消由 requestAnimationFrame 添加到计划中的动画帧请求
Canvas.createPath2D 创建 Path2D 对象
Canvas.requestAnimationFrame 在下次进行重绘时执行
Canvas.toDataURL 返回一个包含图片展示的 data URI

# 10.2 CanvasContext

名称 功能说明 版本 备注
CanvasContext.arc 创建一条弧线 1.0.0
CanvasContext.arcTo 根据控制点和半径绘制圆弧路径 1.0.0
CanvasContext.beginPath 开始创建一个路径 1.0.0
CanvasContext.clearRect 清除画布上在该矩形区域内的内容 1.0.0
CanvasContext.drawImage 绘制图像到画布 1.0.0
CanvasContext.createCircularGradient 创建一个圆形的渐变颜色 1.0.0
CanvasContext.createLinearGradient 创建一个线性的渐变颜色 1.0.0
CanvasContext.createPattern 对指定的图像创建模式的方法,可在指定的方向上重复元图像 1.0.0
CanvasContext.clip 从原始画布中剪切任意形状和尺寸 1.0.0
CanvasContext.bezierCurveTo 创建三次方贝塞尔曲线路径 1.0.0
CanvasContext.draw 将之前在绘图上下文中的描述(路径、变形、样式)画到 canvas 中 1.0.0
CanvasContext.fill 对当前路径中的内容进行填充 1.0.0
CanvasContext.fillRect 填充一个矩形 1.0.0
CanvasContext.fillText 在画布上绘制被填充的文本 1.0.0
CanvasContext.lineTo 增加一个新点,然后创建一条从上次指定点到目标点的线 1.0.0
CanvasContext.setLineDash 设置虚线样式 1.0.0
CanvasContext.setLineCap 设置线条的端点样式 1.0.0
CanvasContext.setGlobalAlpha 设置全局画笔透明度 1.0.0
CanvasContext.setFontSize 设置字体的字号 1.0.0
CanvasContext.setFillStyle 设置填充色 1.0.0
CanvasContext.scale 在调用后,之后创建的路径其横纵坐标会被缩放 1.0.0
CanvasContext.save 保存绘图上下文 1.0.0
CanvasContext.rotate 以原点为中心顺时针旋转当前坐标轴 1.0.0
CanvasContext.restore 恢复之前保存的绘图上下文 1.0.0
CanvasContext.rect 创建一个矩形路径 1.0.0
CanvasContext.quadraticCurveTo 创建二次贝塞尔曲线路径 1.0.0
CanvasContext.moveTo 把路径移动到画布中的指定点,不创建线条 1.0.0
CanvasContext.setStrokeStyle 设置描边颜色 1.0.0
CanvasContext.setShadow 设定阴影样式 1.0.0
CanvasContext.setMiterLimit 设置最大斜接长度 1.0.0
CanvasContext.setLineWidth 设置线条的宽度 1.0.0
CanvasContext.setLineJoin 设置线条的交点样式 1.0.0
CanvasContext.setTransform 使用矩阵重新设置(覆盖)当前变换的方法 1.0.0
CanvasContext.setTextBaseline 设置文字的竖直对齐 1.0.0
CanvasContext.setTextAlign 设置文字的对齐 1.0.0
CanvasContext.measureText 测量文本尺寸信息 1.0.0
CanvasContext.strokeRect 画一个矩形(非填充) 1.0.0
CanvasContext.strokeText 给定的 (x, y) 位置绘制文本描边的方法 1.0.0
CanvasContext.transform 使用矩阵多次叠加当前变换的方法 1.0.0
CanvasContext.translate 对当前坐标系的原点 (0, 0) 进行变换 1.0.0
CanvasContext.stroke 画出当前路径的边框 1.0.0

# 10.3 CanvasGradient

名称 功能说明
CanvasGradient.addColorStop 添加颜色的渐变点
Color 颜色
Image 图像
ImageData ImageData 对象

# 10.4 OffscreenCanvas

名称 功能说明 版本 备注
OffscreenCanvas.createImage 创建一个图片对象 1.0.0
OffscreenCanvas.getContext 该方法返回 OffscreenCanvas 的绘图上下文 1.0.0

# 11. 媒体

# 11.1 地图

名称 功能说明 版本 备注
ft.createMapContext 创建 map 上下文 MapContext 对象 1.0.0

# 11.1.1 MapContext

名称 功能说明
MapContext.addArc 添加弧线,途经点与夹角必须设置一个
MapContext.addCustomLayer 添加个性化图层
MapContext.addGroundOverlay 创建自定义图片图层,图片会随着地图缩放而缩放
MapContext.addMarkers 添加 marker
MapContext.fromScreenLocation 获取屏幕上的点对应的经纬度,坐标原点为地图左上角
MapContext.getCenterLocation 获取当前地图中心的经纬度
MapContext.getRegion 获取当前地图的视野范围
MapContext.getRotate 获取当前地图的旋转角
MapContext.getSkew 获取当前地图的倾斜角
MapContext.getScale 获取当前地图的缩放级别
MapContext.includePoints 缩放视野展示所有经纬度
MapContext.initMarkerCluster 初始化点聚合的配置,未调用时采用默认配置
MapContext.moveAlong 沿指定路径移动 marker,用于轨迹回放等场景
MapContext.moveToLocation 将地图中心移置当前定位点,此时需设置地图组件 show-location 为true
MapContext.openMapApp 拉起地图APP选择导航
MapContext.removeCustomLayer 移除个性化图层
MapContext.removeGroundOverlay 移除自定义图片图层
MapContext.removeMarkers 移除 marker
MapContext.setBoundary 限制地图的显示范围
MapContext.setCenterOffset 设置地图中心点偏移,向后向下为增长,屏幕比例范围(0.25~0.75),默认偏移为[0.5, 0.5]
MapContext.setLocMarkerIcon 设置定位点图标,支持网络路径、本地路径、代码包路径
MapContext.toScreenLocation 获取经纬度对应的屏幕坐标,坐标原点为地图左上角
MapContext.translateMarker 平移marker,带动画
MapContext.updateGroundOverlay 更新自定义图片图层
MapContext.on 监听地图事件

请注意

以下 API 暂不支持

名称 功能说明
MapContext.addVisualLayer 添加可视化图层
MapContext.removeVisualLayer 移除可视化图层
MapContext.removeArc 删除弧线

# 11.2 图片

名称 功能说明 版本 备注
ft.saveImageToPhotosAlbum 保存图片到系统相册 1.0.0
ft.previewMedia 预览图片和视频 1.0.0
ft.previewImage 在新页面中全屏预览图片 1.0.0
ft.getImageInfo 获取图片信息 1.0.0
ft.compressImage 压缩图片接口,可选压缩质量 1.0.0
ft.chooseMessageFile 从客户端会话选择文件 1.0.0
ft.chooseImage 从本地相册选择图片或使用相机拍照 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
ft.cropImage 编辑图片接口
ft.editImage 裁剪图片接口

# 11.3 视频

名称 功能说明 版本 备注
ft.saveVideoToPhotosAlbum 保存视频到系统相册 1.0.0
ft.createVideoContext 创建 video 上下文 VideoContext 对象 1.0.0
ft.compressVideo 压缩视频接口 1.0.0
ft.chooseVideo 拍摄视频或从手机相册中选视频 1.0.0
ft.chooseMedia 拍摄或从手机相册中选择图片或视频 1.0.0
ft.previewVideo 预览视频 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
ft.openVideoEditor 打开视频编辑器
ft.getVideoInfo 获取视频详细信息

# 11.3.1 videoContext

名称 功能说明 版本 备注
videoContext.exitBackgroundPlayback 退出后台音频播放模式 1.0.0
videoContext.exitFullScreen 退出全屏 1.0.0
videoContext.exitPictureInPicture 退出小窗,该方法可在任意页面调用 1.0.0
videoContext.hideStatusBar 隐藏状态栏,仅在iOS全屏下有效 1.0.0
videoContext.pause 暂停视频 1.0.0
videoContext.play 播放视频 1.0.0
videoContext.playbackRate 设置倍速播放 1.0.0
videoContext.requestBackgroundPlayback 进入后台音频播放模式 1.0.0
videoContext.requestFullScreen 进入全屏 1.0.0
videoContext.seek 跳转到指定位置 1.0.0
videoContext.sendDanmu 发送弹幕 1.0.0
videoContext.showStatusBar 显示状态栏,仅在iOS全屏下有效 1.0.0
videoContext.stop 停止视频 1.0.0

# 11.4 音频

名称 功能说明 版本 备注
ft.stopVoice 结束播放语音 1.0.0
ft.setInnerAudioOption 设置 InnerAudioContext 的播放选项 1.0.0
ft.playVoice 开始播放语音 1.0.0
ft.pauseVoice 暂停正在播放的语音 1.0.0
ft.createInnerAudioContext 创建内部 audio 上下文 InnerAudioContext 对象 1.0.0
ft.createAudioContext 创建 audio 上下文 AudioContext 对象 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
ft.getAvailableAudioSources 获取当前支持的音频输入源
ft.createWebAudioContext 创建WebAudio上下文
ft.createMediaAudioPlayer 创建媒体音频播放器对象 MediaAudioPlayer 对象,可用于播放视频解码器 VideoDecoder 输出的音频

# 11.4.1 AudioBuffer

请注意

以下 API 暂不支持

名称 功能说明
AudioBuffer.copyFromChannel 从AudioBuffer的指定频道复制到数组终端
AudioBuffer.copyToChannel 从指定数组复制样本到audioBuffer的特定通道
AudioBuffer.getChannelData 返回一个 Float32Array,包含了带有频道的PCM数据,由频道参数定义(有0代表第一个频道)

# 11.4.2 audiocontext

名称 功能说明 版本 备注
audiocontext.setSrc 设置音频地址 1.0.0
audiocontext.play 播放音频 1.0.0
audiocontext.pause 暂停音频 1.0.0
audiocontext.seek 跳转到指定位置 1.0.0

# 11.4.3 InnerAudioContext

名称 功能说明 版本 备注
InnerAudioContext.destroy 销毁当前实例 1.0.0
InnerAudioContext.offCanplay 取消监听音频进入可以播放状态的事件 1.0.0
InnerAudioContext.offEnded 取消监听音频自然播放至结束的事件 1.0.0
InnerAudioContext.offError 取消监听音频播放错误事件 1.0.0
InnerAudioContext.offTimeUpdate 取消监听音频播放进度更新事件 1.0.0
InnerAudioContext.offSeeking 取消监听音频进行跳转操作的事件 1.0.0
InnerAudioContext.offWaiting 取消监听音频加载中事件 1.0.0
InnerAudioContext.onEnded 监听音频自然播放至结束的事件 1.0.0
InnerAudioContext.offPlay 取消监听音频播放事件 1.0.0
InnerAudioContext.onCanplay 监听音频进入可以播放状态的事件 1.0.0
InnerAudioContext.onPause 监听音频暂停事件 1.0.0
InnerAudioContext.offPause 取消监听音频暂停事件 1.0.0
InnerAudioContext.offSeeked 取消监听音频完成跳转操作的事件 1.0.0
InnerAudioContext.offStop 取消监听音频停止事件 1.0.0
InnerAudioContext.onError 监听音频播放错误事件 1.0.0
InnerAudioContext.onPlay 监听音频播放事件 1.0.0
InnerAudioContext.onSeeked 监听音频完成跳转操作的事件 1.0.0
InnerAudioContext.onSeeking 监听音频进行跳转操作的事件 1.0.0
InnerAudioContext.onStop 监听音频停止事件 1.0.0
InnerAudioContext.onTimeUpdate 监听音频播放进度更新事件 1.0.0
InnerAudioContext.onWaiting 监听音频加载中事件 1.0.0
InnerAudioContext.pause 暂停 1.0.0
InnerAudioContext.play 播放 1.0.0
InnerAudioContext.seek 跳转到指定位置 1.0.0
InnerAudioContext.stop 停止 1.0.0

# 11.4.4 MediaAudioPlayer

请注意

以下 API 暂不支持

名称 功能说明
MediaAudioPlayer.addAudioSource 添加音频源
MediaAudioPlayer.destroy 销毁播放器
MediaAudioPlayer.removeAudioSource 移除音频源
MediaAudioPlayer.start 启动播放器
MediaAudioPlayer.stop 停止播放器

# 11.4.5 WebAudioContext

请注意

以下 API 暂不支持

名称 功能说明
WebAudioContext.close 关闭WebAudioContext
WebAudioContext.createAnalyser 创建一个 AnalyserNode
WebAudioContext.createBiquadFilter 创建一个BiquadFilterNode
WebAudioContext.createBuffer 创建一个AudioBuffer,代表着一段驻留在内存中的短音频
WebAudioContext.createBufferSource 创建一个BufferSourceNode实例,通过AudioBuffer对象来播放音频数据
WebAudioContext.createChannelMerger 创建一个ChannelMergerNode
WebAudioContext.createChannelSplitter 创建一个ChannelSplitterNode
WebAudioContext.createConstantSource 创建一个ConstantSourceNode
WebAudioContext.createDelay 创建一个DelayNode
WebAudioContext.createDynamicsCompressor 创建一个DynamicsCompressorNode
WebAudioContext.createGain 创建一个GainNode
WebAudioContext.createIIRFilter 创建一个IIRFilterNode
WebAudioContext.createOscillator 创建一个OscillatorNode
WebAudioContext.createPanner 创建一个PannerNode
WebAudioContext.createPeriodicWave 创建一个PeriodicWaveNode
WebAudioContext.createScriptProcessor 创建一个ScriptProcessorNode
WebAudioContext.createWaveShaper 创建一个WaveShaperNode
WebAudioContext.decodeAudioData 异步解码一段资源为AudioBuffer
WebAudioContext.resume 同步恢复已经被暂停的WebAudioContext上下文
WebAudioContext.suspend 同步暂停WebAudioContext上下文
WebAudioContextNode 一类音频处理模块,不同的Node具备不同的功能,如GainNode(音量调整)等

# 11.5 背景音频

名称 功能说明 版本 备注
ft.stopBackgroundAudio 停止播放音乐 1.0.0
ft.seekBackgroundAudio 控制音乐播放进度 1.0.0
ft.playBackgroundAudio 使用后台播放器播放音乐 1.0.0
ft.pauseBackgroundAudio 暂停播放音乐 1.0.0
ft.onBackgroundAudioStop 监听音乐停止事件 1.0.0
ft.onBackgroundAudioPlay 监听音乐播放事件 1.0.0
ft.onBackgroundAudioPause 监听音乐暂停事件 1.0.0
ft.getBackgroundAudioPlayerState 获取后台音乐播放状态 1.0.0
ft.getbackgroundaudiomanager 获取全局唯一的背景音频管理器 小程序切入后台,如果音频处于播放状态,可以继续播放。但是后台状态不能通过调用API操纵音频的播放状态。 2.12.12

# 11.5.1 backgroundaudiomanager

名称 功能说明 版本 备注
backgroundaudiomanager.onCanplay 监听背景音频进入可播放状态事件 1.0.0
backgroundaudiomanager.onEnded 监听背景音频自然播放结束事件 1.0.0
BackgroundAudioManager.onError 监听背景音频播放错误事件 1.0.0
backgroundaudiomanager.onNext 监听用户在系统音乐播放面板点击下一曲事件(仅iOS) 1.0.0
backgroundaudiomanager.onPause 监听背景音频暂停事件 1.0.0
backgroundaudiomanager.onPlay 监听背景音频播放事件 1.0.0
backgroundaudiomanager.onPrev 监听用户在系统音乐播放面板点击上一曲事件(仅iOS) 1.0.0
backgroundaudiomanager.onSeeked 监听背景音频完成跳转操作事件 1.0.0
backgroundaudiomanager.onSeeking 监听背景音频开始跳转操作事件 1.0.0
backgroundaudiomanager.onStop 监听背景音频停止事件 1.0.0
backgroundaudiomanager.onTimeUpdate 监听背景音频播放进度更新事件,只有小程序在前台时会回调 1.0.0
backgroundaudiomanager.onWaiting 监听音频加载中事件 1.0.0
backgroundaudiomanager.pause 暂停音乐 1.0.0
backgroundaudiomanager.play 播放音乐 1.0.0
backgroundaudiomanager.seek 跳转到指定位置 1.0.0
backgroundaudiomanager.stop 停止音乐 1.0.0

# 11.6 实时音视频

名称 功能说明 版本 备注
ft.createLivePusherContext 创建 live-pusher 上下文 LivePusherContext 对象 1.0.0
ft.createLivePlayerContext 创建 live-player 上下文 LivePlayerContext 对象 1.0.0

# 11.6.1 LivePlayerContext

名称 功能说明 版本 备注
LivePlayerContext.exitFullScreen 退出全屏 1.0.0
LivePlayerContext.exitPictureInPicture 退出小窗,该方法可在任意页面调用 1.0.0
LivePlayerContext.mute 静音 1.0.0
LivePlayerContext.pause 暂停 1.0.0
LivePlayerContext.play 播放 1.0.0
LivePlayerContext.requestFullScreen 进入全屏 1.0.0
LivePlayerContext.requestPictureInPicture 进入小窗 1.0.0
LivePlayerContext.resume 恢复 1.0.0
LivePlayerContext.snapshot 截图 1.0.0
LivePlayerContext.stop 停止 1.0.0

# 11.6.2 LivePusherContext

名称 功能说明 版本 备注
LivePusherContext.exitPictureInPicture 退出小窗,该方法可在任意页面调用 1.0.0
LivePusherContext.pause 暂停推流 1.0.0
LivePusherContext.pauseBGM 暂停背景音 1.0.0
LivePusherContext.playBGM 播放背景音 1.0.0
LivePusherContext.resume 恢复推流 1.0.0
LivePusherContext.resumeBGM 恢复背景音 1.0.0
LivePusherContext.sendMessage 发送SEI消息 1.0.0
LivePusherContext.setBGMVolume 设置背景音音量 1.0.0
LivePusherContext.setMICVolume 设置麦克风音量 1.0.0
LivePusherContext.snapshot 快照 1.0.0
LivePusherContext.start 开始推流,同时开启摄像头预览 1.0.0
LivePusherContext.startPreview 开启摄像头预览 1.0.0
LivePusherContext.stop 停止推流,同时停止摄像头预览 1.0.0
LivePusherContext.stopBGM 停止背景音 1.0.0
LivePusherContext.stopPreview 关闭摄像头预览 1.0.0
LivePusherContext.switchCamera 切换前后摄像头 1.0.0
LivePusherContext.toggleTorch 切换手电筒 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
LivePusherContext.createOffscreenCanvas 创建一个能够承接 LivePusher 采集纹理的离屏 Canvas
LivePusherContext.onCustomRendererEvent 开启自定义渲染时,开发者通过此方法订阅相关事件

# 11.7 录音

名称 功能说明 版本 备注
ft.stopRecord 停止录音 1.0.0
ft.startRecord 开始录音 1.0.0
ft.getRecorderManager 获取全局唯一的录音管理器 RecorderManager 1.0.0

# 11.7.1 RecorderManager

名称 功能说明 版本 备注
RecorderManager.onError 监听录音错误事件 1.0.0
RecorderManager.onFrameRecorded 监听已录制完指定帧大小的文件事件 1.0.0
RecorderManager.onInterruptionBegin 监听录音因为受到系统占用而被中断开始事件 1.0.0
RecorderManager.onInterruptionEnd 监听录音中断结束事件 1.0.0
RecorderManager.onPause 监听录音暂停事件 1.0.0
RecorderManager.onResume 监听录音继续事件 1.0.0
RecorderManager.onStop 监听录音结束事件 1.0.0
RecorderManager.pause 暂停录音 1.0.0
RecorderManager.resume 继续录音 1.0.0
RecorderManager.onStart 监听录音开始事件 1.0.0
RecorderManager.stop 停止录音 1.0.0
RecorderManager.start 开始录音 1.0.0

# 11.8 相机

名称 功能说明 版本 备注
ft.createCameraContext 创建 camera 上下文 CameraContext 对象 1.0.0

# 11.8.1 CameraContext

名称 功能说明 版本 备注
CameraContext.onCameraFrame 获取 Camera 实时帧数据 1.0.0
CameraContext.setZoom 设置缩放级别 1.0.0
CameraContext.startRecord 开始录像 1.0.0
CameraContext.stopRecord 结束录像 1.0.0
CameraContext.takePhoto 拍摄照片 1.0.0

# 11.8.1 CameraFrameListener

名称 功能说明 版本 备注
CameraFrameListener.start 开始监听帧数据 1.0.0
CameraFrameListener.stop 停止监听帧数据 1.0.0

# 11.9 富文本

# 11.9.1 EditorContext

名称 功能说明 版本 备注
EditorContext.blur 编辑器失焦,同时收起键盘 1.0.0
EditorContext.clear 清空编辑器内容 1.0.0
EditorContext.format 修改样式 1.0.0
EditorContext.getContents 获取编辑器内容 1.0.0
EditorContext.getSelectionText 获取编辑器已选区域内的纯文本内容 1.0.0
EditorContext.insertDivider 插入分割线 1.0.0
EditorContext.insertImage 插入图片 1.0.0
EditorContext.insertText 覆盖当前选区,设置一段文本 1.0.0
EditorContext.redo 恢复 1.0.0
EditorContext.removeFormat 清除当前选区的样式 1.0.0
EditorContext.scrollIntoView 使得编辑器光标处滚动到窗口可视区域内 1.0.0
EditorContext.setContents 初始化编辑器内容,html和delta同时存在时仅delta生效 1.0.0
EditorContext.undo 撤销 1.0.0

# 11.10 音视频合成

请注意

以下 API 暂不支持

名称 功能说明
ft.createMediaContainer 创建音视频处理容器,最终可将容器中的轨道合成一个视频

# 11.10.1 MediaContainer

请注意

以下 API 暂不支持

名称 功能说明
MediaContainer.addTrack 将音频或视频轨道添加到容器
MediaContainer.destroy 将容器销毁,释放资源
MediaContainer.export 将容器内的轨道合并并导出视频文件
MediaContainer.extractDataSource 将传入的视频源分离轨道
MediaContainer.removeTrack 将音频或视频轨道从容器中移除
MediaTrack 可通过 MediaContainer.extractDataSource 返回

# 11.11 实时语音

请注意

以下 API 暂不支持

名称 功能说明
ft.updateVoIPChatMuteConfig 更新实时语音静音设置
ft.subscribeVoIPVideoMembers 订阅视频画面成员
ft.setEnable1v1Chat 开启双人通话
ft.onVoIPVideoMembersChanged 监听实时语音通话成员视频状态变化事件
ft.onVoIPChatStateChanged 监听房间状态变化事件
ft.onVoIPChatSpeakersChanged 监听实时语音通话成员通话状态变化事件
ft.onVoIPChatMembersChanged 监听实时语音通话成员在线状态变化事件
ft.offVoIPChatSpeakersChanged 移除实时语音通话成员通话状态变化事件的监听函数
ft.onVoIPChatInterrupted 监听被动断开实时语音通话事件
ft.offVoIPVideoMembersChanged 取消监听实时语音通话成员视频状态变化事件
ft.offVoIPChatStateChanged 取消监听房间状态变化事件
ft.offVoIPChatMembersChanged 取消监听实时语音通话成员在线状态变化事件
ft.offVoIPChatInterrupted 取消监听被动断开实时语音通话事件
ft.joinVoIPChat 加入 (创建) 实时语音通话,更多信息可见 实时语音指南
ft.exitVoIPChat 退出(销毁)实时语音通话
ft.join1v1Chat 加入(创建)双人通话

# 11.12 画面录制器

名称 功能说明 版本 备注
ft.createMediaRecorder 创建 WebGL 画面录制器,可逐帧录制在 WebGL 上渲染的画面并导出视频文件 1.0.0

# 11.12.1 MediaRecorder

名称 功能说明 版本 备注
MediaRecorder.pause 暂停录制 1.0.0
MediaRecorder.resume 恢复录制 1.0.0
MediaRecorder.start 开始录制 1.0.0
MediaRecorder.stop 结束录制 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
MediaRecorder.destroy 销毁录制器
MediaRecorder.off 取消监听录制事件
MediaRecorder.on 注册监听录制事件的回调函数
MediaRecorder.requestFrame 请求下一帧录制,在 callback 里完成一帧渲染后开始录制当前帧

# 11.13 视频解码器

请注意

以下 API 暂不支持

名称 功能说明
ft.createVideoDecoder 创建视频解码器,可逐帧获取解码后的数据

# 11.13.1 VideoDecoder

请注意

以下 API 暂不支持

名称 功能说明
VideoDecoder.getFrameData 获取下一帧的解码数据
VideoDecoder.off 取消监听录制事件
VideoDecoder.on 注册监听录制事件的回调函数
VideoDecoder.remove 移除解码器
VideoDecoder.seek 跳到某个时间点解码
VideoDecoder.start 开始解码
VideoDecoder.stop 停止解码

# 12. 位置

名称 功能说明 版本 备注
ft.openLocation 使用内置地图查看位置 1.0.0
ft.startLocationUpdate 开启小程序进入前台时接收位置消息 1.0.0
ft.getLocation 获取当前的地理位置、速度 1.0.0
ft.choosePoi 打开POI列表选择位置,支持模糊定位(精确到市)和精确定位混选 2.12.1
ft.chooseLocation 打开地图选择位置 1.0.0
ft.stopLocationUpdate 关闭监听实时位置变化,前后台都停止消息接收 3.0.18
ft.startLocationUpdateBackground 开启小程序进入前后台时均接收位置消息,需引导用户开启授权 3.0.18
ft.onLocationChange 监听实时地理位置变化事件,需结合 wx.startLocationUpdateBackground、wx.startLocationUpdate使用 3.0.18
ft.offLocationChange 取消监听实时地理位置变化事件 3.0.18
ft.onLocationChangeError 监听持续定位接口返回失败时触发 3.0.18
ft.offLocationChangeError 移除持续定位接口返回失败时触发 3.0.18

请注意

以下 API 暂不支持

名称 功能说明
getFuzzyLocation 获取当前的模糊地理位置

# 13. 文件

名称 功能说明 版本 备注
ft.saveFile 保存文件到本地 1.0.0
ft.removeSavedFile 删除本地缓存文件 1.0.0
ft.openDocument 新开页面打开文档 1.0.0
ft.getSavedFileList 获取该小程序下已保存的本地缓存文件列表 1.0.0
ft.getSavedFileInfo 获取本地文件的文件信息 1.0.0
ft.getFileSystemManager 获取全局唯一的文件管理器 1.0.0
ft.getFileInfo 获取文件信息 1.0.0
ft.saveFileToDisk 保存文件系统的文件到用户磁盘,仅在 PC 端支持 1.0.0

# 13.1 FileSystemManager

名称 功能说明 版本 备注
FileSystemManager.accessSync 判断文件/目录是否存在 1.0.0
FileSystemManager.access 判断文件/目录是否存在 1.0.0
FileSystemManager.appendFile 在文件结尾追加内容 1.0.0
FileSystemManager.appendFileSync FileSystemManager.appendFile 的同步版本 1.0.0
FileSystemManager.close 关闭文件 1.0.0
FileSystemManager.closeSync 同步关闭文件 1.0.0
FileSystemManager.copyFile 复制文件 1.0.0
FileSystemManager.copyFileSync FileSystemManager.copyFile 的同步版本 1.0.0
FileSystemManager.getFileInfo 获取该小程序下的 本地临时文件 或 本地缓存文件 信息 1.0.0
FileSystemManager.getSavedFileList 获取该小程序下已保存的本地缓存文件列表 1.0.0
FileSystemManager.mkdir 创建目录 1.0.0
FileSystemManager.mkdirSync FileSystemManager.mkdir 的同步版本 1.0.0
FileSystemManager.readdir 读取目录内文件列表 1.0.0
FileSystemManager.readdirSync FileSystemManager.readdir 的同步版本 1.0.0
FileSystemManager.readFile 读取本地文件内容 1.0.0
FileSystemManager.readFileSync FileSystemManager.readFile 的同步版本 1.0.0
FileSystemManager.removeSavedFile 删除该小程序下已保存的本地缓存文件 1.0.0
FileSystemManager.rename 重命名文件 1.0.0
FileSystemManager.renameSync FileSystemManager.rename 的同步版本 1.0.0
FileSystemManager.rmdir 删除目录 1.0.0
FileSystemManager.rmdirSync FileSystemManager.rmdir 的同步版本 1.0.0
FileSystemManager.saveFile 保存临时文件到本地 1.0.0
FileSystemManager.saveFileSync FileSystemManager.saveFile 的同步版本 1.0.0
FileSystemManager.stat 获取文件 Stats 对象 1.0.0
FileSystemManager.statSync FileSystemManager.stat 的同步版本 1.0.0
FileSystemManager.unlink 删除文件 1.0.0
FileSystemManager.unlinkSync FileSystemManager.unlink 的同步版本 1.0.0
FileSystemManager.unzip 解压文件 1.0.0
FileSystemManager.writeFile 写文件 1.0.0
FileSystemManager.writeFileSync FileSystemManager.writeFile 的同步版本 1.0.0
FileSystemManager.write 写入文件 1.0.0
FileSystemManager.writeSync FileSystemManager.write同步版本 1.0.0
FileSystemManager.fstat 获取文件的状态信息 1.0.0
FileSystemManager.fstatSync 同步获取文件的状态信息 1.0.0
FileSystemManager.ftruncate 对文件内容进行截断操作 1.0.0
FileSystemManager.ftruncateSync 对文件内容进行截断操作 1.0.0
FileSystemManager.open 打开文件,返回文件描述符 1.0.0
FileSystemManager.openSync 同步打开文件,返回文件描述符 1.0.0
FileSystemManager.read 读文件 1.0.0
FileSystemManager.readCompressedFile 读取指定压缩类型的本地文件内容 1.0.0
FileSystemManager.readCompressedFileSync 同步读取指定压缩类型的本地文件内容 1.0.0
FileSystemManager.readSync 读文件 1.0.0
FileSystemManager.readZipEntry 读取压缩包内的文件 1.0.0
FileSystemManager.truncate 对文件内容进行截断操作 1.0.0
FileSystemManager.truncateSync 对文件内容进行截断操作 (truncate 的同步版本) 1.0.0
ReadResult 文件读取结果 1.0.0

# 13.2 Stats

名称 功能说明 版本 备注
Stats.isDirectory 判断当前文件是否一个目录 1.0.0
Stats.isFile 判断当前文件是否一个普通文件 1.0.0
WriteResult 文件写入结果 1.0.0

# 14. 开放接口

# 14.1 登录

名称 功能说明 版本 备注
ft.login 调用接口获取登录凭证(code) 1.0.0
ft.checkSession 检查登录态是否过期 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
ft.pluginLogin 该接口仅在小程序插件中可调用,调用接口获得插件用户标志凭证(code)

# 14.2 帐号信息

名称 功能说明 版本 备注
ft.getAccountInfoSync 获取当前帐号信息 1.0.0

# 14.3 用户信息

请注意

  • 以下 API 需要集成扩展SDK或者需要App实现相应的代理方法。
  • 您可以点击 这里 了解如何在小程序中复用微信登录能力。
  • 您可以点击 这里 了解如何实现getUserInfo的iOS代理方法
  • 您可以点击 这里 了解如何实现getUserInfo的android接口方法
名称 功能说明 版本 备注
ft.getUserProfile 获取用户信息 1.0.0 注意使用该api需要集成微信扩展SDK
ft.getUserInfo 获取用户信息 1.0.0 注意使用该api需要App实现代理方法
UserInfo 用户信息 1.0.0

# 14.4 授权

名称 功能说明 版本 备注
ft.authorize 提前向用户发起授权请求 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
ft.authorizeForMiniProgram 仅小程序插件中能调用该接口,用法同 wx.authorize

# 14.5 设置

名称 功能说明 版本 备注
ft.openSetting 调起客户端小程序设置界面,返回用户设置的操作结果 1.0.0
ft.getSetting 获取用户的当前设置 1.0.0
AuthSetting 用户授权设置信息,详情参考权限 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
SubscriptionsSetting 订阅消息设置

# 14.6 收货地址

请注意

以下 API 暂不支持

名称 功能说明
ft.chooseAddress 获取用户收货地址

# 14.7 卡券

请注意

以下 API 暂不支持

名称 功能说明
ft.openCard 查看微信卡包中的卡券
ft.addCard 批量添加卡券

# 14.8 发票

请注意

以下 API 暂不支持

名称 功能说明
ft.chooseInvoiceTitle 选择用户的发票抬头
ft.chooseInvoice 选择用户已有的发票

# 14.9 生物认证

请注意

以下 API 暂不支持

名称 功能说明
ft.startSoterAuthentication 开始 SOTER 生物认证
ft.checkIsSupportSoterAuthentication 获取本机支持的 SOTER 生物认证方式
ft.checkIsSoterEnrolledInDevice 获取设备内是否录入如指纹等生物信息的接口

# 14.10 微信运动

请注意

以下 API 暂不支持

名称 功能说明
ft.shareToWeRun 分享数据到微信运动
ft.getWeRunData 获取用户过去三十天微信运动步数

# 14.11 订阅消息

请注意

以下 API 暂不支持

名称 功能说明
ft.requestSubscribeMessage 调起客户端小程序订阅消息界面,返回用户订阅消息的操作结果
ft.requestSubscribeDeviceMessage 订阅设备消息接口,调用后弹出授权框

# 14.12 微信红包

请注意

以下 API 暂不支持

名称 功能说明
ft.showRedPackage 拉取 h5 领取红包封面页

# 14.13 收藏

请注意

以下 API 暂不支持

名称 功能说明
ft.addVideoToFavorites 收藏视频
ft.addFileToFavorites 收藏文件

# 14.14 车牌

请注意

以下 API 暂不支持

名称 功能说明
ft.chooseLicensePlate 选择车牌号

# 14.15 视频号

请注意

以下 API 暂不支持

名称 功能说明
ft.reserveChannelsLive 预约视频号直播
ft.openChannelsUserProfile 打开视频号主页
ft.openChannelsEvent 打开视频号活动页
ft.openChannelsLive 打开视频号直播
ft.getChannelsShareKey 获取视频号直播卡片/视频卡片的分享来源
ft.openChannelsActivity 打开视频号视频
ft.getChannelsLiveNoticeInfo 获取视频号直播预告信息
ft.getChannelsLiveInfo 获取视频号直播信息

# 14.16 微信群

请注意

以下 API 暂不支持

名称 功能说明
ft.getGroupEnterInfo 获取微信群聊场景下的小程序启动信息

# 14.17 微信客服

请注意

以下 API 暂不支持

名称 功能说明
ft.openCustomerServiceChat 打开微信客服

# 15. 设备

# 15.1 蓝牙-通用

名称 功能说明 版本 备注
ft.stopBluetoothDevicesDiscovery 停止搜寻附近的蓝牙外围设备 1.0.0
ft.startBluetoothDevicesDiscovery 开始搜寻附近的蓝牙外围设备 1.0.0
ft.openBluetoothAdapter 初始化蓝牙模块 1.0.0
ft.onBluetoothDeviceFound 监听搜索到新设备的事件 1.0.0
ft.onBluetoothAdapterStateChange 监听蓝牙适配器状态变化事件 1.0.0
ft.offBluetoothDeviceFound 取消监听寻找到新设备的事件 1.0.0
ft.offBluetoothAdapterStateChange 取消监听蓝牙适配器状态变化事件 1.0.0
ft.makeBluetoothPair 蓝牙配对接口,仅安卓支持 1.0.0
ft.getConnectedBluetoothDevices 根据主服务 UUID 获取已连接的蓝牙设备 1.0.0
ft.getBluetoothDevices 获取在蓝牙模块生效期间所有搜索到的蓝牙设备 1.0.0
ft.getBluetoothAdapterState 获取本机蓝牙适配器状态 1.0.0
ft.closeBluetoothAdapter 关闭蓝牙模块 1.0.0

# 15.2 蓝牙-低功耗中心设备

名称 功能说明 版本 备注
ft.writeBLECharacteristicValue 向蓝牙低功耗设备特征值中写入二进制数据 1.0.0
ft.setBLEMTU 协商设置蓝牙低功耗的最大传输单元 (Maximum Transmission Unit, MTU) 1.0.0
ft.readBLECharacteristicValue 读取蓝牙低功耗设备特征值的二进制数据 1.0.0
ft.onBLEConnectionStateChange 监听蓝牙低功耗连接状态的改变事件 1.0.0
ft.onBLECharacteristicValueChange 监听蓝牙低功耗设备的特征值变化事件 1.0.0
ft.offBLEConnectionStateChange 取消监听蓝牙低功耗连接状态的改变事件 1.0.0
ft.offBLECharacteristicValueChange 取消监听蓝牙低功耗设备的特征值变化事件 1.0.0
ft.notifyBLECharacteristicValueChange 启用蓝牙低功耗设备特征值变化时的 notify 功能,订阅特征 1.0.0
ft.getBLEDeviceServices 获取蓝牙低功耗设备所有服务 (service) 1.0.0
ft.getBLEDeviceRSSI 获取蓝牙低功耗设备的信号强度 (Received Signal Strength Indication, RSSI) 1.0.0
ft.getBLEDeviceCharacteristics 获取蓝牙低功耗设备某个服务中所有特征 (characteristic) 1.0.0
ft.createBLEConnection 连接蓝牙低功耗设备 1.0.0
ft.closeBLEConnection 断开与蓝牙低功耗设备的连接 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
ft.isBluetoothDevicePaired 查询蓝牙设备是否配对,仅安卓支持
ft.onBLEMTUChange 监听蓝牙低功耗的最大传输单元变化事件(仅安卓触发)
ft.offBLEMTUChange 移除蓝牙低功耗的最大传输单元变化事件的监听函数
ft.getBLEMTU 获取蓝牙低功耗的最大传输单元

# 15.3 蓝牙-低功耗外围设备

名称 功能说明 版本 备注
ft.onBLEPeripheralConnectionStateChanged 监听当前外围设备被连接或断开连接事件 1.0.0
ft.offBLEPeripheralConnectionStateChanged 取消监听当前外围设备被连接或断开连接事件 1.0.0
ft.createBLEPeripheralServer 建立本地作为蓝牙低功耗外围设备的服务端,可创建多个 1.0.0

# 15.3.1 BLEPeripheralServer

名称 功能说明 版本 备注
BLEPeripheralServer.addService 添加服务 1.0.0
BLEPeripheralServer.close 关闭当前服务端 1.0.0
BLEPeripheralServer.offCharacteristicReadRequest 取消监听已连接的设备请求读当前外围设备的特征值事件 1.0.0
BLEPeripheralServer.offCharacteristicSubscribed 取消监听特征值订阅事件 1.0.0
BLEPeripheralServer.offcharacteristicUnsubscribed 取消监听取消特征值订阅事件 1.0.0
BLEPeripheralServer.offCharacteristicWriteRequest 取消监听已连接的设备请求写当前外围设备的特征值事件 1.0.0
BLEPeripheralServer.onCharacteristicReadRequest 监听已连接的设备请求读当前外围设备的特征值事件 1.0.0
BLEPeripheralServer.onCharacteristicSubscribed 监听特征值订阅事件,仅 iOS 支持 1.0.0
BLEPeripheralServer.onCharacteristicUnsubscribed 监听取消特征值订阅事件,仅 iOS 支持 1.0.0
BLEPeripheralServer.onCharacteristicWriteRequest 监听已连接的设备请求写当前外围设备的特征值事件 1.0.0
BLEPeripheralServer.removeService 移除服务 1.0.0
BLEPeripheralServer.startAdvertising 开始广播本地创建的外围设备 1.0.0
BLEPeripheralServer.stopAdvertising 停止广播 1.0.0
BLEPeripheralServer.writeCharacteristicValue 往指定特征值写入数据,并通知已连接的主机,从机的特征值已发生变化,该接口会处理是走回包还是走订阅 1.0.0

# 15.4 蓝牙-信标(Beacon)

名称 功能说明 版本 备注
ft.stopBeaconDiscovery 停止搜索附近的 Beacon 设备 1.0.0
ft.startBeaconDiscovery 开始搜索附近的 Beacon 设备 1.0.0
ft.onBeaconUpdate 监听 Beacon 设备更新事件,仅能注册一个监听 1.0.0
ft.onBeaconServiceChange 监听 Beacon 服务状态变化事件,仅能注册一个监听 1.0.0
ft.offBeaconUpdate 取消监听 Beacon 设备更新事件 1.0.0
ft.offBeaconServiceChange 取消监听 Beacon 服务状态变化事件 1.0.0
ft.getBeacons 获取所有已搜索到的 Beacon 设备 1.0.0
BeaconInfo Beacon 设备 1.0.0

# 15.5 NFC

请注意

以下 API 暂不支持

名称 功能说明
ft.stopHCE 关闭 NFC 模块
ft.startHCE 初始化 NFC 模块
ft.sendHCEMessage 发送 NFC 消息
ft.onHCEMessage 监听接收 NFC 设备消息事件,仅能注册一个监听
ft.offHCEMessage 接收 NFC 设备消息事件,取消事件监听
ft.getNFCAdapter 获取 NFC 实例
ft.getHCEState 判断当前设备是否支持 HCE 能力

# 15.5.1 IsoDep

请注意

以下 API 暂不支持

名称 功能说明
IsoDep.close 断开连接
IsoDep.connect 连接 NFC 标签
IsoDep.getHistoricalBytes 获取复位信息
IsoDep.getMaxTransceiveLength 获取最大传输长度
IsoDep.isConnected 检查是否已连接
IsoDep.setTimeout 设置超时时间
IsoDep.transceive 发送数据

# 15.5.2 MifareClassic

请注意

以下 API 暂不支持

名称 功能说明
MifareClassic.close 断开连接
MifareClassic.connect 连接 NFC 标签
MifareClassic.getMaxTransceiveLength 获取最大传输长度
MifareClassic.isConnected 检查是否已连接
MifareClassic.setTimeout 设置超时时间
MifareClassic.transceive 发送数据

# 15.5.2 MifareUltralight

请注意

以下 API 暂不支持

名称 功能说明
MifareUltralight.close 断开连接
MifareUltralight.connect 连接 NFC 标签
MifareUltralight.getMaxTransceiveLength 获取最大传输长度
MifareUltralight.isConnected 检查是否已连接
MifareUltralight.setTimeout 设置超时时间
MifareUltralight.transceive 发送数据

# 15.5.3 Ndef

请注意

以下 API 暂不支持

名称 功能说明
Ndef.close 断开连接
Ndef.connect 连接 NFC 标签
Ndef.isConnected 检查是否已连接
Ndef.offNdefMessage 取消监听 Ndef 消息
Ndef.onNdefMessage 监听 Ndef 消息
Ndef.setTimeout 设置超时时间
Ndef.writeNdefMessage 重写 Ndef 标签内容

# 15.5.4 NfcA

请注意

以下 API 暂不支持

名称 功能说明
NfcA.close 断开连接
NfcA.connect 连接 NFC 标签
NfcA.getAtqa 获取ATQA信息
NfcA.getMaxTransceiveLength 获取最大传输长度
NfcA.getSak 获取SAK信息
NfcA.isConnected 检查是否已连接
NfcA.setTimeout 设置超时时间
NfcA.transceive 发送数据

# 15.5.5 NFCAdapter

请注意

以下 API 暂不支持

名称 功能说明
NFCAdapter.getIsoDep 获取IsoDep实例,实例支持ISO-DEP (ISO 14443-4)标准的读写
NFCAdapter.getMifareClassic 获取MifareClassic实例,实例支持MIFARE Classic标签的读写
NFCAdapter.getMifareUltralight 获取MifareUltralight实例,实例支持MIFARE Ultralight标签的读写
NFCAdapter.getNdef 获取Ndef实例,实例支持对NDEF格式的NFC标签上的NDEF数据的读写
NFCAdapter.getNfcA 获取NfcA实例,实例支持NFC-A (ISO 14443-3A)标准的读写
NFCAdapter.getNfcB 获取NfcB实例,实例支持NFC-B (ISO 14443-3B)标准的读写
NFCAdapter.getNfcF 获取NfcF实例,实例支持NFC-F (JIS 6319-4)标准的读写
NFCAdapter.getNfcV 获取NfcV实例,实例支持NFC-V (ISO 15693)标准的读写
NFCAdapter.offDiscovered 取消监听 NFC Tag
NFCAdapter.onDiscovered 监听 NFC Tag
NFCAdapter.startDiscovery
NFCAdapter.stopDiscovery

# 15.5.6 NfcB

请注意

以下 API 暂不支持

名称 功能说明
NfcB.close 断开连接
NfcB.connect 连接 NFC 标签
NfcB.getMaxTransceiveLength 获取最大传输长度
NfcB.isConnected 检查是否已连接
NfcB.setTimeout 设置超时时间
NfcB.transceive 发送数据

# 15.5.7 NfcF

请注意

以下 API 暂不支持

名称 功能说明
NfcF.close 断开连接
NfcF.connect 连接 NFC 标签
NfcF.getMaxTransceiveLength 获取最大传输长度
NfcF.isConnected 检查是否已连接
NfcF.setTimeout 设置超时时间
NfcF.transceive 发送数据

# 15.5.7 NfcV

请注意

以下 API 暂不支持

名称 功能说明
NfcV.close 断开连接
NfcV.connect 连接 NFC 标签
NfcV.getMaxTransceiveLength 获取最大传输长度
NfcV.isConnected 检查是否已连接
NfcV.setTimeout 设置超时时间
NfcV.transceive 发送数据

# 15.6 Wi-Fi

请注意

以下 API 暂不支持

名称 功能说明
ft.stopWifi 关闭 Wi-Fi 模块
ft.startWifi 初始化 Wi-Fi 模块
ft.setWifiList 设置 wifiList 中 AP 的相关信息
ft.onWifiConnected 监听连接上 Wi-Fi 的事件
ft.onGetWifiList 监听获取到 Wi-Fi 列表数据事件
ft.getWifiList 请求获取 Wi-Fi 列表
ft.getConnectedWifi 获取已连接中的 Wi-Fi 信息
ft.connectWifi 连接 Wi-Fi
ft.onWifiConnectedWithPartialInfo 监听连接上 Wi-Fi 的事件
ft.offWifiConnectedWithPartialInfo 移除连接上 Wi-Fi 的事件的监听函数
ft.offWifiConnected 取消监听连接上 Wi-Fi 的事件
ft.offGetWifiList 取消监听获取到 Wi-Fi 列表数据事件
WifiInfo Wifi 信息

# 15.7 日历

请注意

以下 API 暂不支持

名称 功能说明
ft.addPhoneRepeatCalendar 向系统日历添加重复事件
ft.addPhoneCalendar 向系统日历添加事件

# 15.8 联系人

名称 功能说明 版本 备注
ft.addPhoneContact 添加手机通讯录联系人 1.0.0
ft.chooseContact 拉起手机通讯录,选择联系人 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
ft.searchContacts 查找通讯录,匹配相近的手机号

# 15.9 无障碍

名称 功能说明 版本 备注
ft.checkIsOpenAccessibility 检测是否开启视觉无障碍功能 2.12.1

# 15.10 电量

名称 功能说明 版本 备注
ft.getBatteryInfoSync wx.getBatteryInfo 的同步版本 1.0.0
ft.getBatteryInfo 获取设备电量 1.0.0

# 15.11 剪贴板

名称 功能说明 版本 备注
ft.setClipboardData 设置系统剪贴板的内容 1.0.0
ft.getClipboardData 获取系统剪贴板的内容 1.0.0

# 15.12 网络

名称 功能说明 版本 备注
ft.onNetworkStatusChange 监听网络状态变化事件 1.0.0
ft.offNetworkStatusChange 取消监听网络状态变化事件,参数为空,则取消所有的事件监听 1.0.0
ft.getNetworkType 获取网络类型 1.0.0

请注意

以下 API 暂不支持

名称 功能说明
ft.onNetworkWeakChange 监听弱网状态变化事件
ft.getLocalIPAddress 获取局域网IP地址
ft.offNetworkWeakChange 移除弱网状态变化事件的监听函数

# 15.13 加密

名称 功能说明 版本 备注
ft.getRandomValues 获取密码学安全随机数 1.0.0

# 15.14 屏幕

名称 功能说明 版本 备注
ft.setVisualEffectOnCapture 设置截屏/录屏时屏幕表现,仅支持在 Android 端调用 2.12.16
ft.setScreenBrightness 设置屏幕亮度 1.0.0
ft.setKeepScreenOn 设置是否保持常亮状态 1.3.9
ft.onUserCaptureScreen 监听用户主动截屏事件 1.0.0
ft.onScreenRecordingStateChanged 监听用户录屏事件 2.12.16
ft.offUserCaptureScreen 用户主动截屏事件 1.0.0
ft.offScreenRecordingStateChanged 移除用户录屏事件的监听函数 2.12.16
ft.getScreenRecordingState 查询用户是否在录屏 2.12.16
ft.getScreenBrightness 获取屏幕亮度 1.0.0

# 15.15 键盘

名称 功能说明 版本 备注
ft.onKeyboardHeightChange 监听键盘高度变化 1.0.0
ft.offKeyboardHeightChange 取消监听键盘高度变化事件 1.0.0
ft.hideKeyboard 在input、textarea等focus拉起键盘之后,手动调用此接口收起键盘 1.0.0
ft.getSelectedTextRange 在input、textarea等focus之后,获取输入框的光标位置 1.0.0

# 15.16 电话

名称 功能说明 版本 备注
ft.makePhoneCall 拨打电话 1.0.0

# 15.17 加速计

名称 功能说明 版本 备注
ft.stopAccelerometer 停止监听加速度数据 1.0.0
ft.startAccelerometer 开始监听加速度数据 1.0.0
ft.onAccelerometerChange 监听加速度数据事件 1.0.0
ft.offAccelerometerChange 取消监听加速度数据事件,参数为空,则取消所有的事件监听 1.0.0

# 15.18 罗盘

名称 功能说明 版本 备注
ft.stopCompass 停止监听罗盘数据 1.0.0
ft.startCompass 开始监听罗盘数据 1.0.0
ft.onCompassChange 监听罗盘数据变化事件 1.0.0
ft.offCompassChange 取消监听罗盘数据变化事件,参数为空,则取消所有的事件监听 1.0.0

# 15.19 设备方向

名称 功能说明 版本 备注
ft.stopDeviceMotionListening 停止监听设备方向的变化 1.0.0
ft.startDeviceMotionListening 开始监听设备方向的变化 1.0.0
ft.onDeviceMotionChange 监听设备方向变化事件 1.0.0
ft.offDeviceMotionChange 取消监听设备方向变化事件,参数为空,则取消所有的事件监听 1.0.0

# 15.20 陀螺仪

请注意

以下 API 暂不支持

名称 功能说明
ft.stopGyroscope 停止监听陀螺仪数据
ft.startGyroscope 开始监听陀螺仪数据
ft.onGyroscopeChange 监听陀螺仪数据变化事件
ft.offGyroscopeChange 取消监听陀螺仪数据变化事件

# 15.21 内存

请注意

以下 API 暂不支持

名称 功能说明
ft.onMemoryWarning 监听内存不足告警事件
ft.offMemoryWarning 取消监听内存不足告警事件

# 15.22 扫码

名称 功能说明 版本 备注
ft.scanCode 调起客户端扫码界面进行扫码 1.0.0

# 15.23 振动

名称 功能说明 版本 备注
ft.vibrateShort 使手机发生较短时间的振动(15 ms) 1.0.0
ft.vibrateLong 使手机发生较长时间的振动(400 ms) 1.0.0

# 15.24 短信

请注意

以下 API 暂不支持

名称 功能说明
ft.sendSms 拉起手机发送短信界面

# 16. AI

# 16.1 视觉算法

请注意

以下 API 暂不支持

名称 功能说明
wx.isVKSupport 判断支持版本
wx.createVKSession 创建 vision kit 会话对象
VKBodyAnchor 人体 anchor

# 16.2 VKCamera

请注意

以下 API 暂不支持

名称 功能说明
VKCamera.getProjectionMatrix 获取投影矩阵
VKFaceAnchor 人脸 anchor

# 16.3 VKFrame

请注意

以下 API 暂不支持

名称 功能说明
VKFrame.getCameraBuffer 获取当前帧 rgba buffer
VKFrame.getCameraTexture 获取当前帧纹理,目前只支持 YUV 纹理
VKFrame.getDisplayTransform 获取纹理调整矩阵
VKMarkerAnchor marker anchor
VKOSDAnchor OSD anchor
VKHandAnchor 手势 anchor
VKPlaneAnchor 平面 anchor,只有 v2 版本支持

# 16.4 VKSession

请注意

以下 API 暂不支持

名称 功能说明
VKSession.addMarker 添加一个 marker,要求调 wx.createVKSession 时传入的 track.marker 为 true
VKSession.addOSDMarker 添加一个 OSD marker(one-shot detection marker),要求调 wx.createVKSession 时传入的 track.OSD 为 true
VKSession.cancelAnimationFrame 取消由 requestAnimationFrame 添加到计划中的动画帧请求
VKSession.destroy 销毁会话
VKSession.detectFace 静态图像人脸关键点检测
VKSession.getAllMarker 获取所有 marker,要求调 wx.createVKSession 时传入的 track.marker 为 true
VKSession.getAllOSDMarker 获取所有 OSD marker,要求调 wx.createVKSession 时传入的 track.OSD 为 true
VKSession.getVKFrame 获取帧对象,每调用一次都会触发一次帧分析过程
VKSession.hitTest 触摸检测,v1 版本只支持单平面(即 hitTest 生成一次平面后,后续 hitTest 均不会再生成平面,而是以之前生成的平面为基础进行检测)
VKSession.detectHand 静态图像手势关键点检测。当 wx.createVKSession 参数传入 {track: {hand: {mode: 2} } } 时可用。
VKSession.detectBody 静态图像人体关键点检测。当 wx.createVKSession 参数传入 {track: {body: {mode: 2} } } 时可用。
VKSession.off 取消监听会话事件
VKSession.on 监听会话事件
VKSession.runOCR 静态图像 OCR 检测。当 wx.createVKSession 参数传入 {track: {OCR: {mode: 2} } } 时可用。
VKSession.removeMarker 删除一个 marker,要求调 wx.createVKSession 时传入的 track.marker 为 true
VKSession.removeOSDMarker 删除一个 OSD marker,要求调 wx.createVKSession 时传入的 track.OSD 为 true
VKSession.requestAnimationFrame 在下次进行重绘时执行
VKSession.start 开启会话
VKSession.stop 停止会话
VKSession.updateOSDThreshold 更新 OSD 识别精确度,要求调 wx.createVKSession 时传入的 track.OSD 为 true

# 16.5 人脸识别

请注意

以下 API 暂不支持,但您可查看 FinClip 金融场景 API 获取对应信息。

名称 功能说明
ft.stopFaceDetect 停止人脸识别
ft.initFaceDetect 初始化人脸识别
ft.faceDetect 人脸识别,使用前需要通过 wx.initFaceDetect 进行一次初始化,推荐使用相机接口返回的帧数据

# 17. Worker

请注意

以下 API 暂不支持

名称 功能说明
ft.createWorker 创建一个 Worker 线程

# 17.1 Worker

请注意

以下 API 暂不支持

名称 功能说明
Worker.getCameraFrameData 获取摄像头当前帧图像,返回ArrayBuffer数据
Worker.onMessage 监听主线程/Worker 线程向当前线程发送的消息的事件
Worker.onProcessKilled 监听 worker线程被系统回收事件(当iOS系统资源紧张时,worker线程存在被系统回收的可能,开发者可监听此事件并重新创建一个worker)
Worker.postMessage 向主线程/Worker 线程发送的消息
Worker.terminate 结束当前 Worker 线程
Worker.testOnProcessKilled 用于模拟 iOS ExperimentalWorker 线程被系统回收事件,以便于调试。接口仅在 worker 线程内可用。

# 18. FXML

名称 功能说明 版本 备注
ft.createSelectorQuery 返回一个 SelectorQuery 对象实例 1.0.0
ft.createIntersectionObserver 创建并返回一个 IntersectionObserver 对象实例 1.0.0

# 18.1 IntersectionObserver

名称 功能说明 版本 备注
IntersectionObserver.disconnect 停止监听 1.0.0
IntersectionObserver.observe 指定目标节点并开始监听相交状态变化情况 1.0.0
IntersectionObserver.relativeTo 使用选择器指定一个节点,作为参照区域之一 1.0.0
IntersectionObserver.relativeToViewport 指定页面显示区域作为参照区域之一 1.0.0

# 18.2 MediaQueryObserver

名称 功能说明 版本 备注
MediaQueryObserver.disconnect 停止监听 1.0.0
MediaQueryObserver.observe 开始监听页面 media query 变化情况 1.0.0

# 18.3 NodesRef

名称 功能说明 版本 备注
NodesRef.boundingClientRect 添加节点的布局位置的查询请求 1.0.0
NodesRef.context 添加节点的 Context 对象查询请求 1.0.0
NodesRef.fields 获取节点的相关信息 1.0.0
NodesRef.scrollOffset 添加节点的滚动位置查询请求 1.0.0
NodesRef.node 获取 Node 节点实例 2.12.12

# 18.4 SelectorQuery

名称 功能说明 版本 备注
SelectorQuery.exec 执行所有的请求 1.0.0
SelectorQuery.in 将选择器的选取范围更改为自定义组件 component 内 1.0.0
SelectorQuery.select 在当前页面下选择第一个匹配选择器 selector 的节点 1.0.0
SelectorQuery.selectAll 在当前页面下选择匹配选择器 selector 的所有节点 1.0.0
SelectorQuery.selectViewport 选择显示区域 1.0.0

# 19. 第三方平台

请注意

以下 API 暂不支持

名称 功能说明
ft.getExtConfigSync wx.getExtConfig 的同步版本
ft.getExtConfig 获取第三方平台自定义的数据字段

# 20. 广告

请注意

以下 API 暂不支持

名称 功能说明
ft.createRewardedVideoAd 创建激励视频广告组件
ft.createInterstitialAd 创建插屏广告组件

# 20.1 InterstitialAd

请注意

以下 API 暂不支持

名称 功能说明
InterstitialAd.destroy 销毁插屏广告实例
InterstitialAd.load 加载插屏广告
InterstitialAd.offClose 移除插屏广告关闭事件的监听函数
InterstitialAd.offError 移除插屏错误事件的监听函数
InterstitialAd.offLoad 移除插屏广告加载事件的监听函数
InterstitialAd.onClose 监听插屏广告关闭事件
InterstitialAd.onError 监听插屏错误事件
InterstitialAd.onLoad 监听插屏广告加载事件
InterstitialAd.show 显示插屏广告

# 20.2 RewardedVideoAd

请注意

以下 API 暂不支持

名称 功能说明
RewardedVideoAd.destroy 销毁激励视频广告实例
RewardedVideoAd.load 加载激励视频广告
RewardedVideoAd.offClose 移除用户点击 关闭广告 按钮的事件的监听函数
RewardedVideoAd.offError 移除激励视频错误事件的监听函数
RewardedVideoAd.offLoad 移除激励视频广告加载事件的监听函数
RewardedVideoAd.onClose 监听用户点击 关闭广告 按钮的事件
RewardedVideoAd.onError 监听激励视频错误事件
RewardedVideoAd.onLoad 监听激励视频广告加载事件
RewardedVideoAd.show 显示激励视频广告

# 21. 其他

名称 功能说明
ft.onCustomEvent 监听原生派发的onCustomEvent事件
ft.offCustomEvent 取消监听原生派发的onCustomEvent事件
ft.getSuperviseInfo 获取监控信息
ft.sendWebviewEvent 小程序发送事件给 H5
© 2022 FinClip with ❤

👋🏻 嘿,你好!

「FinClip」是一套基于云原生框架设计的小程序容器。能够让任何移动应用在集成小程序SDK之后,获得可用、安全的小程序运行能力。

>> 点我免费注册体验

查看产品文档
了解与 FinClip 相关的一切信息

产品博客 👈  了解产品更新与核心功能介绍
资源下载 👈  获取小程序 SDK 与开发工具
文档中心 👈  查询 FinClip 小程序开发指南与答疑

商务咨询热线
预约 FinClip 产品介绍,咨询商务报价或私有化部署事宜

0755-86967467

获取产品帮助
联系 FinClip 技术顾问,获取产品资料或加入开发者社群

联系线上
人工客服

或 👉  点击这里,提交咨询工单