API

version 静态

  • 类型string
  • 描述:只读属性,返回 APlayer 的版本号
  • 用法
import { APlayer } from '@moefe/vue-aplayer';

console.log(APlayer.version);

media 实例

  • 类型APlayer.Media
  • 描述:只读的原生 Media 对象
  • 用法
const { media } = this.$refs.aplayer;

console.log(media.currentTime); // 获取音频当前播放时间
console.log(media.duration); // 获取音频总时间
console.log(media.paused); // 获取音频是否暂停

currentMusic 实例

警告

如果你想切换到播放列表中的其他音频请使用 switch 方法,而不要直接设置它

  • 类型APlayer.Audio
  • 描述:获取当前正在播放的音频
  • 用法
console.log(this.$refs.aplayer.currentMusic);

play() 实例

  • 类型Function
  • 返回值Promise<void>
  • 描述:播放音频
  • 用法
this.$refs.aplayer.play();

pause() 实例

  • 类型Function
  • 返回值void
  • 描述:暂停音频
  • 用法
this.$refs.aplayer.pause();

toggle() 实例

  • 类型Function
  • 返回值void
  • 描述:切换播放和暂停
  • 用法
this.$refs.aplayer.toggle();

seek() 实例

  • 类型Function
  • 参数
    • time
      • 类型number
      • 描述:时间(秒)
  • 返回值void
  • 描述:跳到特定时间
  • 用法
this.$refs.aplayer.seek(100);

switch() 实例

  • 类型Function
  • 参数
    • audio
      • 类型number | string
      • 描述:音频索引或音频的部分名称
  • 返回值void
  • 描述:切换到播放列表中的其他音频
  • 用法
this.$refs.aplayer.switch(1); // 切换到播放列表中的第二首歌
this.$refs.aplayer.switch('东西'); // 切换到播放列表中歌曲名包含“东西”的第一首歌

skipBack() 实例

  • 类型Function
  • 返回值void
  • 描述:切换到上一首音频
  • 用法
this.$refs.aplayer.skipBack();

skipForward() 实例

  • 类型Function
  • 返回值void
  • 描述:切换到下一首音频
  • 用法
this.$refs.aplayer.skipForward();

showNotice() 实例

  • 类型Function
  • 参数
    • text
      • 类型string
      • 描述:通知文本
    • time
      • 类型number?
      • 默认值:2000
      • 描述:显示时间(毫秒)
    • opacity
      • 类型number?
      • 默认值:0.8
      • 描述:通知透明度 (0 ~ 1)
  • 返回值Promise<void>
  • 描述:显示通知,设置时间为 0 可以取消通知自动隐藏
  • 用法
this.$refs.aplayer.showNotice('喵喵喵');

showLrc() 实例

  • 类型Function
  • 返回值void
  • 描述:显示歌词
  • 用法
this.$refs.aplayer.showLrc();

hideLrc() 实例

  • 类型Function
  • 返回值void
  • 描述:隐藏歌词
  • 用法
this.$refs.aplayer.hideLrc();

toggleLrc() 实例

  • 类型Function
  • 返回值void
  • 描述:显示/隐藏歌词
  • 用法
this.$refs.aplayer.toggleLrc();

showList() 实例

  • 类型Function
  • 返回值void
  • 描述:显示播放列表
  • 用法
this.$refs.aplayer.showList();

hideList() 实例

  • 类型Function
  • 返回值void
  • 描述:隐藏播放列表
  • 用法
this.$refs.aplayer.hideList();

toggleList() 实例

  • 类型Function
  • 返回值void
  • 描述:显示/隐藏播放列表
  • 用法
this.$refs.aplayer.toggleList();