qq_music_aum 技术文档
1. 安装指南
1.1 下载插件
首先,访问 Releases 页面,下载最新的插件压缩包 zip
文件。下载完成后,解压该文件,得到 aum
文件。
1.2 安装插件
- 打开群晖的 Audio Station 应用。
- 进入
设置
菜单,然后选择歌词插件
。 - 点击
新增
按钮,浏览并选择刚刚解压得到的aum
文件。 - 完成文件选择后,点击确认进行安装。
- 安装完成后,勾选该插件以启用它。
1.3 版本说明
- v1.8 及之前版本:由于官方接口的调整,这些版本可能无法正常工作。
- v1.9 版本:使用快速搜索接口,结果较少。
- v1.10+ 版本:搜索结果与过去版本一致,建议使用此版本。
2. 项目的使用说明
2.1 功能概述
qq_music_aum
是一个用于群晖 Audio Station 的歌词插件,歌词内容来源于 QQ 音乐。该插件能够自动查找并显示歌词,如果歌词存在翻译,还会自动拼接翻译内容。
2.2 使用场景
- 音乐播放:在播放音乐时,自动显示歌词。
- 歌词翻译:如果歌词有翻译,会自动显示翻译内容。
2.3 注意事项
- 由于 QQ 音乐接口的调整,建议使用
v1.9
及之后的版本。 v1.9
版本使用快速搜索接口,结果较少;v1.10+
版本搜索结果与过去版本一致。
3. 项目API使用文档
3.1 API 概述
qq_music_aum
插件通过调用 QQ 音乐的 API 来获取歌词数据。以下是主要的 API 调用方式:
3.2 API 调用示例
# 示例代码,实际使用时需根据具体版本和接口进行调整
def get_lyrics(song_id):
# 调用 QQ 音乐 API 获取歌词
response = requests.get(f"https://y.qq.com/lyric/{song_id}")
if response.status_code == 200:
return response.json()
else:
return None
3.3 API 返回数据格式
API 返回的歌词数据通常为 JSON 格式,包含歌词内容和翻译(如果有)。
4. 项目安装方式
4.1 手动安装
- 下载插件压缩包并解压。
- 打开 Audio Station,进入
设置
→歌词插件
。 - 点击
新增
按钮,选择解压后的aum
文件进行安装。 - 安装完成后,勾选插件以启用。
4.2 自动更新
目前插件不支持自动更新,建议定期检查 Releases 页面,下载并安装最新版本。
5. 相关项目
- LudySu/Synology-LrcPlugin:部分代码来源于此项目,使用 Apache-2.0 许可证。
- 其他歌词插件:
通过以上步骤,您可以顺利安装并使用 qq_music_aum
插件,享受 QQ 音乐提供的歌词服务。