媒体

图片

saveImageToPhotosAlbum

基础库 2.0.7 开始支持，iOS版本 2.10.7，Android版本2.11.43

saveImageToPhotosAlbum(Object object)

保存图片到系统相册。

参数

Object object

示例代码

ft.saveImageToPhotosAlbum({
  filePath: 'finfile://xxxx',
  success(res) { }
})

previewMedia

预览图片和视频。

参数

Object object

object.sources 的结构

type 的合法值

previewImage

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

previewImage(Object object)

在新页面中全屏预览图片。

参数

Object object

示例代码

ft.previewImage({
  current: '', // 当前显示图片的http链接
  urls: [] // 需要预览的图片http链接列表
})

getImageInfo

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

getImageInfo(Object object)

获取图片信息。

参数

Object object

object.success 回调函数

参数

Object res

示例代码

ft.getImageInfo({
  src: 'images/a.jpg',
  success(res) {
    console.log(res.width)
    console.log(res.height)
  }
})

ft.chooseImage({
  success(res) {
    ft.getImageInfo({
      src: res.tempFilePaths[0],
      success(res) {
        console.log(res.width)
        console.log(res.height)
      }
    })
  }
})

compressImage

ft.compressImage(Object object)

基础库 2.0.5 开始支持，iOS版本 2.10.4，Android版本 2.11.39

压缩图片接口，可选压缩质量​

参数

Object object

object.success 回调函数

参数

示例代码

ft.compressImage({
  src: '', // 图片路径
  quality: 80 // 压缩质量
})

chooseMessageFile

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

从文件管理器选择文件。

参数

Object object

object.type 的合法值

chooseImage

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

chooseImage(Object object)

从本地相册选择图片或使用相机拍照。

参数

Object object

object.sizeType 的合法值

object.sourceType 的合法值

object.success 回调函数

参数

Object res

res.tempFiles 的结构

示例代码

ft.chooseImage({
  count: 1,
  sizeType: ['original', 'compressed'],
  sourceType: ['album', 'camera'],
  success(res) {
    // tempFilePath可以作为img标签的src属性显示图片
    const tempFilePaths = res.tempFilePaths
  }
})

fileToBase64

ft.fileToBase64(Object object)

图片转换成base64数据

参数

Object object

object.success 回调函数

参数

示例代码

ft.fileToBase64({
  url: '', // 图片路径
})

视频

saveVideoToPhotosAlbum

基础库 2.0.7 开始支持，iOS版本 2.10.7，Android版本2.11.43

saveVideoToPhotosAlbum(Object object)

保存视频到系统相册。支持mp4视频格式。

参数

Object object

示例代码

ft.saveVideoToPhotosAlbum({
  filePath: 'finfile://xxx',
  success (res) {
    console.log(res.errMsg)
  }
})

createVideoContext

VideoContext ft.createVideoContext(string id, Object this)

创建 video 上下文 VideoContext 对象。

参数

string id

video 组件的 id

Object this

在自定义组件下，当前组件实例的this，以操作组件内 video 组件

返回值

VideoContext

chooseVideo

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

chooseVideo(Object object)

从本地相册选择视频或使用相机拍摄视频。

参数

Object object

object.sourceType 的合法值

object.camera 的合法值

object.success 回调函数

参数

Object res

示例代码

ft.chooseVideo({
  sourceType: ['album', 'camera'],
  maxDuration: 60,
  camera: 'back',
  success(res) {
    console.log(res.tempFilePath)
  }
})

chooseMedia

chooseMedia(Object object) 拍摄或从手机相册中选择图片或视频。

参数 Object object

object.mediaType 的合法值

object.sourceType 的合法值

object.camera 的合法值

object.success 回调函数

参数

Object res

res.tempFiles 的结构

示例代码

ft.chooseMedia({
  count: 9,
  mediaType: ['image','video'],
  sourceType: ['album', 'camera'],
  maxDuration: 30,
  camera: 'back',
  success(res) {
    console.log(res.tempFiles.tempFilePath)
    console.log(res.tempFiles.size)
  }
})

previewVideo

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

previewVideo(Object object)

在新页面中全屏预览视频。

参数

Object object

示例代码

ft.previewVideo({
  url: 'http://static.tripbe.com/videofiles/20121214/9533522808.f4v.mp4',
  autoplay: true,
  success(res) {
    console.log(res.tempFilePath)
  }
})

VideoContext

VideoContext 实例，可通过 ft.createVideoContext 获取。VideoContext 通过 id 跟一个 video 组件绑定，操作对应的 video 组件。

方法

• VideoContext.play()
  播放视频

• VideoContext.pause()
  暂停视频

• VideoContext.stop()
  停止视频

• VideoContext.seek(number position)
  跳转到指定位置

• VideoContext.sendDanmu(Object data)
  发送弹幕

• VideoContext.playbackRate(number rate)
  设置倍速播放

• VideoContext.requestFullScreen(Object object)
  进入全屏。若有自定义内容需在全屏时展示，需将内容节点放置到 video 节点内。

• VideoContext.exitFullScreen()
  退出全屏

• VideoContext.showStatusBar()
  显示状态栏，仅在iOS全屏下有效

• VideoContext.hideStatusBar()
  隐藏状态栏，仅在iOS全屏下有效

• VideoContext.exitPictureInPicture()
  退出小窗，该方法可在任意页面调用

音频

stopVoice

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

stopVoice(Object object)

结束播放语音。

参数

Object object

示例代码

ft.startRecord({
  success(res) {
    const tempFilePath = res.tempFilePath
    ft.playVoice({
      filePath: tempFilePath,
    })

    setTimeout(() => { ft.stopVoice() }, 5000)
  }
})

setInnerAudioOption

setInnerAudioOption(Object object) 设置 InnerAudioContext 的播放选项。设置之后对当前小程序全局生效。

参数

Object object

注意 为保证整体体验，speakerOn 为 true 时，客户端会忽略 mixWithOthers 参数的内容，强制与其它音频互斥 不支持在播放音频的过程中切换为扬声器播放，开发者如需切换可以先暂停当前播放的音频并记录下当前暂停的时间点，然后切换后重新从原来暂停的时间点开始播放音频

playVoice

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

playVoice(Object object)

开始播放语音，同时只允许一个语音文件正在播放， 如果前一个语音文件还没播放完，将中断前一个语音播放。

参数

Object object

示例代码

ft.startRecord({
  success(res) {
    const tempFilePath = res.tempFilePath
    ft.playVoice({
      filePath: tempFilePath,
      complete() { }
    })
  }
})

pauseVoice

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

pauseVoice(Object object)

暂停正在播放的语音。再次调用ft.playVoice播放同一个文件时，会从暂停处开始播放。

参数

Object object

示例代码

ft.startRecord({
  success(res) {
    const tempFilePath = res.tempFilePath
    ft.playVoice({
      filePath: tempFilePath
    })

    setTimeout(() => { ft.pauseVoice() }, 5000)
  }
})

createInnerAudioContext

InnerAudioContext ft.createInnerAudioContext()

创建 audio 上下文 InnerAudioContext 对象。

返回值

InnerAudioContext

createAudioContext

AudioContext ft.createAudioContext(string id, Object this)

创建 audio 上下文 AudioContext 对象。

参数

string id

audio 组件的 id

Object this

在自定义组件下，当前组件实例的this，以操作组件内 audio 组件

返回值

AudioContext

AudioContext

AudioContext 实例，可通过 ft.createAudioContext 获取。

AudioContext 通过 id 跟一个 audio 组件绑定，操作对应的 audio 组件。

方法

• AudioContext.setSrc(string src)
  设置音频地址

• AudioContext.play()
  播放音频。

• AudioContext.pause()
  暂停音频。

• AudioContext.seek(number position)
  跳转到指定位置。

示例代码

<!-- audio.FXML -->
<audio  src="{{src}}" id="myAudio" ></audio>

<button type="primary" bindtap="audioPlay">播放</button>
<button type="primary" bindtap="audioPause">暂停</button>
<button type="primary" bindtap="audio14">设置当前播放时间为14秒</button>
<button type="primary" bindtap="audioStart">回到开头</button>

// audio.js
Page({
  onReady (e) {
    // 使用 ft.createAudioContext 获取 audio 上下文 context
    this.audioCtx = ft.createAudioContext('myAudio')
    this.audioCtx.setSrc('http://ws.stream.qqmusic.qq.com/M500001VfvsJ21xFqb.mp3?guid=ffffffff82def4af4b12b3cd9337d5e7&uin=346897220&vkey=6292F51E1E384E06DCBDC9AB7C49FD713D632D313AC4858BACB8DDD29067D3C601481D36E62053BF8DFEAF74C0A5CCFADD6471160CAF3E6A&fromtag=46')
    this.audioCtx.play()
  },
  data: {
    src: ''
  },
  audioPlay () {
    this.audioCtx.play()
  },
  audioPause () {
    this.audioCtx.pause()
  },
  audio14 () {
    this.audioCtx.seek(14)
  },
  audioStart () {
    this.audioCtx.seek(0)
  }
})

InnerAudioContext

InnerAudioContext 实例，可通过 ft.InnerAudioContext 获取。

属性

• string src
  ​ 音频资源的地址，用于直接播放。

• number startTime
  ​ 开始播放的位置（单位：s），默认为 0

• boolean autoplay
  是否自动开始播放，默认为 false

• boolean loop
  是否循环播放，默认为 false

• number volume
  音量。范围 0~1。默认为 1

• number playbackRate
  播放速度。范围 0.5-2.0，默认为 1。

方法

• InnerAudioContext.play()
  播放

• InnerAudioContext.pause()
  暂停。暂停后的音频再播放会从暂停处开始播放

• InnerAudioContext.stop()
  停止。停止后的音频再播放会从头开始播放。

• InnerAudioContext.seek(number position)
  跳转到指定位置​

• InnerAudioContext.destroy()
  销毁当前实例

• InnerAudioContext.onCanplay(function callback)
  监听音频进入可以播放状态的事件。但不保证后面可以流畅播放
  ​

• InnerAudioContext.offCanplay(function callback)
  取消监听音频进入可以播放状态的事件

• InnerAudioContext.onPlay(function callback)
  监听音频播放事件

• InnerAudioContext.offPlay(function callback)
  取消监听音频播放事件

• InnerAudioContext.onPause(function callback)
  监听音频暂停事件

• InnerAudioContext.offPause(function callback)
  取消监听音频暂停事件

• InnerAudioContext.onStop(function callback)
  监听音频停止事件

• InnerAudioContext.offStop(function callback)
  取消监听音频停止事件

• InnerAudioContext.onEnded(function callback)
  监听音频自然播放至结束的事件

• InnerAudioContext.offEnded(function callback)
  取消监听音频自然播放至结束的事件

• InnerAudioContext.onTimeUpdate(function callback)
  监听音频播放进度更新事件

• InnerAudioContext.offTimeUpdate(function callback)
  取消监听音频播放进度更新事件

• InnerAudioContext.onError(function callback)
  监听音频播放错误事件

• InnerAudioContext.offError(function callback)
  取消监听音频播放错误事件

• InnerAudioContext.onWaiting(function callback)
  监听音频加载中事件。当音频因为数据不足，需要停下来加载时会触发

• InnerAudioContext.offWaiting(function callback)
  取消监听音频加载中事件

• InnerAudioContext.onSeeking(function callback)
  监听音频进行跳转操作的事件

• InnerAudioContext.offSeeking(function callback)
  取消监听音频进行跳转操作的事件

• InnerAudioContext.onSeeked(function callback)
  监听音频完成跳转操作的事件

• InnerAudioContext.offSeeked(function callback)
  取消监听音频完成跳转操作的事件

示例代码

// innerAudioContext.js
const innerAudioContext = wx.createInnerAudioContext()
innerAudioContext.autoplay = true
innerAudioContext.src = 'http://ws.stream.qqmusic.qq.com/M500001VfvsJ21xFqb.mp3?guid=ffffffff82def4af4b12b3cd9337d5e7&uin=346897220&vkey=6292F51E1E384E061FF02C31F716658E5C81F5594D561F2E88B854E81CAAB7806D5E4F103E55D33C16F3FAC506D1AB172DE8600B37E43FAD&fromtag=46'
innerAudioContext.onPlay(() => {
  console.log('开始播放')
})
innerAudioContext.onError((res) => {
  console.log(res.errMsg)
  console.log(res.errCode)
})

实时音视频

createLivePusherContext

createLivePusherContext()

创建 live-pusher 上下文 LivePusherContext 对象。

返回值

LivePusherContext

createLivePlayerContext

createLivePlayerContext()

创建 live-player 上下文 LivePlayerContext 对象。建议使用 ft.createSelectorQuery 获取 context 对象。

参数

string id

live-player 组件的 id

Object this

在自定义组件下，当前组件实例的this，以操作组件内 live-player 组件

返回值

LivePlayerContext

录音

stopRecord

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38, 依赖扩展 SDK

stopRecord(Object object)

停止录音。

示例代码

ft.startRecord({
  success(res) {
    const tempFilePath = res.tempFilePath
  }
})
setTimeout(function () {
  ft.stopRecord() // 结束录音
}, 10000)

startRecord

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38, 依赖扩展 SDK

startRecord(Object object)

开始录音。当主动调用 ft.stopRecord，或者录音超过1分钟时自动结束录音。当用户离开小程序时，此接口无法调用。

参数

Object object

object.success 回调函数

参数

Object res

示例代码

ft.startRecord({
  success(res) {
    const tempFilePath = res.tempFilePath
  }
})
setTimeout(function () {
  ft.stopRecord() // 结束录音
}, 10000)

getRecorderManager

RecorderManager ft.getRecorderManager()

获取全局唯一的录音管理器 RecorderManager

返回值

RecorderManager

RecorderManager

全局唯一的录音管理器

方法

• RecorderManager.start(Object object)
  开始录音

• RecorderManager.pause()
  暂停录音

• RecorderManager.resume()
  继续录音

• RecorderManager.stop()
  停止录音

• RecorderManager.onStart(function callback)
  监听录音开始事件

• RecorderManager.onResume(function callback)
  监听录音继续事件

• RecorderManager.onPause(function callback)
  监听录音暂停事件

• RecorderManager.onStop(function callback)
  监听录音结束事件

• RecorderManager.onFrameRecorded(function callback)
  监听已录制完指定帧大小的文件事件。如果设置了 frameSize，则会回调此事件。

• RecorderManager.onError(function callback)
  监听录音错误事件

• RecorderManager.onInterruptionBegin(function callback)
  监听录音因为受到系统占用而被中断开始事件。pause 事件在此事件后触发​

• RecorderManager.onInterruptionEnd(function callback)
  监听录音中断结束事件。在收到 interruptionBegin 事件之后，小程序内所有录音会暂停，收到此事件之后才可再次录音成功。

相机

createCameraContext

createCameraContext()

创建 camera 上下文 CameraContext 对象。

返回值

CameraContext

富文本

EditorContext.blur

EditorContext.blur(Object object)

编辑器失焦，同时收起键盘。

参数

Object object

EditorContext.clear

EditorContext.clear(Object object)

清空编辑器内容

参数

Object object

EditorContext.format

EditorContext.format(string name, string value)

修改样式

参数

string name

属性

string value

值

支持设置的样式列表

对已经应用样式的选区设置会取消样式。css style 表示 css 中规定的允许值。

EditorContext.getContents

EditorContext.getContents(Object object)

获取编辑器内容

参数

Object object

object.success 回调函数

参数

Object res

EditorContext.getSelectionText

EditorContext.getSelectionText(Object object)

获取编辑器已选区域内的纯文本内容。当编辑器失焦或未选中一段区间时，返回内容为空。

参数

Object object

object.success 回调函数

参数

Object res

EditorContext.insertDivider

EditorContext.insertDivider(Object object)

参数

Object object

EditorContext.insertImage

EditorContext.insertImage(Object object)

插入图片。

地址为临时文件时，获取的编辑器html格式内容中 <img> 标签增加属性 data-local，delta 格式内容中图片 attributes 属性增加 data-local 字段，该值为传入的临时文件地址。

开发者可选择在提交阶段上传图片到服务器，获取到网络地址后进行替换。替换时对于html内容应替换掉 <img> 的 src 值，对于 delta 内容应替换掉 insert { image: abc } 值。

参数

Object object

示例代码

this.editorCtx.insertImage({
  src: 'xx',
  width: '100px',
  height: '50px',
  extClass: className
})

EditorContext.insertText

EditorContext.insertText(Object object)

覆盖当前选区，设置一段文本

参数

Object object

EditorContext.redo

EditorContext.redo(Object object)

恢复

参数

Object object

EditorContext.removeFormat

EditorContext.removeFormat(Object object)

清除当前选区的样式

参数

Object object

EditorContext.scrollIntoView

EditorContext.scrollIntoView()

使得编辑器光标处滚动到窗口可视区域内。

EditorContext.setContents

EditorContext.setContents(Object object)

初始化编辑器内容，html和delta同时存在时仅delta生效

参数

Object object

EditorContext.undo

EditorContext.undo(Object object)

参数

Object object