# API汇总
下列api的调用中，我们能够自动兼容前缀为 wx 和 mt 的接口，在打包过程中会对wx开头的api进行调用替换，无需手工处理。
# 基础
| 分类 | API | 实例 API | 说明 | Android | iOS |
|---|---|---|---|---|---|
| 系统信息 | mt.getSystemInfoSync | 同步获得系统信息 | 支持 | 支持 | |
| mt.getSystemInfo | 获得系统信息 | 支持 | 支持 | ||
| 更新 | mt.getUpdateManager | 获得更新管理器 | 支持 | 支持 | |
| UpdateManager.applyUpdate | 触发强制小游戏更新 | 支持 | 支持 | ||
| UpdateManager.onCheckForUpdate | 检查更新 | 支持 | 支持 | ||
| UpdateManager.onUpdateFailed | 监听更新失败 | 支持 | 支持 | ||
| UpdateManager.onUpdateReady | 监听更新完成 | 支持 | 支持 | ||
| 生命周期 | mt.onShow | 监听小游戏切前台 | 支持 | 支持 | |
| mt.onHide | 监听小游戏切后台 | 支持 | 支持 | ||
| mt.offShow | 取消监听小游戏切前台 | 支持 | 支持 | ||
| mt.offHide | 取消监听小游戏切后台 | 支持 | 支持 | ||
| mt.getLaunchOptionsSync | 获得小游戏运行参数 | 支持 | 支持 | ||
| mt.exitMiniProgram | 退出小游戏 | 支持 | 支持 | ||
| 全局事件 | mt.onUnhandledRejection | 监听未处理的 Promise 拒绝事件 | 支持 | 不支持 | |
| mt.offUnhandledRejection | 取消监听未处理 Promise 拒绝事件 | 支持 | 不支持 | ||
| mt.onError | 监听全局错误事件 | 支持 | 支持 | ||
| mt.offError | 取消监听全局错误事件 | 支持 | 支持 | ||
| mt.onAudioInterruptionBegin | 监听音频播放开始被打断事件 | 不支持 | 不支持 | ||
| mt.offAudioInterruptionBegin | 取消监听以上事件 | 不支持 | 不支持 | ||
| mt.onAudioInterruptionEnd | 监听音频播放结束被打断事件 | 不支持 | 不支持 | ||
| mt.offAudioInterruptionEnd | 取消监听以上事件 | 不支持 | 不支持 | ||
| 触摸事件 | mt.onTouchStart | 监听触摸开始 | 支持 | 支持 | |
| mt.offTouchStart | 取消监听触摸开始 | 支持 | 支持 | ||
| mt.onTouchMove | 监听触摸移动 | 支持 | 支持 | ||
| mt.offTouchMove | 取消监听触摸移动 | 支持 | 支持 | ||
| mt.onTouchEnd | 监听触摸结束 | 支持 | 支持 | ||
| mt.offTouchEnd | 取消监听触摸结束 | 支持 | 支持 | ||
| mt.onTouchCancel | 监听触摸取消 | 支持 | 支持 | ||
| mt.offTouchCancel | 取消监听触摸取消 | 支持 | 支持 | ||
| 键盘事件 | -- | 不支持 | 不支持 | ||
| 鼠标事件 | -- | 不支持 | 不支持 | ||
| 滚动事件 | -- | 不支持 | 不支持 | ||
| 性能 | mt.triggerGC | 触发垃圾回收 | 支持 | 支持 | |
| mt.reportPerformance | 测速上报 | 支持 | 支持 | ||
| mt.markScene | 标记自定义场景 | 不支持 | 不支持 | ||
| mt.getPerformance | 获得性能管理器 | 不支持 | 不支持 | ||
| 分包加载 | mt.loadSubpackage | 加载分包 | 支持 | 支持 | |
| LoadSubpackageTask.onProgressUpdate | 监听分包加载进度 | 支持 | 支持 | ||
| 调试 | mt.setEnableDebug | 是否打开调试开关 | 不支持 | 不支持 | |
| mt.getLogManager | 获取日志管理器 | 不支持 | 不支持 | ||
| LogManager.debug | 写 debug 日志 | 不支持 | 不支持 | ||
| LogManager.info | 写 info 日志 | 不支持 | 不支持 | ||
| LogManager.log | 写 log 日志 | 不支持 | 不支持 | ||
| LogManager.warn | 写 warn 日志 | 不支持 | 不支持 | ||
| console.warn | 调试面板打印 warn 日志 | 支持 | 支持 | ||
| console.log | 调试面板打印 log 日志 | 支持 | 支持 | ||
| console.info | 调试面板打印 info 日志 | 支持 | 支持 | ||
| console.error | 调试面板打印 error 日志 | 支持 | 支持 | ||
| console.debug | 调试面板打印 debug 日志 | 支持 | 支持 | ||
| console.group | 调试面板打印分组 | 支持 | 支持 | ||
| console.groupEnd | 调试面板结束打印分组 | 支持 | 支持 | ||
| 定时器 | setTimeout | 延迟执行 | 支持 | 支持 | |
| clearTimeout | 取消延迟执行 | 支持 | 支持 | ||
| setInterval | 循环执行 | 支持 | 支持 | ||
| clearInterval | 取消循环执行 | 支持 | 支持 |
# 渲染
| 分类 | API | 实例 API | 说明 | Android | iOS |
|---|---|---|---|---|---|
| 画布 | mt.createCanvas | 创建画布 | 支持 | 支持 | |
| Canvas.getContext | 获得画布渲染上下文 （ 渲染接口见附录 ） | 支持 | 支持 | ||
| Canvas.toDataURL | Canvas 转 Data URL 格式 | 支持 | 支持 | ||
| Canvas.toTempFilePath | Canvas 转临时文件 | 支持 | 支持 | ||
| Canvas.toTempFilePathSync | Canvas 转临时文件 ( 同步方法 ) | 支持 | 支持 | ||
| 帧率 | requestAnimationFrame | 在下次进行重绘时执行 | 支持 | 支持 | |
| cancelAnimationFrame | 取消由以上 API 添加到计划中的动画帧请求 | 支持 | 支持 | ||
| mt.setPreferredFramesPerSecond | 修改渲染帧率 | 不支持 | 不支持 | ||
| 字体 | mt.loadFont | 加载自定义字体文件 | 不支持 | 不支持 | |
| mt.getTextLineHeight | 获取一行文本的行高 | 不支持 | 不支持 | ||
| 图片 | mt.createImage | 创建图片对象 | 支持 | 支持 | |
| Image.src | 图片对象 URL | 支持 | 支持 | ||
| Image.width | 图片对象宽 | 支持 | 支持 | ||
| Image.height | 图片对象高 | 支持 | 支持 | ||
| Image.onload | 监听图片对象加载完成事件 | 支持 | 支持 | ||
| Image.onerror | 监听图片对象加载错误事件 | 支持 | 支持 |
# 界面
| 分类 | API | 实例 API | 说明 | Android | iOS |
|---|---|---|---|---|---|
| 交互 | mt.showToast | 显示消息提示框 | 支持 | 支持 | |
| mt.showModal | 显示模态对话框 | 支持 | 支持 | ||
| mt.showLoading | 显示 loading 提示框。需主动调用 mt.hideLoading 才能关闭提示框 | 支持 | 支持 | ||
| mt.showActionSheet | 显示操作菜单 | 支持 | 支持 | ||
| mt.hideToast | 隐藏消息提示框 | 支持 | 支持 | ||
| mt.hideLoading | 隐藏 loading 提示框 | 支持 | 支持 | ||
| 键盘 | mt.updateKeyboard | 更新键盘输入框内容。只有当键盘处于拉起状态时才会产生效果 | 支持 | 支持 | |
| mt.showKeyboard | 显示键盘 | 支持 | 支持 | ||
| mt.onKeyboardInput | 监听键盘输入事件 | 支持 | 支持 | ||
| mt.onKeyboardConfirm | 监听用户点击键盘 Confirm 按钮时的事件 | 支持 | 支持 | ||
| mt.onKeyboardComplete | 监听监听键盘收起的事件 | 支持 | 支持 | ||
| mt.offKeyboardInput | 取消监听键盘输入事件 | 支持 | 支持 | ||
| mt.offKeyboardConfirm | 取消监听用户点击键盘 Confirm 按钮时的事件 | 支持 | 支持 | ||
| mt.offKeyboardComplete | 取消监听监听键盘收起的事件 | 支持 | 支持 | ||
| mt.hideKeyboard | 隐藏键盘 | 支持 | 支持 | ||
| mt.onKeyboardHeightChange | 监听键盘高度变化 | 支持 | 支持 | ||
| 菜单 | mt.setMenuStyle | 动态设置通过右上角按钮拉起的菜单的样式。 | 不支持 | 不支持 | |
| mt.getMenuButtonBoundingClientRect | 取消由以上 API 添加到计划中的动画帧请求 | 支持 | 支持 | ||
| 状态栏 | mt.setStatusBarStyle | 当在配置中设置 showStatusBarStyle 时，屏幕顶部会显示状态栏。此接口可以修改状态栏的样式。 | 不支持 | 不支持 | |
| 窗口 | mt.setWindowSize | 设置窗口大小，该接口仅适用于 PC 平台 | 不支持 | 不支持 | |
| mt.onWindowResize | 监听窗口尺寸变化事件 | 不支持 | 不支持 | ||
| mt.offWindowResize | 取消监听窗口尺寸变化事件 | 不支持 | 不支持 |
# 网络
| 分类 | API | 实例 API | 说明 | Android | iOS |
|---|---|---|---|---|---|
| 发起请求 | mt.request | 发起 HTTPS 网络请求 | 支持 | 支持 | |
| RequestTask.abort | 中断请求任务 | 支持 | 支持 | ||
| RequestTask.onHeadersReceived | 监听 HTTP Response Header 事件 | 支持 | 支持 | ||
| RequestTask.offHeadersReceived | 取消监听 HTTP Response Header 事件 | 支持 | 支持 | ||
| 下载 | mt.downloadFile | 下载文件资源到本地 | 支持 | 支持 | |
| DownloadTask.abort | 中断下载任务 | 支持 | 支持 | ||
| DownloadTask.onProgressUpdate | 监听下载进度变化事件 | 支持 | 支持 | ||
| DownloadTask.offProgressUpdate | 取消监听下载进度变化事件 | 支持 | 支持 | ||
| DownloadTask.onHeadersReceived | 监听 HTTP Response Header 事件 | 支持 | 支持 | ||
| DownloadTask.offHeadersReceived | 取消监听 HTTP Response Header 事件 | 支持 | 支持 | ||
| 上传 | mt.uploadFile | 将本地资源上传到服务器 | 不支持 | 不支持 | |
| UploadTask.abort | 中断上传任务 | 不支持 | 不支持 | ||
| UploadTask.onProgressUpdate | 监听上传进度变化事件 | 不支持 | 不支持 | ||
| UploadTask.offProgressUpdate | 取消监听上传进度变化事件 | 不支持 | 不支持 | ||
| UploadTask.onHeadersReceived | 监听 HTTP Response Header 事件 | 不支持 | 不支持 | ||
| UploadTask.offHeadersReceived | 取消监听 HTTP Response Header 事件 | 不支持 | 不支持 | ||
| WebSocket | mt.connectSocket | 创建一个 WebSocket 连接 | 支持 | 支持 | |
| SocketTask.send | 通过 WebSocket 连接发送数据 | 支持 | 支持 | ||
| SocketTask.close | 关闭 WebSocket 连接 | 支持 | 支持 | ||
| SocketTask.onOpen | 监听 WebSocket 连接打开事件 | 支持 | 支持 | ||
| SocketTask.onClose | 监听 WebSocket 连接关闭事件 | 支持 | 支持 | ||
| SocketTask.onError | 监听 WebSocket 错误事件 | 支持 | 支持 | ||
| SocketTask.onMessage | 监听 WebSocket 接受到服务器的消息事件 | 支持 | 支持 | ||
| mt.sendSocketMessage | 通过 WebSocket 连接发送数据 | 支持 | 支持 | ||
| mt.onSocketOpen | 监听 WebSocket 连接打开事件 | 支持 | 支持 | ||
| mt.onSocketMessage | 监听 WebSocket 接受到服务器的消息事件 | 支持 | 支持 | ||
| mt.onSocketError | 监听 WebSocket 错误事件 | 支持 | 支持 | ||
| mt.onSocketClose | 监听 WebSocket 连接关闭事件 | 支持 | 支持 | ||
| mt.closeSocket | 关闭 WebSocket 连接 | 支持 | 支持 | ||
| UDP 通信 | mt.createUDPSocket | 创建一个 UDP Socket 实例 | 支持 | 支持 | |
| UDPSocket.bind | 绑定一个制定的或系统随机分配的可用端口号 | 支持 | 支持 | ||
| UDPSocket.send | 向指定的 IP 和 port 发送消息 | 支持 | 支持 | ||
| UDPSocket.close | 关闭 UDP Socket 实例，相当于销毁 | 支持 | 支持 | ||
| UDPSocket.onClose | 监听关闭事件 | 支持 | 支持 | ||
| UDPSocket.offClose | 取消监听关闭事件 | 支持 | 支持 | ||
| UDPSocket.onError | 监听错误事件 | 支持 | 支持 | ||
| UDPSocket.offError | 取消监听错误事件 | 支持 | 支持 | ||
| UDPSocket.onListening | 监听开始监听数据包消息的事件 | 支持 | 支持 | ||
| UDPSocket.offListening | 取消监听开始监听数据包消息的事件 | 支持 | 支持 | ||
| UDPSocket.onMessage | 监听收到消息的事件 | 支持 | 支持 | ||
| UDPSocket.offMessage | 取消监听收到消息的事件 | 支持 | 支持 |
# 转发
| 分类 | API | 实例 API | 说明 | Android | iOS |
|---|---|---|---|---|---|
| 转发 | mt.updateShareMenu | 更新转发属性 | 不支持 | 不支持 | |
| mt.showShareMenu | 显示当前页面的转发按钮 | 支持 | 支持 | ||
| mt.hideShareMenu | 隐藏当前页面的转发按钮 | 支持 | 支持 | ||
| mt.shareAppMessage | 主动拉起转发，进入选择通讯录界面 | 支持 | 支持 | ||
| mt.setMessageToFriendQuery | 设置 mt.shareMessageToFriend 接口 query 字段的值 | 不支持 | 不支持 | ||
| mt.onShareMessageToFriend | 监听主域接收 mt.shareMessageToFriend 接口的成功失败通知 | 不支持 | 不支持 | ||
| mt.onShareAppMessage | 监听用户点击右上角菜单的「转发」按钮时触发的事件 | 支持 | 支持 | ||
| mt.offShareAppMessage | 取消监听用户点击右上角菜单的「转发」按钮时触发的事件 | 支持 | 支持 | ||
| mt.onAddToFavorites | 监听用户点击菜单「收藏」按钮时触发的事件 | 不支持 | 不支持 | ||
| mt.getShareInfo | 获取转发详细信息 | 不支持 | 不支持 |
# 数据缓存
| 分类 | API | 实例 API | 说明 | Android | iOS |
|---|---|---|---|---|---|
| 数据缓存 | mt.setStorageSync | 将数据存储在本地缓存中指定的 key 中 同步版本 | 支持 | 支持 | |
| mt.setStorage | 将数据存储在本地缓存中指定的 key 中 | 支持 | 支持 | ||
| mt.removeStorageSync | 从本地缓存中移除指定 key 同步版本 | 支持 | 支持 | ||
| mt.removeStorage | 从本地缓存中移除指定 key | 支持 | 支持 | ||
| mt.getStorageInfoSync | 获取当前storage的相关信息 同步版本 | 支持 | 支持 | ||
| mt.getStorageInfo | 异步获取当前storage的相关信息 | 支持 | 支持 | ||
| mt.getStorageSync | 从本地缓存中异步获取指定 key 的内容 同步版本 | 支持 | 支持 | ||
| mt.getStorage | 从本地缓存中异步获取指定 key 的内容 | 支持 | 支持 | ||
| mt.clearStorageSync | 清理本地数据缓存 同步版本 | 支持 | 支持 | ||
| mt.clearStorage | 清理本地数据缓存 | 支持 | 支持 |
# 媒体
| 分类 | API | 实例 API | 说明 | Android | iOS |
|---|---|---|---|---|---|
| 音频 | mt.setInnerAudioOption | 设置 InnerAudioContext 的播放选项 | 支持 | 支持 | |
| mt.getAvailableAudioSources | 获取当前支持的音频输入源 | 不支持 | 不支持 | ||
| mt.createInnerAudioContext | 创建内部 audio 上下文 InnerAudioContext 对象 | 支持 | 支持 | ||
| src | 音频资源 | 支持 | 支持 | ||
| startTime | 开始播放的时间 | 支持 | 支持 | ||
| autoplay | 是否自动播放 | 支持 | 支持 | ||
| loop | 是否循环播放 | 支持 | 支持 | ||
| obeyMuteSwitch | 微信废弃接口 | 支持 | 支持 | ||
| volume | 音量 | 支持 | 支持 | ||
| playbackRate | 播放速度 | 不支持 | 支持 | ||
| duration | 当前音频的长度 | 支持 | 支持 | ||
| currentTime | 当前音频的播放位置 | 支持 | 支持 | ||
| paused | 是否暂停状态 | 支持 | 支持 | ||
| buffered | 音频缓存的时间点 | 支持 | 支持 | ||
| InnerAudioContext.play | 播放 | 支持 | 支持 | ||
| InnerAudioContext.pause | 暂停 | 支持 | 支持 | ||
| InnerAudioContext.stop | 停止 | 支持 | 支持 | ||
| InnerAudioContext.seek | 跳到指定位置 | 支持 | 支持 | ||
| InnerAudioContext.destroy | 销毁当前实例 | 支持 | 支持 | ||
| InnerAudioContext.onCanplay | 监听音频进入可以播放状态的事件 | 支持 | 支持 | ||
| InnerAudioContext.offCanplay | 取消监听音频进入可以播放状态的事件 | 支持 | 支持 | ||
| InnerAudioContext.onPlay | 监听音频播放事件 | 支持 | 支持 | ||
| InnerAudioContext.offPlay | 取消监听音频播放事件 | 支持 | 支持 | ||
| InnerAudioContext.onPause | 监听音频暂停事件 | 支持 | 支持 | ||
| InnerAudioContext.offPause | 取消监听音频暂停事件 | 支持 | 支持 | ||
| InnerAudioContext.onStop | 监听音频停止事件 | 支持 | 支持 | ||
| InnerAudioContext.offStop | 取消监听音频停止事件 | 支持 | 支持 | ||
| InnerAudioContext.onEnded | 监听音频自然播放至结束的事件 | 支持 | 支持 | ||
| InnerAudioContext.offEnded | 取消监听音频自然播放至结束的事件 | 支持 | 支持 | ||
| InnerAudioContext.onTimeUpdate | 监听音频播放进度更新事件 | 不支持 | 支持 | ||
| InnerAudioContext.offTimeUpdate | 取消监听音频播放进度更新事件 | 不支持 | 支持 | ||
| InnerAudioContext.onError | 监听音频播放错误事件 | 支持 | 支持 | ||
| InnerAudioContext.offError | 取消监听音频播放错误事件 | 支持 | 支持 | ||
| InnerAudioContext.onWaiting | 监听音频加载中事件 | 支持 | 支持 | ||
| InnerAudioContext.offWaiting | 取消监听音频加载中事件 | 支持 | 支持 | ||
| InnerAudioContext.onSeeking | 监听音频进行跳转操作的事件 | 支持 | 支持 | ||
| InnerAudioContext.offSeeking | 取消监听音频进行跳转操作的事件 | 支持 | 支持 | ||
| InnerAudioContext.onSeeked | 监听音频完成跳转操作的事件 | 支持 | 支持 | ||
| InnerAudioContext.offSeeked | 取消监听音频完成跳转操作的事件 | 支持 | 支持 | ||
| 图片 | mt.saveImageToPhotosAlbum | 保存图片到系统相册 | 支持 | 支持 | |
| mt.previewImage | 在新页面中全屏预览图片 | 支持 | 支持 | ||
| mt.chooseImage | 从本地相册选择图片或使用相机拍照 | 支持 | 支持 | ||
| 录音 | mt.getRecorderManager | 获取全局唯一的录音管理器 | 不支持 | 不支持 | |
| RecorderManager.start | 开始录音 | 不支持 | 不支持 | ||
| RecorderManager.pause | 暂停录音 | 不支持 | 不支持 | ||
| RecorderManager.resume | 继续录音 | 不支持 | 不支持 | ||
| RecorderManager.stop | 停止录音 | 不支持 | 不支持 | ||
| RecorderManager.onStart | 监听录音开始事件 | 不支持 | 不支持 | ||
| RecorderManager.onResume | 监听录音继续事件 | 不支持 | 不支持 | ||
| RecorderManager.onPause | 监听录音暂停事件 | 不支持 | 不支持 | ||
| RecorderManager.onStop | 监听录音结束事件 | 不支持 | 不支持 | ||
| RecorderManager.onFrameRecorded | 监听已录制完指定帧大小的文件事件 | 不支持 | 不支持 | ||
| RecorderManager.onError | 监听录音错误事件 | 不支持 | 不支持 | ||
| RecorderManager.onInterruptionBegin | 监听录音因为受到系统占用而被中断开始事件 | 不支持 | 不支持 | ||
| RecorderManager.onInterruptionEnd | 监听录音中断结束事件 | 不支持 | 不支持 | ||
| 视频 | mt.createVideo | 创建视频 | 支持 | 支持 | |
| Video.destroy | 销毁视频 | 支持 | 支持 | ||
| Video.play | 播放视频 | 支持 | 支持 | ||
| Video.pause | 暂停视频 | 支持 | 支持 | ||
| Video.stop | 停止视频 | 支持 | 支持 | ||
| Video.seek | 视频跳转 | 支持 | 支持 | ||
| Video.requestFullScreen | 视频全屏 | 不支持 | 不支持 | ||
| Video.exitFullScreen | 视频退出全屏 | 不支持 | 不支持 | ||
| Video.onWaiting | 监听视频由于需要缓冲下一帧而停止时触发 | 不支持 | 不支持 | ||
| Video.offWaiting | 取消监听视频由于需要缓冲下一帧而停止时触发 | 不支持 | 不支持 | ||
| Video.onProgress | 监听视频下载（缓冲）事件 | 不支持 | 不支持 | ||
| Video.offProgress | 取消监听视频下载（缓冲）事件 | 不支持 | 不支持 | ||
| Video.onPlay | 监听视频播放事件 | 不支持 | 不支持 | ||
| Video.offPlay | 取消监听视频播放事件 | 不支持 | 不支持 | ||
| Video.onPause | 监听视频暂停事件 | 不支持 | 不支持 | ||
| Video.offPause | 取消监听视频暂停事件 | 不支持 | 不支持 | ||
| Video.onEnded | 监听视频播放到末尾事件 | 不支持 | 不支持 | ||
| Video.offEnded | 取消监听视频播放到末尾事件 | 不支持 | 不支持 | ||
| Video.onTimeUpdate | 监听视频播放进度更新事件 | 不支持 | 不支持 | ||
| Video.offTimeUpdate | 取消监听视频播放进度更新事件 | 不支持 | 不支持 | ||
| Video.onError | 监听视频错误事件 | 不支持 | 不支持 | ||
| Video.offError | 取消监听视频错误事件 | 不支持 | 不支持 | ||
| 相机 | mt.createCamera | 创建相机 | 不支持 | 不支持 | |
| Camera.takePhoto | 拍照，可指定质量，成功则返回图片 | 不支持 | 不支持 | ||
| Camera.startRecord | 开始录像 | 不支持 | 不支持 | ||
| Camera.stopRecord | 结束录像，成功则返回封面与视频 | 不支持 | 不支持 | ||
| Camera.onAuthCancel | 监听用户不允许授权使用摄像头的情况 | 不支持 | 不支持 | ||
| Camera.onStop | 监听摄像头非正常终止事件，如退出后台等情况 | 不支持 | 不支持 | ||
| Camera.onCameraFrame | 监听摄像头实时帧数据 | 不支持 | 不支持 | ||
| Camera.listenFrameChange | 开启监听帧数据 | 不支持 | 不支持 | ||
| Camera.closeFrameChange | 关闭监听帧数据 | 不支持 | 不支持 | ||
| Camera.destroy | 销毁相机 | 不支持 | 不支持 | ||
| 视频解码器 | mt.createVideoDecoder | 创建视频解码器，可逐帧获取解码后的数据 | 不支持 | 不支持 | |
| VideoDecoder.start | 开始解码 | 不支持 | 不支持 | ||
| VideoDecoder.seek | 跳到某个时间点解码 | 不支持 | 不支持 | ||
| VideoDecoder.stop | 停止解码 | 不支持 | 不支持 | ||
| VideoDecoder.remove | 移除解码器 | 不支持 | 不支持 | ||
| VideoDecoder.getFrameData | 获取下一帧的解码数据 | 不支持 | 不支持 | ||
| VideoDecoder.on | 注册监听录制事件的回调函数 | 不支持 | 不支持 | ||
| VideoDecoder.off | 取消监听录制事件 | 不支持 | 不支持 | ||
| 实时语音 | mt.updateVoIPChatMuteConfig | 更新实时语音静音设置 | 不支持 | 不支持 | |
| mt.onVoIPChatSpeakersChanged | 监听实时语音通话成员通话状态变化事件 | 不支持 | 不支持 | ||
| mt.onVoIPChatMembersChanged | 监听实时语音通话成员在线状态变化事件 | 不支持 | 不支持 | ||
| mt.onVoIPChatInterrupted | 监听被动断开实时语音通话事件 | 不支持 | 不支持 | ||
| mt.offVoIPChatSpeakersChanged | 取消监听实时语音通话成员通话状态变化事件 | 不支持 | 不支持 | ||
| mt.offVoIPChatMembersChanged | 取消监听实时语音通话成员在线状态变化事件 | 不支持 | 不支持 | ||
| mt.offVoIPChatInterrupted | 取消监听被动断开实时语音通话事件 | 不支持 | 不支持 | ||
| mt.joinVoIPChat | 加入 (创建) 实时语音通话 | 不支持 | 不支持 | ||
| mt.exitVoIPChat | 退出（销毁）实时语音通话 | 不支持 | 不支持 |
# 位置
| 分类 | API | 实例 API | 说明 | Android | iOS |
|---|---|---|---|---|---|
| 位置 | mt.getLocation | 获取当前的地理位置、速度 | 支持 | 支持 |
# 文件
| 分类 | API | 实例 API | 说明 | Android | iOS |
|---|---|---|---|---|---|
| 文件 | mt.getFileSystemManager | 获取全局唯一的文件管理器 | 支持 | 支持 | |
| FileSystemManager.access | 判断文件/目录是否存在 | 支持 | 支持 | ||
| FileSystemManager.accessSync | 判断文件/目录是否存在 同步版本 | 支持 | 支持 | ||
| FileSystemManager.appendFile | 在文件结尾追加内容 | 支持 | 支持 | ||
| FileSystemManager.appendFileSync | 在文件结尾追加内容 同步版本 | 支持 | 支持 | ||
| FileSystemManager.copyFile | 复制文件 | 支持 | 支持 | ||
| FileSystemManager.copyFileSync | 复制文件 同步版本 | 支持 | 支持 | ||
| FileSystemManager.getFileInfo | 获取该小游戏下的 本地临时文件 或 本地缓存文件 信息 | 支持 | 支持 | ||
| FileSystemManager.getSavedFileList | 获取该小游戏下已保存的本地缓存文件列表 | 支持 | 支持 | ||
| FileSystemManager.mkdir | 创建目录 | 支持 | 支持 | ||
| FileSystemManager.mkdirSync | 创建目录 同步版本 | 支持 | 支持 | ||
| FileSystemManager.readdir | 读取目录内文件列表 | 支持 | 支持 | ||
| FileSystemManager.readdirSync | 读取目录内文件列表 同步版本 | 支持 | 支持 | ||
| FileSystemManager.readFile | 读取本地文件内容 | 支持 | 支持 | ||
| FileSystemManager.readFileSync | 读取本地文件内容 同步版本 | 支持 | 支持 | ||
| FileSystemManager.removeSavedFile | 删除该小程序下已保存的本地缓存文件 | 支持 | 支持 | ||
| FileSystemManager.rename | 重命名文件 | 支持 | 支持 | ||
| FileSystemManager.renameSync | 重命名文件 同步版本 | 支持 | 支持 | ||
| FileSystemManager.rmdir | 删除目录 | 支持 | 支持 | ||
| FileSystemManager.rmdirSync | 删除目录 同步版本 | 支持 | 支持 | ||
| FileSystemManager.saveFile | 保存临时文件到本地 | 支持 | 支持 | ||
| FileSystemManager.saveFileSync | 保存临时文件到本地 同步版本 | 支持 | 支持 | ||
| FileSystemManager.unlink | 删除文件 | 支持 | 支持 | ||
| FileSystemManager.unlinkSync | 删除文件 同步版本 | 支持 | 支持 | ||
| FileSystemManager.unzip | 解压文件 | 支持 | 支持 | ||
| FileSystemManager.writeFile | 写文件 | 支持 | 支持 | ||
| FileSystemManager.writeFileSync | 写文件 同步版本 | 支持 | 支持 | ||
| FileSystemManager.stat | 获取文件 Stats 对象 | 支持 | 支持 | ||
| FileSystemManager.statSync | 获取文件 Stats 对象 同步版本 | 支持 | 支持 | ||
| 文件 Stats 对象 | 支持 | 支持 | |||
| mode | 文件的类型和存取的权限 | 支持 | 支持 | ||
| size | 文件大小，单位：B | 支持 | 支持 | ||
| lastAccessedTime | 文件最近一次被存取或被执行的时间，UNIX 时间戳 | 支持 | 支持 | ||
| lastModifiedTime | 文件最后一次被修改的时间，UNIX 时间戳 | 支持 | 支持 | ||
| Stats.isDirectory | 判断当前文件是否一个目录 | 支持 | 支持 | ||
| Stats.isFile | 判断当前文件是否一个普通文件 | 支持 | 支持 |
# 开放接口
| 分类 | API | 实例 API | 说明 | Android | iOS |
|---|---|---|---|---|---|
| 登录 | mt.login | 调用接口获取登录凭证（code） | 支持 | 支持 | |
| mt.checkSession | 检查登录态是否过期 | 支持 | 支持 | ||
| 小程序跳转 | mt.navigateToMiniProgram | 打开另一个小程序 | 不支持 | 不支持 | |
| 用户信息 | mt.getUserInfo | 获取用户信息 | 支持 | 支持 | |
| nickName | 用户昵称 | 支持 | 支持 | ||
| avatarUrl | 用户头像图片的 URL | 支持 | 支持 | ||
| gender | 用户性别 | 支持 | 支持 | ||
| country | 用户所在国家 | 支持 | 不支持 | ||
| province | 用户所在省份 | 支持 | 不支持 | ||
| city | 用户所在城市 | 支持 | 不支持 | ||
| language | 显示 country，province，city 所用的语言 | 支持 | 不支持 | ||
| mt.createUserInfoButton | 创建用户信息按钮 | 不支持 | 不支持 | ||
| UserInfoButton.show | 显示用户信息按钮 | 不支持 | 不支持 | ||
| UserInfoButton.hide | 隐藏用户信息按钮 | 不支持 | 不支持 | ||
| UserInfoButton.destroy | 销毁用户信息按钮 | 不支持 | 不支持 | ||
| UserInfoButton.onTap | 监听用户信息按钮的点击事件 | 不支持 | 不支持 | ||
| UserInfoButton.offTap | 取消监听用户信息按钮的点击事件 | 不支持 | 不支持 | ||
| 授权 | mt.authorize | 提前向用户发起授权请求 | 不支持 | 不支持 | |
| 开放数据域 | mt.onMessage | 监听主域发送的消息 | 不支持 | 不支持 | |
| mt.getOpenDataContext | 获取开放数据域 | 不支持 | 不支持 | ||
| OpenDataContext.canvas | 开放数据域和主域共享的 sharedCanvas | 不支持 | 不支持 | ||
| OpenDataContext.postMessage | 向开放数据域发送消息 | 不支持 | 不支持 | ||
| mt.shareMessageToFriend | 给指定的好友分享游戏信息，该接口只可在开放数据域下使用 | 不支持 | 不支持 | ||
| mt.setUserCloudStorage | 对用户托管数据进行写数据操作 | 不支持 | 不支持 | ||
| mt.removeUserCloudStorage | 删除用户托管数据当中对应 key 的数据 | 不支持 | 不支持 | ||
| mt.onInteractiveStorageModified | 监听成功修改好友的互动型托管数据事件，该接口在游戏主域使用 | 不支持 | 不支持 | ||
| mt.modifyFriendInteractiveStorage | 修改好友的互动型托管数据，该接口只可在开放数据域下使用 | 不支持 | 不支持 | ||
| mt.getUserInteractiveStorage | 获取当前用户互动型托管数据对应 key 的数据 | 不支持 | 不支持 | ||
| mt.getUserCloudStorage | 获取当前用户托管数据当中对应 key 的数据 | 不支持 | 不支持 | ||
| mt.getSharedCanvas | 获取主域和开放数据域共享的 sharedCanvas | 不支持 | 不支持 | ||
| mt.getPotentialFriendList | 获取可能对游戏感兴趣的未注册的好友名单 | 不支持 | 不支持 | ||
| mt.getGroupInfo | 获取群信息 | 不支持 | 不支持 | ||
| mt.getGroupCloudStorage | 获取群同玩成员的游戏数据 | 不支持 | 不支持 | ||
| mt.getFriendCloudStorage | 拉取当前用户所有同玩好友的托管数据 | 不支持 | 不支持 | ||
| 防沉迷 | mt.checkIsUserAdvisedToRest | 根据用户当天游戏时间判断用户是否需要休息 | 不支持 | 不支持 | |
| 意见反馈 | mt.createFeedbackButton | 创建打开意见反馈页面的按钮 | 不支持 | 不支持 | |
| 设置 | mt.openSetting | 调起客户端小程序设置界面，返回用户设置的操作结果 | 不支持 | 不支持 | |
| mt.getSetting | 获取用户的当前设置 | 不支持 | 不支持 | ||
| 用户授权设置信息 | 不支持 | 不支持 | |||
| scope.userInfo | 是否授权用户信息，对应接口 mt.getUserInfo | 不支持 | 不支持 | ||
| scope.userLocation | 是否授权地理位置，对应接口 mt.getLocation, mt.chooseLocation | 不支持 | 不支持 | ||
| scope.address | 是否授权通讯地址，对应接口 mt.chooseAddress | 不支持 | 不支持 | ||
| scope.invoiceTitle | 是否授权发票抬头，对应接口 mt.chooseInvoiceTitle | 不支持 | 不支持 | ||
| scope.invoice | 是否授权获取发票，对应接口 mt.chooseInvoice | 不支持 | 不支持 | ||
| scope.werun | 是否授权微信运动步数，对应接口 mt.getWeRunData | 不支持 | 不支持 | ||
| scope.record | 是否授权录音功能，对应接口 mt.startRecord | 不支持 | 不支持 | ||
| scope.writePhotosAlbum | 是否授权保存到相册 mt.saveImageToPhotosAlbum, mt.saveVideoToPhotosAlbum | 不支持 | |||
| scope.camera | 是否授权摄像头，对应相机组件 | 不支持 | 不支持 | ||
| 订阅消息设置 | 不支持 | 不支持 | |||
| mainSwitch | 订阅消息总开关 | 不支持 | 不支持 | ||
| itemSettings | 每一项订阅消息的订阅状态 Key 为一次性订阅消息的模板id或系统订阅消息的类型 | 不支持 | 不支持 | ||
| mt.createOpenSettingButton | 用户点击后打开设置页面的按钮 | 不支持 | 不支持 | ||
| OpenSettingButton.show | 显示打开设置页面按钮 | 不支持 | 不支持 | ||
| OpenSettingButton.hide | 隐藏打开设置页面按钮 | 不支持 | 不支持 | ||
| OpenSettingButton.destroy | 销毁打开设置页面按钮 | 不支持 | 不支持 | ||
| OpenSettingButton.onTap | 监听设置页面按钮的点击事件 | 不支持 | 不支持 | ||
| OpenSettingButton.offTap | 取消监听设置页面按钮的点击事件 | 不支持 | 不支持 | ||
| 游戏圈 | mt.createGameClubButton | 创建游戏圈按钮，详细 API | 不支持 | 不支持 | |
| 客服消息 | mt.openCustomerServiceConversation | 进入客服会话。要求在用户发生过至少一次 touch 事件后才能调用 | 不支持 | 不支持 | |
| 微信运动 | mt.getWeRunData | 获取用户过去三十天微信运动步数 | 不支持 | 不支持 | |
| 卡券 | mt.openCard | 查看微信卡包中的卡券 | 不支持 | 不支持 | |
| mt.addCard | 批量添加卡券 | 不支持 | 不支持 | ||
| 账号信息 | mt.getAccountInfoSync | 获取当前帐号信息 | 不支持 | 不支持 | |
| 数据上报 | mt.reportMonitor | 自定义业务数据监控上报接口 | 不支持 | 不支持 | |
| 订阅消息 | mt.requestSubscribeMessage | 调起客户端小游戏订阅消息界面，返回用户订阅消息的操作结果 | 不支持 | 不支持 | |
| mt.requestSubscribeSystemMessage | 调起小游戏系统订阅消息界面，返回用户订阅消息的操作结果 | 不支持 | 不支持 | ||
| 添加到桌面 | mt.supportShortcut | 查询设备是否支持添加桌面快捷方式 | 支持 | 不支持 | |
| mt.addShortcut | 添加快捷方式，不支持重复添加 | 支持 | 不支持 | ||
| mt.deleteShortcut | 删除快捷方式 | 支持 | 不支持 | ||
| mt.updateShortcut | 更新快捷方式 | 支持 | 不支持 | ||
| mt.queryShortcut | 查询快捷方式 | 支持 | 不支持 |
# 设备
| 分类 | API | 实例 API | 说明 | Android | iOS |
|---|---|---|---|---|---|
| 外围设备 | mt.createBLEPeripheralServer | 建立本地作为外围设备的服务端 | 不支持 | 不支持 | |
| iBeacon | mt.getBeacons | 获取所有已搜索到的 iBeacon 设备 | 不支持 | 不支持 | |
| 低功耗蓝牙 | mt.createBLEConnection | 连接低功耗蓝牙设备，全部 API 见 | 不支持 | 不支持 | |
| 联系人 | mt.addPhoneContact | 添加手机通讯录联系人 （ 小程序 API 、小游戏未包含 ） | 不支持 | 不支持 | |
| 蓝牙 | mt.startBluetoothDevicesDiscovery | 开始搜寻附近的蓝牙外围设备 | 不支持 | 不支持 | |
| 电量 | mt.getBatteryInfo | 获取设备电量 | 不支持 | 不支持 | |
| mt.getBatteryInfoSync | 获取设备电量 同步版本 | 不支持 | 不支持 | ||
| 剪切板 | mt.setClipboardData | 设置系统剪贴板的内容 | 支持 | 支持 | |
| mt.getClipboardData | 获取系统剪贴板的内容 | 支持 | 支持 | ||
| 网络 | mt.onNetworkStatusChange | 监听网络状态变化事件 | 不支持 | 支持 | |
| mt.offNetworkStatusChange | 取消监听网络状态变化事件，参数为空，则取消所有的事件监听 | 不支持 | 支持 | ||
| mt.getNetworkType | 获取网络类型 | 支持 | 支持 | ||
| 屏幕 | mt.setScreenBrightness | 设置屏幕亮度 | 支持 | 支持 | |
| mt.setKeepScreenOn | 设置是否保持常亮状态 | 支持 | 支持 | ||
| mt.onUserCaptureScreen | 监听用户主动截屏事件 | 不支持 | 不支持 | ||
| mt.offUserCaptureScreen | 取消监听用户主动截屏事件 | 不支持 | 不支持 | ||
| mt.getScreenBrightness | 获取屏幕亮度 | 支持 | 支持 | ||
| 加速器 | mt.stopAccelerometer | 停止监听加速度数据 | 支持 | 支持 | |
| mt.startAccelerometer | 开始监听加速度数据 | 支持 | 支持 | ||
| mt.onAccelerometerChange | 监听加速度数据事件 | 支持 | 支持 | ||
| mt.offAccelerometerChange | 取消监听加速度数据事件，参数为空，则取消所有的事件监听 | 支持 | 支持 | ||
| 罗盘 | mt.stopCompass | 停止监听罗盘数据 | 不支持 | 不支持 | |
| mt.startCompass | 开始监听罗盘数据 | 不支持 | 不支持 | ||
| mt.onCompassChange | 监听罗盘数据变化事件 | 不支持 | 不支持 | ||
| mt.offCompassChange | 取消监听罗盘数据变化事件，参数为空，则取消所有的事件监听 | 不支持 | 不支持 | ||
| 设备方向 | mt.stopDeviceMotionListening | 停止监听设备方向的变化 | 不支持 | 不支持 | |
| mt.startDeviceMotionListening | 开始监听设备方向的变化 | 不支持 | 不支持 | ||
| mt.onDeviceMotionChange | 监听设备方向变化事件 | 不支持 | 不支持 | ||
| mt.offDeviceMotionChange | 取消监听设备方向变化事件，参数为空，则取消所有的事件监听 | 不支持 | 不支持 | ||
| 转屏 | mt.onDeviceOrientationChange | 监听横竖屏切换事件 | 支持 | 支持 | |
| mt.offDeviceOrientationChange | 取消监听横竖屏切换事件 | 支持 | 支持 | ||
| 陀螺仪 | mt.stopGyroscope | 停止监听陀螺仪数据 | 不支持 | 不支持 | |
| mt.startGyroscope | 开始监听陀螺仪数据 | 不支持 | 不支持 | ||
| mt.onGyroscopeChange | 监听陀螺仪数据变化事件 | 不支持 | 不支持 | ||
| mt.offGyroscopeChange | 取消监听陀螺仪数据变化事件 | 不支持 | 不支持 | ||
| 性能告警 | mt.onMemoryWarning | 监听内存不足告警事件 | 不支持 | 支持 | |
| mt.offMemoryWarning | 取消监听内存不足告警事件 | 不支持 | 支持 | ||
| 振动 | mt.vibrateShort | 使手机发生较短时间的振动（15 ms） | 支持 | 支持 | |
| mt.vibrateLong | 使手机发生较长时间的振动（400 ms) | 支持 | 支持 |