插件调用 API 的限制插件可以调用的 API 与小程序不同,主要有两个区别: - 插件的请求域名列表与小程序相互独立;
- 一些 API 不允许插件调用(这些函数不存在于 wx 对象下)。
有些接口虽然在插件中不能使用,但可以通过插件功能页来达到目的,请参考插件功能页。 目前,允许插件调用的 API 及其对应版本要求如下: 基础API | 最低版本 | 备注 |
---|
wx.arrayBufferToBase64 | | | wx.base64ToArrayBuffer | | |
发起请求上传、下载API | 最低版本 | 备注 |
---|
wx.downloadFile | 1.9.6 | | wx.uploadFile | 1.9.6 | |
WebSocketAPI | 最低版本 | 备注 |
---|
wx.connectSocket | 1.9.6 | |
图片API | 最低版本 | 备注 |
---|
wx.previewImage | 1.9.6 | | wx.chooseImage | 1.9.6 | | wx.getImageInfo | 1.9.6 | | wx.saveImageToPhotosAlbum | 1.9.6 | |
录音API | 最低版本 | 备注 |
---|
wx.startRecord | 1.9.6 | | wx.stopRecord | 1.9.6 | |
实时音视频API | 最低版本 | 备注 |
---|
wx.createLivePlayerContext | 1.9.6 | | wx.createLivePusherContext | 1.9.6 | |
录音管理API | 最低版本 | 备注 |
---|
wx.getRecorderManager | 1.9.94 | |
音频播放控制API | 最低版本 | 备注 |
---|
wx.pauseVoice | 1.9.6 | | wx.playVoice | 1.9.6 | | wx.stopVoice | 1.9.6 | |
音乐播放控制API | 最低版本 | 备注 |
---|
wx.onBackgroundAudioPlay | 1.9.6 | | wx.getBackgroundAudioPlayerState | 1.9.6 | | wx.onBackgroundAudioStop | 1.9.6 | | wx.stopBackgroundAudio | 1.9.6 | | wx.onBackgroundAudioPause | 1.9.6 | | wx.seekBackgroundAudio | 1.9.6 | | wx.playBackgroundAudio | 1.9.6 | | wx.pauseBackgroundAudio | 1.9.6 | |
背景音频播放管理API | 最低版本 | 备注 |
---|
wx.getBackgroundAudioManager | 1.9.6 | |
音频组件控制API | 最低版本 | 备注 |
---|
wx.createInnerAudioContext | 1.9.6 | | wx.createAudioContext | 1.9.6 | |
视频API | 最低版本 | 备注 |
---|
wx.chooseVideo | 1.9.6 | | wx.saveVideoToPhotosAlbum | 1.9.6 | |
视频组件控制API | 最低版本 | 备注 |
---|
wx.createVideoContext | 1.9.6 | |
相机组件控制API | 最低版本 | 备注 |
---|
wx.createCameraContext | 1.9.6 | |
数据缓存API | 最低版本 | 备注 |
---|
wx.setStorage | 1.9.6 | | wx.getStorage | 1.9.6 | | wx.removeStorage | 1.9.6 | | wx.setStorageSync | 1.9.6 | | wx.getStorageSync | 1.9.6 | | wx.removeStorageSync | 1.9.6 | |
获取位置API | 最低版本 | 备注 |
---|
wx.getLocation | 1.9.6 | | wx.chooseLocation | 1.9.6 | | wx.onLocationChange | 2.8.0 | | wx.offLocationChange | 2.9.1 | | wx.stopLocationUpdate | 2.8.0 | | wx.startLocationUpdate | 2.8.0 | |
查看位置API | 最低版本 | 备注 |
---|
wx.openLocation | 1.9.6 | |
地图组件控制API | 最低版本 | 备注 |
---|
wx.createMapContext | 1.9.6 | |
系统信息API | 最低版本 | 备注 |
---|
wx.getSystemInfoSync | 1.9.6 | | wx.getSystemInfo | 1.9.6 | |
屏幕亮度API | 最低版本 | 备注 |
---|
wx.setKeepScreenOn | 1.9.6 | | wx.setScreenBrightness | 1.9.6 | | wx.getScreenBrightness | 1.9.6 | |
用户截屏事件API | 最低版本 | 备注 |
---|
wx.onUserCaptureScreen | 1.9.6 | 仅限插件页面中调用 | wx.offUserCaptureScreen | 2.9.1 | 仅限插件页面中调用 |
振动 |