npm 包 musicbottoppp 使用教程

阅读时长 7 分钟读完

musicbottoppp 是一个可以让网站或者博客自动播放音乐的 npm 包。它支持多平台的音乐源,如网易云音乐,QQ 音乐等,并提供了一些定制化的配置选项,如动画效果、默认音乐等。下面是一个详细的使用教程。

安装

在终端中打开你的项目目录,使用以下命令来安装 musicbottoppp:

如果你使用的是 yarn 包管理器,也可以使用以下命令安装:

引入

在需要使用的文件中引入 musicbottoppp:

初始化

在需要播放音乐的地方,初始化 MusicBottoppp 实例。你需要传入一个事件对象(event object)以及播放列表(playlist)。

事件

musicbottoppp 目前支持三种事件:播放(play)、暂停(pause)和下一首(next)。你可以在初始化实例时设置对应的回调函数。

-- -------------------- ---- -------
----- ------------- - --- ---------------
  ------- -------- -- -
    ------------------ -- ---------
  --
  -------- -------- -- -
    ------------------ -- --------
  --
  ------- -------- -- -
    ----------------- ----- -- ---------
  --
--

播放列表

播放列表需要是包含音乐信息的对象数组。每个对象应该包含以下属性:

  • name 歌曲名称;
  • artist 歌曲作者;
  • audio 音频资源地址;
  • cover 封面资源地址;
  • lrc 歌词资源地址。
-- -------------------- ---- -------
----- -------- - -
  -
    ----- ------
    ------- ---------
    ------ --------------------------------------------------------------
    ------ ---------------------------------------------------------------------------
    ---- ----------------------------------------------------------------------
  --
  -
    ----- -----
    ------- ------
    ------ -----------------------------------------------------------
    ------ ---------------------------------------------------------------------------
    ---- -------------------------------------------------------------------
  --
-

----- ------------- - --- ---------------
  ------- -------- -- -
    ------------------ -- ---------
  --
  --------- ---------
--

定制化配置

除了基本的初始化配置,musicbottoppp 还提供了一些适用于不同场景的配置。以下是一些较为常用的配置项。

循环方式

你可以通过 loop 配置循环方式。支持三种方式:

  • 单曲循环(’single’);
  • 列表循环(’list’);
  • 随机播放(’random’)。

自动播放

autoplay 用于设置是否自动播放,默认值为 false

默认音乐

musicIndex 用于设置默认播放的音乐索引,默认值为 0

总结

通过本文的介绍,你学习了如何使用 npm 包 musicbottoppp。它可以帮助你在网站或者博客中自动播放音乐。你学习了如何安装、引入、初始化、以及一些适用于不同场景的配置项。希望本文对你有所帮助。错误和建议,请随时指出。

示例代码

-- -------------------- ---- -------
------ ------------- ---- ---------------

----- -------- - -
  -
    ----- ------
    ------- ---------
    ------ --------------------------------------------------------------
    ------ ---------------------------------------------------------------------------
    ---- ----------------------------------------------------------------------
  --
  -
    ----- -----
    ------- ------
    ------ -----------------------------------------------------------
    ------ ---------------------------------------------------------------------------
    ---- -------------------------------------------------------------------
  --
  -
    ----- ---------
    ------- ------
    ------ --------------------------------------------------------------
    ------ ---------------------------------------------------------------------------
    ---- ----------------------------------------------------------------------
  --
  -
    ----- --------
    ------- -------
    ------ --------------------------------------------------------------
    ------ ---------------------------------------------------------------------------
    ---- ----------------------------------------------------------------------
  --
-

----- ------------- - --- ---------------
  ----- ---------
  --------- -----
  ----------- --
  ------- -------- -- -
    ------------------ -- ---------
  --
  -------- -------- -- -
    ------------------ -- --------
  --
  ------- -------- -- -
    ----------------- ----- -- ---------
  --
  --------- ---------
--

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60056cd181e8991b448e6605

纠错
反馈