微信小程序开发文档 第78页
微信小程序API设备概览 系统信息——(wx.getSystemInfo、wx.getSystemInfoSync) 网络状态——(wx.getNetworkType) 重力感应——(wx.onAccelerometerChange) 罗 盘——(wx.onCompassChange) 拨打电话——(wx.makePhoneCall) 扫 码——(wx.scanCode) wx.getSystemInfo(OBJECT) 获取系统信息。 OBJECT参数说明: 参数 类型 必填 说明 success Function 是 接口调用成功的回调 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) success回调参数说明: 属性 说明 model 手机型号 pixelRatio 设备像素比 windowWidth 窗口宽度 windowHeight 窗口高度 language 微信设置的语言 version 微信版本号 system 操作系统版本 platform 客户端平台 示例代码: wx.getSystemInfo({ success: function(res) { console.log(res.model) console.log(res.pixelRatio) console.log(res.windowWidth) console.log(res.windowHeight) console.log(res.language) console.log(res.version) console.log(res.platform) } }) wx.getSystemInfoSync() 获取系统信息同步接口 示例代码: try { var res = wx.getSystemInfoSync() console.log(res.model) console.log(res.pixelRatio) console.log(res.windowWidth) console.log(res.windowHeight) console.log(res.language) console.log(res.version) console.log(res.platform) } catch (e) { // Do something when catch error }
InterstitialAd 插屏广告组件。插屏广告组件是一个原生组件,层级比普通组件高。插屏广告组件每次创建都会返回一个全新的实例(小程序端的插屏广告实例不允许跨页面使用),默认是隐藏的,需要调用 InterstitialAd.show() 将其显示。 方法: InterstitialAd.destroy() 基础库 2.8.0 开始支持,低版本需做兼容处理。 销毁插屏广告实例。 Promise InterstitialAd.load() 基础库 2.8.0 开始支持,低版本需做兼容处理。 加载插屏广告。 返回值 Promise 插屏广告加载数据的结果 InterstitialAd.offClose(function callback) 取消监听插屏广告关闭事件 参数 function callback 插屏广告关闭事件的回调函数 InterstitialAd.offError(function callback) 取消监听插屏错误事件 参数 function callback 插屏错误事件的回调函数 InterstitialAd.offLoad(function callback) 取消监听插屏广告加载事件 参数 function callback 插屏广告加载事件的回调函数 InterstitialAd.onClose(function callback) 监听插屏广告关闭事件。 参数 function callback 插屏广告关闭事件的回调函数 InterstitialAd.onError(function callback) 监听插屏错误事件。 参数 function callback 插屏错误事件的回调函数 参数 Object res 属性 类型 说明 errMsg string 错误信息 errCode number 错误码 errCode 的合法值 值 说明 最低版本 1000 后端接口调用失败 1001 参数错误 1002 广告单元无效 1003 内部错误 1004 无合适的广告 1005 广告组件审核中 1006 广告组件被驳回 1007 广告组件被封禁 1008 广告单元已关闭 错误码信息与解决方案表 错误码是通过onError获取到的错误信息。调试期间,可以通过异常返回来捕获信息。 在小程序发布上线之后,如果遇到异常问题,可以在“运维中心“里面搜寻错误日志,还可以针对异常返回加上适当的监控信息。 代码 异常情况 理由 解决方案 1000 后端错误调用失败 该项错误不是开发者的异常情况 一般情况下忽略一段时间即可恢复。 1001 参数错误 使用方法错误 可以前往developers.weixin.qq.com确认具体教程(小程序和小游戏分别有各自的教程,可以在顶部选项中,“设计”一栏的右侧进行切换。 1002 广告单元无效 可能是拼写错误、或者误用了其他APP的广告ID 请重新前往mp.weixin.qq.com确认广告位ID。 1003 内部错误 该项错误不是开发者的异常情况 一般情况下忽略一段时间即可恢复。 1004 无适合的广告 广告不是每一次都会出现,这次没有出现可能是由于该用户不适合浏览广告 属于正常情况,且开发者需要针对这种情况做形态上的兼容。 1005 广告组件审核中 你的广告正在被审核,无法展现广告 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。...
InterstitialAd wx.createInterstitialAd(Object object) 基础库 2.6.0 开始支持,低版本需做兼容处理。 创建插屏广告组件。请通过 wx.getSystemInfoSync() 返回对象的 SDKVersion 判断基础库版本号后再使用该 API。每次调用该方法创建插屏广告都会返回一个全新的实例(小程序端的插屏广告实例不允许跨页面使用)。 参数 Object object 属性 类型 默认值 必填 说明 adUnitId string 是 广告单元 id 返回值 InterstitialAd 插屏广告组件
VideoDecoder wx.createVideoDecoder() 基础库 2.11.0 开始支持,低版本需做兼容处理。 创建视频解码器,可逐帧获取解码后的数据 返回值 VideoDecoder
wx.offOnVoIPVideoMembersChanged(function callback) 基础库 2.11.0 开始支持,低版本需做兼容处理。 取消监听实时语音通话成员视频状态变化事件 参数 function callback 实时语音通话成员视频状态变化事件的回调函数
wx.offVoIPChatInterrupted(function callback) 基础库 2.9.0 开始支持,低版本需做兼容处理。 取消监听被动断开实时语音通话事件。 参数 function callback 被动断开实时语音通话事件的回调函数
wx.offVoIPChatMembersChanged(function callback) 基础库 2.9.0 开始支持,低版本需做兼容处理。 取消监听实时语音通话成员在线状态变化事件。 参数 function callback 实时语音通话成员在线状态变化事件的回调函数
MediaContainer wx.createMediaContainer() 基础库 2.9.0 开始支持,低版本需做兼容处理。 创建音视频处理容器,最终可将容器中的轨道合成一个视频 返回值 MediaContainer
每个微信小程序需要事先设置一个通讯域名,小程序可以跟指定的域名与进行网络通信。包括普通 HTTPS 请求(wx.request)、 WebSocket 通信(wx.connectSocket)、上传文件(wx.uploadFile)和下载文件(wx.downloadFile)。 网络API列表: API 说明 wx.request 发起网络请求 wx.uploadFile 上传文件 wx.downloadFile 下载文件 wx.connectSocket 创建 WebSocket 连接 wx.onSocketOpen 监听 WebSocket 打开 wx.onSocketError 监听 WebSocket 错误 wx.sendSocketMessage 发送 WebSocket 消息 wx.onSocketMessage 接受 WebSocket 消息 wx.closeSocket 关闭 WebSocket 连接 wx.onSocketClose 监听 WebSocket 关闭 Tip tip: 网络请求的 referer 是不可以设置的,格式固定为https://servicewechat.com/{appid}/{version}/page-frame.html,其中{appid}为小程序的 appid,{version}为小程序的版本号,版本号为 0 表示为开发版。 tip: 小程序进入后台运行后(非置顶聊天),如果 5s 内网络请求没有结束,会回调错误信息 “fail interrupted”;在回到前台之前,网络请求接口调用都会无法调用。
wx.getBackgroundAudioPlayerState(OBJECT) 获取音乐播放状态。 OBJECT参数说明: 参数 类型 必填 说明 success Function 否 接口调用成功的回调函数 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) success返回参数说明: 参数 说明 duration 选定音频的长度(单位:s),只有在当前有音乐播放时返回 currentPosition 选定音频的播放位置(单位:s),只有在当前有音乐播放时返回 status 播放状态(2:没有音乐在播放,1:播放中,0:暂停中) downloadPercent 音频的下载进度(整数,80 代表 80%),只有在当前有音乐播放时返回 dataUrl 歌曲数据链接,只有在当前有音乐播放时返回 示例代码: wx.getBackgroundAudioPlayerState({ success:function(res){ var status = res.status var dataUrl = res.dataUrl var currentPosition = res.currentPosition var duration = res.duration var downloadPercent = res.downloadPercent } }) wx.playBackgroundAudio(OBJECT) 使用后台播放器播放音乐,对于微信客户端来说,只能同时有一个后台音乐在播放。当用户离开小程序后,音乐将暂停播放;当用户点击“显示在聊天顶部”时,音乐不会暂停播放;当用户在其他小程序占用了音乐播放器,原有小程序内的音乐将停止播放。 OBJECT参数说明 参数 类型 必填 说明 dataUrl String 是 音乐链接 title String 否 音乐标题 coverImgUrl String 否 封面URL success Function 否 接口调用成功的回调函数 fail Function 否 接口调用失败的回调函数 complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码 wx.playBackgroundAudio({ dataUrl: '', title: '', coverImgUrl: '' }) wx.pauseBackgroundAudio() 暂停播放音乐。 示例代码 wx.pauseBackgroundAudio() wx.seekBackgroundAudio(OBJECT) 控制音乐播放进度。 OBJECT参数说明 参数 类型 必填 说明 position Number 是 音乐位置,单位:秒 success Function 否 接口调用成功的回调函数 fail Function...