# API Overview

# Basic

# System

Name Function Description Version Remarks
ft.getSystemInfoSync Synchronous version of ft.getSystemInfo 1.0.0
ft.getSystemInfoAsync Asynchronously get system information 1.0.0
ft.getSystemInfo Get system information 1.0.0

# Update

Name Function Description Version Remarks
ft.getUpdateManager Get a globally unique update manager for managing Mini-Game updates 1.0.0

Note

The following APIs are not currently supported

Name Function Description
ft.updateWeChatApp Update client version

# Mini-Game

# Lifecycle

Name Function Description Version Remarks
ft.onShow Listen for the event when the Mini-Game returns to the foreground 1.0.0
ft.onHide Listen for the event when the Mini-Game is hidden to the background 1.0.0
ft.offShow Cancel listening for the event when the Mini-Game returns to the foreground 1.0.0
ft.offHide Cancel listening for the event when the Mini-Game is hidden to the background 1.0.0
ft.getLaunchOptionsSync Get the parameters when the Mini-Game starts 1.0.0
ft.getEnterOptionsSync Get the parameters for this Mini-Game launch 1.0.0

# App-Level Events

Name Function Description Version Remarks
ft.onError Listen for Mini-Game error events 1.0.0
ft.onAudioInterruptionBegin Listen for the event when audio is interrupted due to system occupation 3.0.50
ft.onAudioInterruptionEnd Listen for the end of audio interruption event 3.0.50
ft.offError Cancel listening for Mini-Game error events 1.0.0
ft.offAudioInterruptionBegin Cancel listening for the event when audio is interrupted due to system occupation 3.0.50
ft.offAudioInterruptionEnd Cancel listening for the end of audio interruption event 3.0.50

Note

The following APIs are not currently supported

Name Function Description
ft.onUnhandledRejection Listen for unhandled Promise rejection events
ft.offUnhandledRejection Cancel listening for unhandled Promise rejection events

# Debugging

Name Function Description Version Remarks
ft.setEnableDebug Set whether to turn on the debug switch 1.0.0

Note

The following APIs are not currently supported

Name Function Description
ft.getRealtimeLogManager Get real-time log manager object
ft.getLogManager Get log manager object

# Performance

Note

The following APIs are not currently supported

Name Function Description
ft.reportPerformance Mini-Game speed measurement reporting
ft.getPerformance Get performance-related information for the current Mini-Game

# Encryption

Note

The following APIs are not currently supported

Name Function Description
ft.getUserCryptoManager Get user encryption module
Name Function Description Version Remarks
ft.navigateToMiniProgram Open another Mini-Program 1.0.0
ft.exitMiniProgram Exit the current Mini-Game 1.0.0
ft.navigateToWechatMiniProgram Jump to open WeChat Mini-Program 2.40.7

# Sharing

Name Function Description Version Remarks
ft.showShareMenu Show the share button on the current page 1.0.0
ft.hideShareMenu Hide the share button on the current page 1.0.0
ft.updateShareMenu Update sharing attributes 1.0.0

Note

The following APIs are not currently supported

Name Function Description
ft.showShareImageMenu Open the share image popup, allowing images to be sent to friends, favorited, or downloaded
ft.shareVideoMessage Share video to chat
ft.shareFileMessage Share file to chat
ft.onCopyUrl Listen for the event triggered when the user clicks the "Copy Link" button in the top-right menu
ft.offCopyUrl Cancel listening for the event triggered when the user clicks the "Copy Link" button in the top-right menu
ft.getShareInfo Get detailed sharing information
ft.authPrivateMessage Verify private message

# Interface

# Interaction

Name Function Description Version Remarks
ft.showToast Display a message prompt box 1.0.0
ft.showModal Display a modal dialog box 1.0.0
ft.showLoading Display a loading prompt box 1.0.0
ft.showActionSheet Display an action menu 1.0.0
ft.hideToast Hide the message prompt box 1.0.0
ft.hideLoading Hide the loading prompt box 1.0.0
Name Function Description Version Remarks
ft.showNavigationBarLoading Display navigation bar loading animation on the current page 1.0.0
ft.setNavigationBarTitle Dynamically set the title of the current page 1.0.0
ft.setNavigationBarColor Set the color of the page navigation bar 1.0.0
ft.hideNavigationBarLoading Hide navigation bar loading animation on the current page 1.0.0

Note

The following APIs are not currently supported

Name Function Description
ft.hideHomeButton Hide the home button
Name Function Description Version Remarks
ft.getMenuButtonBoundingClientRect Get the layout position information of the menu button (top-right capsule button) 1.0.0

# Window

Note

The following APIs are not currently supported

Name Function Description
ft.setWindowSize Set window size; this interface is only applicable to PC platforms; see the guide for usage details
ft.onWindowResize Listen for window size change events
ft.offWindowResize Cancel listening for window size change events

# Network

# Initiate Request

Name Function Description Version Remarks
ft.request Initiate HTTPS network request 1.0.0

# Download

Name Function Description Version Remarks
ft.downloadFile Download file resources to local storage 1.0.0

# Upload

Name Function Description Version Remarks
ft.uploadFile Upload local resources to the server 1.0.0

# WebSocket

Name Function Description Version Remarks
ft.sendSocketMessage Send data through WebSocket connection 1.0.0
ft.onSocketOpen Listen for WebSocket connection open event 1.0.0
ft.onSocketMessage Listen for WebSocket receiving server messages event 1.0.0
ft.onSocketError Listen for WebSocket error event 1.0.0
ft.onSocketClose Listen for WebSocket connection close event 1.0.0
ft.connectSocket Create a WebSocket connection 1.0.0
ft.closeSocket Close WebSocket connection 1.0.0

# UDP Communication

Name Function Description Version Remarks
ft.createUDPSocket Create a UDP Socket instance 1.0.0

# Payment

Note

The following APIs are not currently supported

Name Function Description
ft.requestMidasPayment Initiate MiDaSi payment
ft.requestMidasFriendPayment Initiate MiDaSi friend gift request

# Data Storage

Name Function Description Version Remarks
ft.setStorageSync Synchronous version of ft.setStorage 1.0.0
ft.setStorage Store data in the local cache at the specified key 1.0.0
ft.removeStorageSync Synchronous version of ft.removeStorage 1.0.0
ft.removeStorage Remove the specified key from the local cache 1.0.0
ft.getStorageSync Synchronous version of ft.getStorage 1.0.0
ft.getStorageInfoSync Synchronous version of ft.getStorageInfo 1.0.0
ft.getStorageInfo Asynchronously get information about the current storage 1.0.0
ft.getStorage Asynchronously get the content of the specified key from the local cache 1.0.0
ft.clearStorageSync Synchronous version of ft.clearStorage 1.0.0
ft.clearStorage Clear local data cache 1.0.0

Note

The following APIs are not currently supported

Name Function Description Version Remarks
ft.revokeBufferURL Destroy data in memory based on URL 1.0.0
ft.createBufferURL Create a unique URL in memory based on the passed buffer 1.0.0

# Data Analytics

Note

The following APIs are not currently supported

Name Function Description
ft.reportMonitor Custom business data monitoring reporting interface
ft.reportEvent Event reporting
ft.reportAnalytics Custom analytics data reporting interface
ft.getExptInfoSync Given an array of experiment parameters, get the corresponding experiment parameter values

# Rendering

# Canvas

Name Function Description Version Remarks
ft.createCanvas Create a canvas object 1.0.0

# Canvas

Name Function Description Version Remarks
Canvas.getContext Get the drawing context of the canvas object 1.0.0
Canvas.toDataURL Return a data URI containing the image representation 3.0.0

Note

The following APIs are not currently supported

Name Function Description
Canvas.toTempFilePath Save the current Canvas as a temporary file
Canvas.toTempFilePathSync Synchronous version of Canvas.toTempFilePath
WebGLRenderingContext.wxBindCanvasTexture Bind a Texture corresponding to a Canvas to the WebGL context

# Images

Name Function Description Version Remarks
ft.createImage Create an image object 1.0.0
Image Image object 1.0.0

# Fonts

Name Function Description Version Remarks
ft.loadFont Load font 3.0.50
ft.getTextLineHeight Get text content height 3.0.50

# Media

# Audio

Name Function Description Version Remarks
ft.setInnerAudioOption Set playback options for InnerAudioContext 1.0.0
ft.createInnerAudioContext Create an InnerAudioContext object for internal audio context 1.0.0

Please note

The following APIs are not currently supported

Name Function Description
ft.getAvailableAudioSources Get the currently supported audio input sources
ft.createWebAudioContext Create a WebAudio context
ft.createMediaAudioPlayer Create a MediaAudioPlayer object, which can be used to play audio output from VideoDecoder

# Images

Name Function Description Version Remarks
ft.saveImageToPhotosAlbum Save image to system album 1.0.0
ft.previewMedia Preview images and videos 1.0.0
ft.previewImage Full-screen preview of images in a new page 1.0.0
ft.chooseImage Select images from the local album or take a photo using the camera 1.0.0

# Recording

Name Function Description Version Remarks
ft.getRecorderManager Get the globally unique RecorderManager 1.0.0

# Video

Name Function Description Version Remarks
ft.createVideoContext Create a VideoContext object for video 1.0.0

# Camera

Name Function Description Version Remarks
ft.createCameraContext Create a CameraContext object for camera 1.0.0

# Video Decoder

Please note

The following APIs are not currently supported

Name Function Description
ft.createVideoDecoder Create a video decoder to obtain frame-by-frame decoded data

# Real-Time Voice

Please note

The following APIs are not currently supported

Name Function Description
ft.updateVoIPChatMuteConfig Update real-time voice mute settings
ft.subscribeVoIPVideoMembers Subscribe to video member streams
ft.onVoIPVideoMembersChanged Listen for changes in the video status of real-time voice call members
ft.onVoIPChatStateChanged Listen for room state change events
ft.onVoIPChatSpeakersChanged Listen for changes in the call status of real-time voice call members
ft.onVoIPChatMembersChanged Listen for changes in the online status of real-time voice call members
ft.onVoIPChatInterrupted Listen for passive disconnection events of real-time voice calls
ft.offVoIPVideoMembersChanged Stop listening for changes in the video status of real-time voice call members
ft.offVoIPChatStateChanged Stop listening for room state change events
ft.offVoIPChatMembersChanged Stop listening for changes in the online status of real-time voice call members
ft.offVoIPChatInterrupted Stop listening for passive disconnection events of real-time voice calls
ft.joinVoIPChat Join (create) a real-time voice call; for more information, see the Real-Time Voice Guide
ft.exitVoIPChat Exit (destroy) a real-time voice call

# Location

Name Function Description Version Remarks
ft.getLocation Get the current geographical location and speed 1.0.0

# Files

Name Function Description Version Remarks
ft.saveFile Save a file locally 1.0.0
ft.removeSavedFile Delete a locally cached file 1.0.0
ft.openDocument Open a document in a new page 1.0.0
ft.getSavedFileList Get a list of locally cached files saved by this Mini-Program 1.0.0
ft.getSavedFileInfo Get file information for a local file 1.0.0
ft.getFileSystemManager Get the globally unique file manager 1.0.0
ft.getFileInfo Get file information 1.0.0
ft.saveFileToDisk Save a file system file to the user's disk (supported only on PC) 1.0.0

# FileSystemManager

Name Function Description Version Remarks
FileSystemManager.accessSync Check if a file/directory exists 1.0.0
FileSystemManager.access Check if a file/directory exists 1.0.0
FileSystemManager.appendFile Append content to the end of a file 1.0.0
FileSystemManager.appendFileSync Synchronous version of FileSystemManager.appendFile 1.0.0
FileSystemManager.close Close a file 1.0.0
FileSystemManager.closeSync Synchronously close a file 1.0.0
FileSystemManager.copyFile Copy a file 1.0.0
FileSystemManager.copyFileSync Synchronous version of FileSystemManager.copyFile 1.0.0
FileSystemManager.getFileInfo Get information about a local temporary file or locally cached file within this Mini-Program 1.0.0
FileSystemManager.getSavedFileList Get a list of locally cached files saved by this Mini-Program 1.0.0
FileSystemManager.mkdir Create a directory 1.0.0
FileSystemManager.mkdirSync Synchronous version of FileSystemManager.mkdir 1.0.0
FileSystemManager.readdir Read the list of files in a directory 1.0.0
FileSystemManager.readdirSync Synchronous version of FileSystemManager.readdir 1.0.0
FileSystemManager.readFile Read the contents of a local file 1.0.0
FileSystemManager.readFileSync Synchronous version of FileSystemManager.readFile 1.0.0
FileSystemManager.removeSavedFile Delete a locally cached file saved by this Mini-Program 1.0.0
FileSystemManager.rename Rename a file 1.0.0
FileSystemManager.renameSync Synchronous version of FileSystemManager.rename 1.0.0
FileSystemManager.rmdir Delete a directory 1.0.0
FileSystemManager.rmdirSync Synchronous version of FileSystemManager.rmdir 1.0.0
FileSystemManager.saveFile Save a temporary file locally 1.0.0
FileSystemManager.saveFileSync Synchronous version of FileSystemManager.saveFile 1.0.0
FileSystemManager.stat Get a Stats object for a file 1.0.0
FileSystemManager.statSync Synchronous version of FileSystemManager.stat 1.0.0
FileSystemManager.unlink Delete a file 1.0.0
FileSystemManager.unlinkSync Synchronous version of FileSystemManager.unlink 1.0.0
FileSystemManager.unzip Unzip a file 1.0.0
FileSystemManager.writeFile Write to a file 1.0.0
FileSystemManager.writeFileSync Synchronous version of FileSystemManager.writeFile 1.0.0
FileSystemManager.write Write to a file 1.0.0
FileSystemManager.writeSync Synchronous version of FileSystemManager.write 1.0.0
FileSystemManager.fstat Get file status information 1.0.0
FileSystemManager.fstatSync Synchronously get file status information 1.0.0
FileSystemManager.ftruncate Truncate file content 1.0.0
FileSystemManager.ftruncateSync Truncate file content 1.0.0
FileSystemManager.open Open a file, returning a file descriptor 1.0.0
FileSystemManager.openSync Synchronously open a file, returning a file descriptor 1.0.0
FileSystemManager.read Read a file 1.0.0
FileSystemManager.readSync Read a file 1.0.0
FileSystemManager.readZipEntry Read a file inside a compressed archive 1.0.0
FileSystemManager.truncate Truncate file content 1.0.0
FileSystemManager.truncateSync Truncate file content (synchronous version of truncate) 1.0.0
FileSystemManager.readCompressedFile Synchronously read the contents of a local file with a specified compression type 3.3.7 Supported starting from SDK 2.45.1; requires adding the Extension SDK
FileSystemManager.readCompressedFileSync Synchronously read the contents of a local file with a specified compression type 3.3.7 Supported starting from SDK 2.45.1; requires adding the Extension SDK

# Open Interfaces

# User Information

Please note

The following APIs are not currently supported. You can click here to learn how to reuse WeChat login capabilities in Mini-Programs.

Name Function Description
ft.getUserProfile Get user information
ft.getUserInfo Get user information
UserInfo User information

# Login

Please note

The following APIs are not currently supported. You can click here to learn how to reuse WeChat login capabilities in Mini-Programs.

Name Function Description
ft.login Call the interface to obtain a login credential (code)
ft.checkSession Check whether the login session has expired

# Authorization

Name Function Description
ft.authorize Request authorization from the user in advance

Please note

The following APIs are not currently supported

Name Function Description
ft.authorizeForMiniProgram This interface can only be called in Mini-Game plugins, with usage similar to ft.authorize

# Account Information

Name Function Description
ft.getAccountInfoSync Get current account information

# Settings

Name Function Description Version Remarks
ft.openSetting Open the Mini-Program settings interface on the client side and return the user's operation results 1.0.0
ft.getSetting Get the user's current settings 1.0.0
AuthSetting User authorization settings information; refer to permissions for details 1.0.0

# Shipping Address

Please note

The following APIs are not currently supported

Name Function Description
ft.chooseAddress Get the user's shipping address

# Cards

Please note

The following APIs are not currently supported

Name Function Description
ft.openCard View cards in the WeChat card wallet
ft.addCard Add multiple cards in bulk

# Invoices

Please note

The following APIs are not currently supported

Name Function Description
ft.chooseInvoiceTitle Select the user's invoice title
ft.chooseInvoice Select an invoice that the user already has

# Biometric Authentication

Please note

The following APIs are not currently supported

Name Function Description
ft.startSoterAuthentication Start SOTER biometric authentication
ft.checkIsSupportSoterAuthentication Get the SOTER biometric authentication methods supported by this device
ft.checkIsSoterEnrolledInDevice Check if biometric information such as fingerprints has been registered on the device

# Fitness

Please note

The following APIs are not currently supported

Name Function Description
ft.shareToWeRun Share data to WeRun
ft.getWeRunData Get the user's step count for the past 30 days

# Subscription Messages

Note

The following APIs are not currently supported

Name Function Description
ft.requestSubscribeMessage Invoke the mini-game subscription message interface on the client side and return the result of the user's subscription operation

# WeChat Red Envelopes

Note

The following APIs are not currently supported

Name Function Description
ft.showRedPackage Pull up the H5 red envelope cover page

# Favorites

Note

The following APIs are not currently supported

Name Function Description
ft.addVideoToFavorites Favorite a video
ft.addFileToFavorites Favorite a file

# License Plates

Note

The following APIs are not currently supported

Name Function Description
ft.chooseLicensePlate Select a license plate number

# Channels (Video Accounts)

Note

The following APIs are not currently supported

Name Function Description
ft.reserveChannelsLive Reserve a live stream for a Channel
ft.openChannelsLive Open a live stream for a Channel
ft.openChannelsActivity Open a video from a Channel
ft.getChannelsLiveNoticeInfo Get the live stream announcement information for a Channel
ft.getChannelsLiveInfo Get the live stream information for a Channel

# WeChat Groups

Note

The following APIs are not currently supported

Name Function Description
ft.getGroupEnterInfo Get the mini-game launch information in the context of a WeChat group chat

# WeChat Customer Service

Note

The following APIs are not currently supported

Name Function Description
ft.openCustomerServiceChat Open WeChat customer service

# Device

# Bluetooth - General

Name Function Description
ft.stopBluetoothDevicesDiscovery Stop searching for nearby Bluetooth peripheral devices
ft.startBluetoothDevicesDiscovery Start searching for nearby Bluetooth peripheral devices
ft.openBluetoothAdapter Initialize the Bluetooth module
ft.onBluetoothDeviceFound Listen for events when new devices are discovered
ft.onBluetoothAdapterStateChange Listen for changes in the Bluetooth adapter state
ft.offBluetoothDeviceFound Cancel listening for newly discovered devices
ft.offBluetoothAdapterStateChange Cancel listening for changes in the Bluetooth adapter state
ft.makeBluetoothPair Bluetooth pairing interface, Android only
ft.getConnectedBluetoothDevices Get connected Bluetooth devices based on the primary service UUID
ft.getBluetoothDevices Get all Bluetooth devices discovered during the active period of the Bluetooth module
ft.getBluetoothAdapterState Get the status of the local Bluetooth adapter
ft.closeBluetoothAdapter Close the Bluetooth module

# Bluetooth - Low Energy Central Device

Name Function Description
ft.writeBLECharacteristicValue Write binary data to the characteristic value of a BLE device
ft.setBLEMTU Negotiate and set the Maximum Transmission Unit (MTU) for BLE
ft.readBLECharacteristicValue Read binary data from the characteristic value of a BLE device
ft.onBLEConnectionStateChange Listen for changes in the BLE connection state
ft.onBLECharacteristicValueChange Listen for changes in the characteristic value of a BLE device
ft.offBLEConnectionStateChange Cancel listening for changes in the BLE connection state
ft.offBLECharacteristicValueChange Cancel listening for changes in the characteristic value of a BLE device
ft.notifyBLECharacteristicValueChange Enable notify functionality for characteristic value changes in BLE devices, subscribing to characteristics
ft.getBLEDeviceServices Get all services of a BLE device
ft.getBLEDeviceRSSI Get the Received Signal Strength Indication (RSSI) of a BLE device
ft.getBLEDeviceCharacteristics Get all characteristics of a specific service of a BLE device
ft.createBLEConnection Connect to a BLE device
ft.closeBLEConnection Disconnect from a BLE device

# Bluetooth - Low Energy Peripheral Device

Name Function Description
ft.onBLEPeripheralConnectionStateChanged Listen for connection or disconnection events of the current peripheral device
ft.offBLEPeripheralConnectionStateChanged Cancel listening for connection or disconnection events of the current peripheral device
ft.createBLEPeripheralServer Establish a local server as a BLE peripheral device, multiple servers can be created

# Bluetooth - Beacon (Beacon)

Name Function Description
ft.stopBeaconDiscovery Stop searching for nearby Beacon devices
ft.startBeaconDiscovery Start searching for nearby Beacon devices
ft.onBeaconUpdate Listen for Beacon device update events, only one listener can be registered
ft.onBeaconServiceChange Listen for Beacon service status change events, only one listener can be registered
ft.offBeaconUpdate Cancel listening for Beacon device update events
ft.offBeaconServiceChange Cancel listening for Beacon service status change events
ft.getBeacons Get all discovered Beacon devices
BeaconInfo

# Accessibility

Note

The following API is not currently supported

Name Function Description Version Remarks
ft.checkIsOpenAccessibility Check if visual accessibility features are enabled 2.12.1

# Battery

Name Function Description Version Remarks
ft.getBatteryInfoSync Synchronous version of ft.getBatteryInfo 1.0.0
ft.getBatteryInfo Get device battery level 1.0.0

# Clipboard

Name Function Description Version Remarks
ft.setClipboardData Set the content of the system clipboard 1.0.0
ft.getClipboardData Get the content of the system clipboard 1.0.0

# Network

Name Function Description Version Remarks
ft.onNetworkStatusChange Listen for network status change events 1.0.0
ft.offNetworkStatusChange Cancel listening for network status change events; if the parameter is empty, cancel all event listeners 1.0.0
ft.getNetworkType Get the network type 1.0.0

# Screen

Name Function Description Version Remarks
ft.setScreenBrightness Set screen brightness 1.0.0
ft.setKeepScreenOn Set whether to keep the screen always on 1.0.0
ft.onUserCaptureScreen Listen for user-initiated screenshot events 1.0.0
ft.offUserCaptureScreen User-initiated screenshot event 1.0.0
ft.getScreenBrightness Get screen brightness 1.0.0

# Keyboard

Name Function Description Version Remarks
ft.showKeyboard Display the keyboard 3.0.50
ft.updateKeyboard Update input field content 3.0.50
ft.hideKeyboard After invoking showKeyboard to bring up the keyboard, manually call this interface to hide the keyboard 1.0.0
ft.onKeyboardInput Listen for keyboard input events 3.0.50
ft.onKeyboardHeightChange Listen for keyboard height changes 1.0.0
ft.onKeyboardConfirm Listen for events when the user clicks the Confirm button on the keyboard 3.0.50
ft.onKeyboardComplete Listen for events when the keyboard is dismissed 3.0.50
ft.offKeyboardInput Cancel listening for keyboard input events 3.0.50
ft.offKeyboardHeightChange Cancel listening for keyboard height change events 1.0.0
ft.offKeyboardConfirm Cancel listening for events when the user clicks the Confirm button on the keyboard 3.0.50
ft.offKeyboardComplete Cancel listening for events when the keyboard is dismissed 3.0.50

# Accelerometer

Name Function Description Version Remarks
ft.stopAccelerometer Stop listening for accelerometer data 1.0.0
ft.startAccelerometer Start listening for accelerometer data 1.0.0
ft.onAccelerometerChange Listen for accelerometer data events 1.0.0
ft.offAccelerometerChange Cancel listening for accelerometer data events; if the parameter is empty, cancel all event listeners 1.0.0

# Compass

Name Function Description Version Remarks
ft.stopCompass Stop listening for compass data 1.0.0
ft.startCompass Start listening for compass data 1.0.0
ft.onCompassChange Listen for compass data change events 1.0.0
ft.offCompassChange Cancel listening for compass data change events; if the parameter is empty, cancel all event listeners 1.0.0

# Device Orientation

Name Function Description Version Remarks
ft.stopDeviceMotionListening Stop listening for changes in device orientation 1.0.0
ft.startDeviceMotionListening Start listening for changes in device orientation 1.0.0
ft.onDeviceMotionChange Listen for device orientation change events 1.0.0
ft.offDeviceMotionChange Cancel listening for device orientation change events; if the parameter is empty, cancel all event listeners 1.0.0

# Screen Rotation

Name Function Description Version Remarks
ft.setDeviceOrientation Switch between portrait and landscape modes 3.0.50
ft.onDeviceOrientationChange Listen for screen rotation switch events 3.0.50
ft.offDeviceOrientationChange Cancel listening for screen rotation switch events 3.0.50

# Gyroscope

Name Function Description Version Remarks
ft.stopGyroscope Stop listening for gyroscope data 1.0.0
ft.startGyroscope Start listening for gyroscope data 1.0.0
ft.onGyroscopeChange Listen for gyroscope data change events 1.0.0
ft.offGyroscopeChange Cancel listening for gyroscope data change events 1.0.0

# Memory

Note

The following APIs are not currently supported

Name Function Description
ft.onMemoryWarning Listen for memory warning events
ft.offMemoryWarning Cancel listening for memory warning events

# QR Code Scanning

Name Function Description Version Remarks
ft.scanCode Invoke the client-side QR code scanning interface to scan codes 1.0.0

# Vibration

Name Function Description Version Remarks
ft.vibrateShort Make the phone vibrate for a short duration (15 ms) 1.0.0
ft.vibrateLong Make the phone vibrate for a longer duration (400 ms) 1.0.0

# AI/Facial Recognition

Note

The following APIs are not currently supported

Name Function Description
ft.stopFaceDetect Stop facial recognition
ft.initFaceDetect Initialize facial recognition
ft.faceDetect Perform facial recognition; initialization via ft.initFaceDetect is required before use; it is recommended to use frame data returned by the camera interface

# Worker

Note

The following APIs are not currently supported

Name Function Description
ft.createWorker Create a Worker thread

# Other

Name Function Description
ft.onCustomEvent Listen for native dispatched onCustomEvent events
ft.offCustomEvent Cancel listening for native dispatched onCustomEvent events
ft.addCustomEventListener Listen for native dispatched events
ft.removeCustomEventListener Cancel listening for native dispatched events
© FinClip with ❤ , Since 2017