网络Api
微信小程序处理的数据通常从后台服务器获取,再将处理过的结果保存到后台服务器,这就要求微信小程序要有与后台进行交互的能力。微信原生API接口或第三方API提供了各类接口实现前后端交互。
网络API可以帮助开发者实现网络URL访问调用、文件的上传和下载、网络套接字的
使用等功能处理。微信开发团队提供了10个网络API接口。
(1)wx.request(Object)接口用于发起HTTPS请求。
(2)wx.uploadFile(Object)接口用于将本地资源上传到后台服务器。
(3)wx.downloadFile(Object)接口 用于下载文件资源到本地。
(4)wx.connectSocket(Object)接口 用于创建一个WebSocket 连接。
(5)wx.sendSocketMessage(Object)接口 用于实现通过WebSocket 连接发送数据。
(6)wx.closeSocket(Object)接口用于关闭WebSocket连接。
(7)wx.onSocketOpen(CallBack)接口 用于监听 WebSocket连接打开事件。
(8)wx.onSocketError(CallBack)接口 用于监听WebSocket错误。
(9)wx.onSocketMessage(CallBack)接口 用于实现监听 WebSocket 接收到服务器的消息
(10)wx.onSocketClose(CallBack)接口 用于实现监听WebSocket关闭。
发起网络请求
wx.request(Object)实现向服务器发送请求、获取数据等各种网络交互操作,一个微信小程序同时只能有5个网络请求连接,并且是HTTPS请求。
列如,通过 wx. request(Object)获取百度(https://www.baidu.com)首页的数据。
.wxml
<button type="primary"bindtap="getbaidutap">获取HTML数据</button>
<textarea value ='{{html}}'auto-heightmaxlength='0'></textarea>
.js
Page({
data:{
html:""
},
getbaidutap:function(){
var that = this;
wx.request({
url:'https://www.baidu.com/',
data:{},
header:{'Content-Type':'application/json'},
success:function(res){
console.log(res);
that.setData({
html:res.data
})
}
})
}
})
运行结果:
例如,通过wx.request(Object)的CET方法获取邮政编码对应的地址信息
.wxml
<view>邮政编码:</view>
<input type="text"bindinput="input"placeholder='6位邮政编码'/>
<button type ="primary"bindtap="find">查询</button>
<block wx:for="{{address}}">
<block wx:for="{{item}}">
<text > {{item}}</text></block>
</block>
.js
Page({
data:{
postcode:"",
address:[],
errMsg:"",
erroe_code:-1
},
input:function(e){
this.setData({
postcode:e.detail.value,
})
console.log(e.detail.value)
},
find:function(){
var postcode = this.data.postcode;
if(postcode != null&& postcode != ""){
var self = this;
wx.showToast({
title:'正在查询、请稍候...',
icon:'loading',
duration:10000
});
wx.request({
uel:'https://v.juhe.cn/postcode/query',
data:{
'postcode': postcode,
'key':'0ff9bfccaf147476e067de994eb5496e'
},
header:{
'Content -Type':'application/json',
},
success:function(res){
wx.hideToast();
if(res.data.error_code ==0){
console.log(res);
self.setData({
errMsg:"",
error_code: res.data.error_code,
address:res.data.result.list
})
}
else{
self.setData({
rrMsg:res.data.reason ||res.data.reason,
error_code: res.data. error_code
})
}
}
})
}
}
})
运行结果:
上传文件
wx.uploadFile(Object)接口用于将本地资源上传到开发者服务器,并在客户端发起一个HTTPS POOST请求,相关参数如图
通过wx. uploadFile,可以将图片上传到服务器显示。
.wxml
<button type="primary"bindtap="uploadimage">上传图片</button ><image src="/images/tp.jpg"mode="widthFix"/>
.js
Page({
data:{
img :null,
uploadimage:function(){
var that =this;
//选择图片
wx.chooseImage({
success:function(res){
var tempFilePaths =res.tempFilePaths
upload(that,tempFilePaths);
}
})
function upload(page,path){
//显示toast提示消息
wx.showToast({
icon:"loading",
title:"正在上传"
}),
wx.uploadFile({
url:"http://localhost/",
filePath:path[0],
name:'file',
success:function(res){
console.log(res);
if(res.statusCodel=200){
wx.showModal({
title:'提示',
content:'上传失败',
showCancel:false
})
return;
}
var data =res.data
page.setData({ //上传成功修改显示头像
img:path[0]
})
},
fail:function(e){
console.log(e);
wx.showModal({
title:'提示',
content:'上传失败',
showCancel:false
})
},
complete:function(){//隐藏 Toast
wx.hideToast();
}
})
}
}
}
})
运行结果:
下载文件
wx.downloadFile(Object)接口用于实现从开发者服务器下载文件资源到本地,在客户端直接发起一个HTTP GET请求,返回文件的本地临时路径,相关参数如图
通过wx.downloadFile(Object),实现从服务器下载图片
.wxml
<button type="primary" bind:tap="downloadimge">下载图像</button>
<image src="{{img}}"mode='widthFix'style = "width:90%;height:500px"></image>
.js
Page({
data:{
img:null,
},
downloadimage:function(){
var that = this;
wx.downloadFile({
url: "http://localhost/1.jpg", //通过WAMP软件实现
success:function(res){
console.log(res)
that.setData({
img:res.tempFilePath
})
}
})
}
})
运行结果:
多媒体
多媒体 API主要包括图片API、录音API、音频播放控制API、音乐播放控制API等,其
目的是丰富小程序的页面功能。
图片API
图片API实现对相机拍照图片或本地相册图片进行处理,主要包括以下4个API接口:
(1)wx. chooselmage(Object)接口用于从本地相册选择图片或使用相机拍照。
(2)wx.previewlmage(Object)接口 用于预览图片。
(3)wx.getlmagelnfo(Object)接口用于获取图片信息。
(4)wx. savelmageToPhotosAlbum(Object)接口用于保存图片到系统相册。
选择图片或拍照
wx.chooselmage(Object)接口用于从本地相册选择图片或使用相机拍照。拍照时产生的临时路径在小程序本次启动期间可以正常使用,若要持久保存,则需要调用wx.saveFile保存图片到本地。其相关参数如表
若调用成功,则返回 tempFilePaths和 tempFiles,tempFilcPaths表示图片在本地临时文件
路径列表。tempFiles 表示图片的本地文件列表,包括path和size。
示例代码
wx.chooseImage({
count:2,//默认值为9
sizeType:['original','compressed'],//可以指定是原图还是压缩图,默认
者都有
sourceType:['album','camera'],//可以指定来源是相册还是相机,默认二者都有
success:function(res){
//返回选定照片的本地文件路径列表,tempFilePath可以作为img标签的src属性来显示图片
var tempFilePaths =res.tempFilePaths
var tempFiles =res.tempFiles;
console.log(tempFilePaths)
console.log(tempFiles)
}
})
预览图片
wx.previewImage(Object)接口主要用于预览图片,其相关参数如表
示例代码
wx.previewImage({
//定义显示第二张
current:" http://bmob- can - 16488.b0.upaiyun. com/2018 /02/05 2.png",
urls:["http://bmob-cdn -16488.b0.upaiyun.com/2018/02/05/1.png"
"http://bmob-cdn -16488.b0.upaiyun.com /2018/02/05 /2.png",
"http://bmob -cdn -16488.b0.upaiyun.com /2018/02 /05 /3.jpg"
]
})
获取图片信息
wx.getImageInfo(Object)接口用于获取图片信息,其参数如表
代码示例
wx.chooseImage({
success:function(res){
wx.getImageInfo({
src:res.tempFilePaths[0],
success:function(e){
console.log(e.width)
console.log(e.height)
}
})
},
})
保存图片到系统相册
wx. savelmageToPhotosAlbum(Object)接口用于保存图片到系统相册,需要得到用户授权
scope. writePhotosAlbum。其相关参数如表示例代码
wx.chooseImage({
success: function(res){
wx. SaveImageToPhotosAlbum({
filePath: res.tempFilePaths[0]
success:function(e){
console.1og(e)
}
})
},
})
录音
6.2.2录音API
录音 API提供了语音录制的功能,主要包括以下两个API 接口:
(1)wx. startRecord(Object)接口用于实现开始录音。
(2)wx.stopRecord(Object)接口 用于实现主动调用停止录音。
开始录音
wx. startRecord(Object)接口用于实现开始录音。当主动调用 wx.stopRecord(Object)接口或者录音超过1分钟时,系统自动结束录音,并返回录音文件的临时文件路径。若要持久保存,则需要调用wx.saveFile()接口。其相关参数如表
停止录音
wx.stopRecord(Object)接口用于实现主动调用停止录音。
代码示例
wx.startRecord)
({
success: function(res){
var tempFilePath= res.tempFilePath},
fail: function(res){
//录音失败
}
})
setTimeout(function(){//结束录音
wx.stopRecord()
},10000)
音频播放控制
音频播放控制 API主要用于对语音媒体文件的控制,包括播放、暂停、停止及audio组
件的控制,主要包括以下3个 API:
wx.playVoice(Object)接口用于实现开始播放语音。
wx.pauseVoice(Object)接口用于实现暂停正在播放的语音。
wx.stopVoice(Object)接口用于结束播放语音。
播放音乐
wx.playVoice(Object)接口用于开始播放语音,同时只允许一个语音文件播放,如果前
一个语音文件还未播放完,则中断前一个语音文件的播放。其相关参数如表代码示例
wx.playBackgroundAudio({
dataUrl:'http://bmob-cdn-16488.b0.upaiyun.com/2018/02/01/ti.mp3',
title:'有一天',
coverImgUrl:'http://bmob-cdn-16488.b0.upaiyun.com/2018/02/01/si.jpg',
success:function(res){
console.log(res)
}
})
获取音乐播放状态
wx.getBackgroundAudioPlayerState(Object)接口用于获取音乐播放状态,其相关参数如图
代码示例
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
console.log("播放状态:"+status)
console.log("音乐文件地址:"+dataUrl)
console.log("音乐文件当前播放位置:"+currentPosition)
console.log("音乐文件的长度:"+duration)
console.log("音乐文件的下载进度:"+status)
}
})
控制音乐播放进度
wx.playBackgrondAudio{
dataUrl:'/music/a.mp3',
title:'我的音乐',
coverImgUrl:'/images/poster.jpg',
success:function(){
console.log('开始播放音乐了');
}
});
setTimeout(function(){
console.log('暂停播放');
wx.pauseBackgroundAudio();
},5000);//5秒后自动暂停
wx.seekBackgroundAudio(Object)接口用于控制音乐播放进度,其相关参数如表 示例代码
wx.seekBackgroundAudio({
posiyion:30
})
4.暂停播放音乐
wx.pauseBackgroundAudio()接口用于暂停播放音乐。
代码示例
wx.stopBackgroundAudio()接口用于暂停播放音乐。
代码示例
wx.playBackgrondAudio{
dataUrl:'/music/a.mp3',
title:'我的音乐',
coverImgUrl:'/images/poster.jpg',
success:function(){
console.log('开始播放音乐了');
}
});
setTimeout(function(){
console.log('暂停播放');
wx.stopBackgroundAudio();
},5000);//5秒后自动
监听音乐播放
wx.onBackgroundAudioPlay(CallBack)接口用于实现监听音乐播放,通常被wx.playBackgroundAudio(Object)方法触发,在CallBack中可改变播放图标。
示例代码
wx.playBackgroundAudio({
dataUrl:this.data.musicData.dataUrl,
title:this.data.musicData.title,
coverImgUrl:this.data.musicData.coverImgUrl,
success:function(){
wx.onBackgroundAudioStop(function(){
that.setData({
isPlayingMusic:false
})
})
监听音乐暂停
wx.onBackground AudioPause(CallBack)接口用于实现监听音乐暂停,通常被 wx.pause
BackgroundAudio()方法触发。在CallBack中可以改变播放图标。
监听音乐停止
wx. onBackgroundAudioStop(CallBack)接口用于实现监听音乐停止,通常被音乐自然播放停止或wx. seekBackgroundAudio(Object)方法导致播放位置等于音乐总时长时触发。在CallBack中可以改变播放图标。
案例展示
在此,以小程序music 为案例来展示音乐API的使用。该小程序的4个页面文件分别为music. wxml、music. wxss、music.json和music.cojs。
music.wxml的示例代码如下
<view class="container">
<image class="bgaudio"src = "{{changedImg? music.coverImg:'../images/yy (4).png'}}"/>
<view class ="control-view">
<!--使用data-how定义一个0表示快退10秒-->
<image src ="../images/yy (4).png"bindtap="onPositionTap"data-how= "0 "/>
<image src = "../images/{{isPlaying?'pause':'play'}}.png " bindtap = "onAudioTap"/>
<image src ="../images/play.png"bindtap = "onStopTap"/><!--使用data-how定义一个1表示快进10秒-->
<image src ="../images/yy (4).png"bindtap ="onPositionTap"data-how = "1"/>
</view >
</view >
music.wxss的示例代码如下
.bgaudio{
height:350rpx; width:350rpx;
margin-bottom:100rpx;
}
.control-view image{
height:64rpx;
width:64rpx;
margin:30rpx;
}
music.json的示例代码如下
music.js的示例代码如下
Page({
data:{
//记录播放状态
isPlaying:false,
//记录coverImg,仅当音乐初始时和播放停止时,使用默认的图片。播放中和暂停时,都使用当前音乐的图片
coverImgchangedImg:false,
//音乐内容
music:{
"url":"../images/e e.mp4",
"title":"盛晓玫-有一天",
"coverImg":
"../images/e e.mp4"
},
},
onl oad:function(){
//页面加载时,注册监听事件
this.onAudioState();
},
//点击播放或者暂停按钮时触发
onAudioTap:function(event){
if(this.data.isPlaying){
//如果在正常播放状态,就暂停,并修改播放的状态
wx.pauseBackgroundAudio();
}else{
//如果在暂停状态,就开始播放,并修改播放的状态28
let music = this.data.music;
wx.playBackgroundAudio({
dataUrl: music.url,
title: music.title,
coverImgUrl:music.coverImg
})
}
},
//点击即可停止播放音乐
onStopTap:function(){
let that = this;
wx.stopBackgroundAudio({
success:function(){
//改变coverImg和播放状态
that.setData({ isPlaying:false,changedImg:false});
}
})
},
//点击“快进10秒”或者“快退10秒”时,触发
onPositionTap:function(event){
let how = event.target.dataset.how;//获取音乐的播放状态
wx.getBackgroundAudioPlayerState({
success:function(res){
//仅在音乐播放中,快进和快退才生效
//音乐的播放状态,1表示播放中54
let status = res.status;
if(status === 1){//音乐的总时长
let duration = res.duration;//音乐播放的当前位置
let currentPosition = res.currentPosition;
if(how ==="0"){
//注意:快退时,当前播放位置快退10秒小于0时,直接设置position为1;否则,直接减去10秒//快退到达的位置
let position = currentPosition - 10;
if(position <0){
position =1;//执行快退
}
wx.seekBackgroundAudio({
position: position
});
//给出一个友情提示,在实际应用中,请删除!!!
wx. showToast({title:"快退10s",duration:500});
}
if(how === "1"){//注意:快进时,当前播放位置快进10秒后大于总时长时,直接设置position 为总时长减1
//快进到达的位置
let position =currentPosition +10;
if(position >duration){
position =duration-1;//执行快进
}
wx.seekBackgroundAudio({
position: position});//给出一个友情提示,在实际应用中,请删除!!!
wx.showToast({ title:"快进10s",duration:500});
}
}else { //给出一个友情提示,在实际应用中,请删除!!!
wx.showToast({title:"音乐未播放",duration:800});
}
}
})
},//音乐播放状态
onAudioState:function(){
let that =this;
wx.onBackgroundAudioPlay(function(){//当wx.playBackgroundAudio()执行时触发101 //改变coverImg和播放状态
that.setData({ isPlaying:true,changedImg:true});
console.log("on play");
});
wx.onBackgroundAudioPause(function(){ //当wx.pauseBackgroundAudio()执行时触发//仅改变播放状态
that.setData({isPlaying:false});
console.log("on pause");
});
wx.onBackgroundAudioStop(function(){ //当音乐自行播放结束时触发//改变coverImg和播放状态
that.setData({isPlaying:false,changedImg:false});
console.log("on stop");
});
}
})
文件API
从网络上下载或录音的文件都是临时保存的,若要持久保存,需要用到文件API。文件
API 提供了打开、保存、删除等操作本地文件的能力,主要包括以下5个API接口:
(1)wx.saveFile(Object)接口用于保存文件到本地。
(2)wx. getSavedFileList(Object)接口用于获取本地已保存的文件列表。
(3)wx.getSaveFilelnfo(Object)接口用于获取本地文
的文件信息。
(4)wx.removeSaveFile(Object)接口用于删除本地存储的文件。
(5)wx.openDocument(Object)接口 用于新开页面打开文档,支持格式:doc、x ppt、pdf、docx、xlsx、ppts。
保存文件
wx.saveFile(Object)用于保存文件到本地,其相关参数如表部分示例代码如下
savelmg: function(){
wx.chooseImage({
count:1,//默认值为9
sizeType:[original','compressed'],//可以指定是原图还是压缩图,默认
二者都有
sourceType:['album','camera ],//可以指定来源是相册还是相机,默认二者都有
success:function(res){
var tempFilePaths = res.tempFilePaths[0]
wx.saveFile({
tempFilePath: tempFilePaths,
success:function(res){
var saveFilePath = res. savedFilepath;
console. log(saveFilePath)
}
})
}
})
}
获取本地文件列表
wx. getSavedFileList(Object)接口用于获取本地已保存的文件列表,如果调用成功,则返回文件的本地路径、文件大小和文件保存时的时间戳(从1970/01/01 08:00:00到当前时间的秒数)文件列表。相关参数如图示例代码
wx.getSavedFileList({
success:function(res){
that.setData({
fileList:res.fileList
})
}
})
获取本地文件的文件信息
wx. getSaveFileInfo(0bject)接口用于获取本地文件的文件信息,此接口只能用于获取已保存到本地的文件,若需要获取临时文件信息,则使用wx. getFileInfo(Object)接口。相关参数如图示例代码
wx.chooseImage(
count:1,//默认值为9
sizeType:['original,compressed'],//可以指定是原图还是压缩图,默认
sourceType:['album,'camera'],//可以指定来源是相册还是相机,默认二老
success:function(res){
var tempFilePaths = res.tempFilePaths[0]
wx.saveFile({
tempFilePath: tempFilePaths,
success:function(res){
var saverilePath = res.savedrilePath;
wx.getSavedFileInfo({
filePath: saveFilePath,
success:function(res){
console.log(res.size)
}
})
}
})
}
})
删除本地文件
wx.removeSaveFile(Object)用于删除本地储存文件,其参数如图示例代码如下
打开文档
wx.openDocument(Object)接口用于新开页面打开文档,支持格式有doc、xls、ppt、pdf、docx、xlsx、pptx,其相关参数如图
代码示例如下
wx.downloadFile({
url:"http://localhost/fm2.pdf",
success: function(res){
var tempFilePath =res. tempFilePath;
wx.openDocument({
filePath: tempFilePath,
success:function(res){
console.log("打开成功")
}
})
}
})
标签:总结,function,res,Object,接口,第六章,播放,wx
From: https://blog.csdn.net/2301_77030677/article/details/137634385