API 总览

基础

系统

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

更新

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

请注意

以下 API 暂不支持

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

生命周期

名称	功能说明	版本	备注
ft.onShow	监听小游戏回到前台的事件	1.0.0
ft.onHide	监听小游戏隐藏到后台事件	1.0.0
ft.offShow	取消监听小游戏回到前台的事件	1.0.0
ft.offHide	取消监听小游戏隐藏到后台事件	1.0.0
ft.getLaunchOptionsSync	获取小游戏启动时的参数	1.0.0
ft.getEnterOptionsSync	获取本次小游戏启动时的参数	1.0.0

应用级事件

名称	功能说明	版本	备注
ft.onError	监听小游戏错误事件	1.0.0
ft.onAudioInterruptionBegin	监听音频因为受到系统占用而被中断开始事件	3.0.50
ft.onAudioInterruptionEnd	监听音频中断结束事件	3.0.50
ft.offError	取消监听小游戏错误事件	1.0.0
ft.offAudioInterruptionBegin	取消监听音频因为受到系统占用而被中断开始事件	3.0.50
ft.offAudioInterruptionEnd	取消监听音频中断结束事件	3.0.50

请注意

以下 API 暂不支持

名称	功能说明
ft.onUnhandledRejection	监听未处理的 Promise 拒绝事件
ft.onAudioInterruptionEnd	监听音频中断结束事件
ft.onAudioInterruptionBegin	监听音频因为受到系统占用而被中断开始事件
ft.offUnhandledRejection	取消监听未处理的 Promise 拒绝事件
ft.offAudioInterruptionEnd	取消监听音频中断结束事件
ft.offAudioInterruptionBegin	取消监听音频因为受到系统占用而被中断开始事件

调试

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

请注意

以下 API 暂不支持

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

性能

请注意

以下 API 暂不支持

名称	功能说明
ft.reportPerformance	小游戏测速上报
ft.getPerformance	获取当前小游戏性能相关的信息

加密

请注意

以下 API 暂不支持

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

跳转

名称	功能说明	版本	备注
ft.navigateToMiniProgram	打开另一个小程序	1.0.0
ft.exitMiniProgram	退出当前小游戏	1.0.0
ft.navigateToWechatMiniProgram	跳转打开微信小程序	2.40.7

转发

名称	功能说明	版本	备注
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	验证私密消息

界面

交互

名称	功能说明	版本	备注
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.showNavigationBarLoading	在当前页面显示导航条加载动画	1.0.0
ft.setNavigationBarTitle	动态设置当前页面的标题	1.0.0
ft.setNavigationBarColor	设置页面导航条颜色	1.0.0
ft.hideNavigationBarLoading	在当前页面隐藏导航条加载动画	1.0.0

请注意

以下 API 暂不支持

名称	功能说明
ft.hideHomeButton	隐藏返回首页按钮

菜单

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

窗口

请注意

以下 API 暂不支持

名称	功能说明
ft.setWindowSize	设置窗口大小，该接口仅适用于 PC 平台，使用细则请参见指南
ft.onWindowResize	监听窗口尺寸变化事件
ft.offWindowResize	取消监听窗口尺寸变化事件

网络

发起请求

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

下载

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

上传

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

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

UDP 通信

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

支付

请注意

以下 API 暂不支持

名称	功能说明
ft.requestMidasPayment	发起米大师支付
ft.requestMidasFriendPayment	发起米大师朋友礼物索要

数据缓存

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

请注意

以下 API 暂不支持

名称	功能说明	版本	备注
ft.revokeBufferURL	根据 URL 销毁存在内存中的数据	1.0.0
ft.createBufferURL	根据传入的 buffer 创建一个唯一的 URL 存在内存中	1.0.0

数据分析

请注意

以下 API 暂不支持

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

渲染

画布

名称	功能说明	版本	备注
ft.createCanvas	创建一个画布对象	1.0.0

Canvas

名称	功能说明	版本	备注
Canvas.getContext	获取画布对象的绘图上下文	1.0.0
RenderingContext	画布对象的绘图上下文	1.0.0

请注意

以下 API 暂不支持

名称	功能说明
Canvas.toDataURL	把画布上的绘制内容以一个 data URI 的格式返回
Canvas.toTempFilePath	将当前 Canvas 保存为一个临时文件
Canvas.toTempFilePathSync	Canvas.toTempFilePath 的同步版本
WebGLRenderingContext.wxBindCanvasTexture	将一个 Canvas 对应的 Texture 绑定到 WebGL 上下文

图片

名称	功能说明	版本	备注
ft.createImage	创建一个图片对象	1.0.0
Image	图片对象	1.0.0

字体

名称	功能说明	版本	备注
ft.loadFont	加载字体	3.0.50
ft.getTextLineHeight	获取文本内容高度	3.0.50

媒体

音频

名称	功能说明	版本	备注
ft.setInnerAudioOption	设置 InnerAudioContext 的播放选项	1.0.0
ft.createInnerAudioContext	创建内部 audio 上下文 InnerAudioContext 对象	1.0.0

请注意

以下 API 暂不支持

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

图片

名称	功能说明	版本	备注
ft.saveImageToPhotosAlbum	保存图片到系统相册	1.0.0
ft.previewMedia	预览图片和视频	1.0.0
ft.previewImage	在新页面中全屏预览图片	1.0.0
ft.chooseImage	从本地相册选择图片或使用相机拍照	1.0.0

录音

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

视频

名称	功能说明	版本	备注
ft.createVideoContext	创建 video 上下文 VideoContext 对象	1.0.0

相机

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

视频解码器

请注意

以下 API 暂不支持

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

实时语音

请注意

以下 API 暂不支持

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

位置

名称	功能说明	版本	备注
ft.getLocation	获取当前的地理位置、速度	1.0.0

文件

名称	功能说明	版本	备注
ft.getFileSystemManager	获取全局唯一的文件管理器	1.0.0
ft.getFileInfo	获取文件信息	1.0.0

请注意

以下 API 暂不支持

名称	功能说明
ft.saveFileToDisk	保存文件系统的文件到用户磁盘，仅在 PC 端支持

开放接口

用户信息

请注意

以下 API 暂不支持，您可以点击 这里 了解如何在小程序中复用微信登录能力。

名称	功能说明
ft.getUserProfile	获取用户信息
ft.getUserInfo	获取用户信息
UserInfo	用户信息

登录

请注意

以下 API 暂不支持，您可以点击 这里 了解如何在小程序中复用微信登录能力。

名称	功能说明
ft.login	调用接口获取登录凭证（code）
ft.checkSession	检查登录态是否过期

授权

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

请注意

以下 API 暂不支持

名称	功能说明
ft.authorizeForMiniProgram	仅小游戏插件中能调用该接口，用法同 ft.authorize

帐号信息

名称	功能说明
ft.getAccountInfoSync	获取当前帐号信息

设置

名称	功能说明
ft.openSetting	调起客户端小游戏设置界面，返回用户设置的操作结果
ft.getSetting	获取用户的当前设置
AuthSetting	用户授权设置信息，详情参考权限

请注意

以下 API 暂不支持

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

收货地址

请注意

以下 API 暂不支持

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

卡券

请注意

以下 API 暂不支持

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

发票

请注意

以下 API 暂不支持

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

生物认证

请注意

以下 API 暂不支持

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

微信运动

请注意

以下 API 暂不支持

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

订阅消息

请注意

以下 API 暂不支持

名称	功能说明
ft.requestSubscribeMessage	调起客户端小游戏订阅消息界面，返回用户订阅消息的操作结果

微信红包

请注意

以下 API 暂不支持

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

收藏

请注意

以下 API 暂不支持

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

车牌

请注意

以下 API 暂不支持

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

视频号

请注意

以下 API 暂不支持

名称	功能说明
ft.reserveChannelsLive	预约视频号直播
ft.openChannelsLive	打开视频号直播
ft.openChannelsActivity	打开视频号视频
ft.getChannelsLiveNoticeInfo	获取视频号直播预告信息
ft.getChannelsLiveInfo	获取视频号直播信息

微信群

请注意

以下 API 暂不支持

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

微信客服

请注意

以下 API 暂不支持

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

设备

蓝牙-通用

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

蓝牙-低功耗中心设备

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

蓝牙-低功耗外围设备

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

蓝牙-信标(Beacon)

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

NFC

请注意

以下 API 暂不支持

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

Wi-Fi

请注意

以下 API 暂不支持

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

无障碍

请注意

以下 API 暂不支持

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

电量

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

剪贴板

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

网络

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

屏幕

名称	功能说明	版本	备注
ft.setScreenBrightness	设置屏幕亮度	1.0.0
ft.setKeepScreenOn	设置是否保持常亮状态	1.0.0
ft.onUserCaptureScreen	监听用户主动截屏事件	1.0.0
ft.offUserCaptureScreen	用户主动截屏事件	1.0.0
ft.getScreenBrightness	获取屏幕亮度	1.0.0

键盘

名称	功能说明	版本	备注
ft.showKeyboard	展示键盘	3.0.50
ft.updateKeyboard	更新输入框内容	3.0.50
ft.hideKeyboard	使用 showKeyboard 拉起键盘之后，手动调用此接口收起键盘	1.0.0
ft.onKeyboardInput	监听键盘输入事件	3.0.50
ft.onKeyboardHeightChange	监听键盘高度变化	1.0.0
ft.onKeyboardConfirm	监听用户点击键盘 Confirm 按钮时的事件	3.0.50
ft.onKeyboardComplete	监听键盘收起的事件	3.0.50
ft.offKeyboardInput	取消监听键盘输入事件	3.0.50
ft.offKeyboardHeightChange	取消监听键盘高度变化事件	1.0.0
ft.offKeyboardConfirm	取消监听用户点击键盘 Confirm 按钮时的事件	3.0.50
ft.offKeyboardComplete	取消监听键盘收起的事件	3.0.50

加速计

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

罗盘

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

设备方向

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

转屏

名称	功能说明	版本	备注
ft.setDeviceOrientation	切换横竖屏	3.0.50
ft.onDeviceOrientationChange	监听屏幕转向切换事件	3.0.50
ft.offDeviceOrientationChange	取消监听屏幕转向切换事件	3.0.50

陀螺仪

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

内存

请注意

以下 API 暂不支持

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

扫码

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

振动

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

AI/人脸识别

请注意

以下 API 暂不支持

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

Worker

请注意

以下 API 暂不支持

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

其他

名称	功能说明
ft.onCustomEvent	监听原生派发的 onCustomEvent 事件
ft.offCustomEvent	取消监听原生派发的 onCustomEvent 事件
ft.addCustomEventListener	监听原生派发的事件
ft.removeCustomEventListener	取消监听原生派发的事件