简介

MusicFree是一个无广告，开源的音乐播放器，支持 Windows，Android 和 Harmony OS。

移动端项目地址：  MusicFree

电脑端项目地址：   MusicFree

移动端使用

软件刚安装完成是无法找到任何音乐可以播放，需要通过在软件中添加插件来添加音乐源和字幕源。

目前推荐使用的插件源有两个：

（注意：如果是使用第三方下载的插件，那么请自行鉴别插件的安全性）

电脑端使用

和移动端类似需要先设置好插件。

有趣的是电脑端可以下载不同的主题美化。

插件开发

插件本质上是一个满足插件协议的 commonjs 模块。插件中定义了搜索（音乐、专辑、作者）、播放、查看专辑、作者详细信息、导入歌单、获取歌词等基本函数，插件的开发者只需要关心输入输出逻辑，至于分页、缓存等全都交给 MusicFree 控制即可。

引用文档图片：

前置知识

• javascript / typescript (ES7 语法)
• js 模块化规范 (common.js)
• 包管理工具 npm，以及如何使用 npm 包
• 构建工具（webpack、parcel，可选）
• JSBridge（可选）

插件配置分为两类

1. 说明插件的信息（插件名和版本）
2. 软件在不同时期调用的函数（如获取音源对应的 getMediaSource 函数 || 搜索对应的 search 函数）

一个简单的插件结构如下：

module.exports = {
  /** 用来说明插件信息的属性 */
  platform: "MusicFree 插件", // 插件名
  version: "0.0.0", // 插件版本号

  /** 供给软件在合适的时机调用的函数 */
  getMediaSource: function (musicItem) {
    // 根据该音源的某个音乐获取真实的播放地址
    return {
      url: "https://", // 音源 URL
    };
  },
};

插件加载流程

MusicFree 软件启动的时候会去特定的文件夹下搜索 js 文件，并加载到程序中。（移动端的大概率位置为：Android/data/{包名}/files/plugins）

更加具体的文档请查看： MusicFree文档