audioCover

来自于:官方立即使用

set update cancel

概述

audioCover 封装了设置音乐播放锁屏界面的相关接口。当音乐播放时切换到后台(音频后台播放功能需要在 config.xml 文件里进行相关配置,详情参考 config 文件配置文档)锁屏后,再次点击开屏键,当前屏幕会显示一个音乐播放器页面,该界面中有播放器的控制按钮,可点击按钮和用户播放器进行交互。通过本模块可以对该页面进行相关功能的自定义设置。在 iOS 平台上,必须保证有音频在后台播放,本模块设置的锁屏界面才会显示。另外,需要注意先调用本模块的set接口后,再去播放音乐

audioCover - 图1

set

设置锁屏音乐播放页面

set({params}, callback(ret, err))

params

totalTime:

  • 类型: 数字
  • 描述: 播放的音频的总时长(单位:秒)

progress:

  • 类型: 数字
  • 描述: 音频播放位置,当前播放位置占整个音频长度的百分比

currentTime:

  • 类型:数字类型
  • 描述:(可选项)当前时间进度(单位:秒),若不传则使用progress参数,传了优先级高于progress参数

cover:

  • 类型: 字符串
  • 描述:(可选项)专辑图片路径,要求本地路径(fs://、widget://)

defaultCover:

  • 类型: 字符串
  • 描述:(可选项)默认专辑图片路径,要求本地路径(fs://、widget://)

volume:

  • 类型: 数字
  • 描述:(可选项)音量大小,取值范围:0-100
  • 默认值:当前系统音量

audio:

  • 类型: 字符串
  • 描述: (可选项)音频名称
  • 默认值:未知

author:

  • 类型: 字符串
  • 描述:(可选项)音频作者名称
  • 默认值:未知

lyrics:

  • 类型: JSON 对象
  • 描述:(可选项)显示歌词设置
  • 内部字段:
  1. {
  2. path: 'widget://res/firework.lrc', //(可选项)字符串类型;歌词文件路径,要求本地文件(fs://、widget://),不传则不显示歌词
  3. size: 14, //(可选项)数字类型;歌词字体大小;默认:14
  4. color: '#fff' //(可选项)字符串类型;歌词颜色,支持#,rgb,rgba;默认:"#fff"
  5. }

showTotalTime:

  • 类型:布尔类型
  • 描述:进度条右边是否显示总时长(仅支持 Android)
  • 默认:false(默认显示当前剩余时长)

fixedOn:

  • 类型: 字符串
  • 描述:本模块所依附的 window 或 frame 的名字,在 iOS 平台上,该 window 或 frame 必须始终在可视区域的最上层,否则锁屏效果将会失效
  • 默认值:当前主 window

callBack(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. eventType: 'play', //字符串类型;交互事件类型,取值范围如下:
  3. //play(播放)
  4. //pause(暂停)
  5. //next(下一首)
  6. //previous(上一首)
  7. }

示例代码

  1. var audioCover = api.require('audioCover');
  2. audioCover.set({
  3. audio: '歌曲名',
  4. author: '作者'
  5. }, function(ret, err) {
  6. if (ret) {
  7. alert(JSON.stringify(ret));
  8. } else {
  9. alert(JSON.stringify(err));
  10. }
  11. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

update

更新锁屏播放界面播放进度条

update({params})

params

progress:

  • 类型: 数字
  • 描述: 音频播放位置,当前播放位置占整个音频长度的百分比

currentTime:

  • 类型:数字类型
  • 描述:(可选项)当前时间进度(单位:秒),若不传则使用progress参数

示例代码

  1. var audioCover = api.require('audioCover');
  2. audioCover.update({
  3. progress: 60
  4. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

cancel

取消锁屏音乐播放页面

cancel(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status: true //布尔类型;
  3. }

示例代码

  1. var audioCover = api.require('audioCover');
  2. audioCover.cancel(function( ret, err ){
  3. if( ret.status ){
  4. alert( JSON.stringify( ret ) );
  5. }else{
  6. alert( JSON.stringify( err ) );
  7. }
  8. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本