XiaoMusic 技术文档

XiaoMusic 技术文档

xiaomusic 使用小爱同学播放音乐，音乐使用 yt-dlp 下载。 项目地址: https://gitcode.com/gh_mirrors/xia/xiaomusic

小爱音箱音乐播放系统(XiaoMusic)允许用户通过小爱音箱播放来自网络的音乐，尤其是利用yt-dlp下载资源。本文档旨在提供全面的指南，帮助用户安装、配置以及理解XiaoMusic的各项功能。

安装指南

通过Docker安装

1. 基础配置: 首先确保您的系统已安装Docker。接着，您可以直接运行以下命令来快速启动XiaoMusic，此命令将使用默认配置运行，并将音乐数据存储在本地的./music目录下。

   docker run -d -p 8090:8090 \
       -v $(pwd)/music:/app/music hanxi/xiaomusic
   

2. 个性化配置: 若要修改默认端口或其他环境变量，例如使用特定的小米账号和密码，使用以下命令模板：

   docker run -d -p 8090:8090 \
       -v $(pwd)/music:/app/music \
       -e MI_USER='your_xiaomi_username' \
       -e MI_PASS='your_xiaomi_password' \
       hanxi/xiaomusic
   

使用pip安装

如果您偏好在本地环境中运行，可以通过pip安装XiaoMusic。

1. 更新pip并安装XiaoMusic：

   pip install -U xiaomusic
   

2. 运行XiaoMusic，可以指定配置文件路径来定制行为：

   xiaomusic --config path/to/your/config.json
   

开发环境搭建

开发者可以通过以下步骤进行环境配置和项目运行：

1. 下载依赖: 运行提供的脚本安装必要的依赖。

2. 安装PDM: 确保安装了PDM作为包管理器。

3. 配置环境变量，参照xiaogpt项目的设置。

4. 启动服务:

   pdm run xiaomusic.py
   

项目使用说明

• 启动后, 访问 <ip>:8090 （替换<ip>为实际服务器地址），您可以通过网页界面进行详细配置。
• 口令控制：支持多种语音指令控制音乐播放，如播放特定歌曲、切换下一首等。
• 网络歌单：支持配置网络上的歌单，使得播放列表更加丰富多样。

API使用文档

虽然本文档未深入细节描述API，但XiaoMusic提供了基于Web的控制界面。对于开发者，接口文档可通过访问 http://localhost:8090/docs 来探索。这里通常包含了添加歌曲、管理播放列表等操作的API文档。

高级配置与优化

XiaoMusic允许通过环境变量进行高级配置，如调整搜索源(XIAOMUSIC_SEARCH)、使用代理(XIAOMUSIC_PROXY)以及设置音乐下载目录等。详细配置项见GitHub仓库的相关议题讨论。

请注意安全设置，特别是在启用公网访问时需设置复杂密码，避免潜在的风险。

结语

XiaoMusic项目为小爱音箱用户带来了全新的体验，使音箱能够播放更广泛来源的音乐。本技术文档仅为入门指导，更多高级特性和定制选项等待您的挖掘。通过不断探索和配置，您可以充分释放XiaoMusic的功能，享受个性化的音频娱乐。

xiaomusic 使用小爱同学播放音乐，音乐使用 yt-dlp 下载。 项目地址: https://gitcode.com/gh_mirrors/xia/xiaomusic