1
0
mirror of https://github.com/hanxi/xiaomusic.git synced 2026-04-04 11:45:14 +08:00

Auto-Generate docs 🤖

This commit is contained in:
Issues Docs [BOT]
2026-03-25 02:52:25 +00:00
parent 7a4a3a51cb
commit b751b0c127

View File

@@ -1,12 +1,36 @@
---
title: 在线搜索扩展说明文档
title: 在线搜索说明文档
---
# 在线搜索扩展说明文档
> **⚠️ 重要升级提示**
> 本次更新涉及到配置文件结构更新,旧版配置可能不适用。请务必手动删除 **`/conf/plugins-config.json`** 后重启,重新在网页端进行配置。
# 在线搜索说明文档
## 📅 版本说明
### 🔸 V1.1.2 (当前版本)
**主要更新内容:**
1. **增加接口测试**LX Server 配置页新增接口连通性测试功能,方便用户快速排查地址配置问题。
2. **增加歌词查询**:支持通过 LX Server 接口查询并显示歌词信息。
3. **增加密码校验**:设置界面新增密码校验功能(若未配置密码则不启用此校验),增强配置安全性。
---
### 🔹 V1.1.1
**更新概述:**
本版本重构了底层架构,引入了双接口生态支持,并优化了搜索与播放体验。
**主要更新内容:**
1. **双接口生态架构**
- 配置界面支持 **MusicFree 插件版****LX Server 接口版** 两种模式,用户可二选一切换。
- 新增 **LX Server 适配**,支持通过配置 API 地址接入洛雪音乐生态。
2. **配置结构变更**
- *注意*:本次更新涉及配置文件结构变化。旧版用户需手动删除 `/conf/plugins-config.json` 文件,重启服务后在网页端重新配置即可生效。
3. **功能优化**
- **歌曲追加**:优化自动追加逻辑,支持翻页追加同歌手歌曲,实现无限连播(默认开启)。
- **搜索体验**:优化前端展示,支持服务端分页查询。
- **AI 集成**:新增 **AI 智能口令提取** 功能配置(位于高级设置),支持模糊指令解析。
---
# 📘 功能说明书
## 1. 功能概述
在线搜索扩展是 `xiaomusic` 的扩展功能,旨在提供在线音乐搜索与播放功能。用户可通过网页端搜索来自多个音乐平台的资源,并灵活选择**推送至小爱音箱**或**网页端在线播放**。
@@ -34,12 +58,13 @@ title: 在线搜索扩展说明文档
### 🅱️ 生态二LX Server 接口版
**核心机制**:基于开源的 LX Sync Server 项目<https://xcq0607.github.io/lxserver/>,通过配置服务器地址接入。
**核心机制**:基于开源的 LX Sync Server 项目,通过配置服务器地址接入。
**主要特点**
- **配置简便**:只需填写有效的接口地址(如 `http://127.0.0.1:9527/api`
- **聚合搜索**:支持在后台配置支持搜索的音乐平台列表,聚合平台结果
- **稳定高效**:由服务端统一维护接口逻辑,无需管理单个插件
- **新功能 (V1.1.2)**:支持接口测试与歌词查询
**适用场景**洛雪生态且已部署LX Sync Server相关服务
@@ -69,8 +94,6 @@ title: 在线搜索扩展说明文档
> **前置配置**:需在后台【允许唤醒的命令】选项中添加:`,singer_play,online_play,`
<img width="509" height="102" alt="Image" src="https://gproxy.hanxi.cc/proxy/user-attachments/assets/aff9a971-0f88-4ff4-8042-63cef51478b1" />
**在线播放指定歌曲**
- **指令格式**`在线播放 + 关键词`
- **示例**`在线播放 林俊杰 江南 `` 在线播放 陈奕迅`
@@ -99,7 +122,7 @@ title: 在线搜索扩展说明文档
- **切换逻辑**
- 用户可点击切换 `MusicFree``LX Server`
- 切换时系统会弹出确认提示,因为不同生态的配置项(插件列表 vs 平台列表)互不兼容
- **生效规则**保存后,搜索功能将立即使用新选定的生态逻辑
- **生效规则**切换后,搜索功能将立即使用新选定的生态逻辑
### 5.2 详细配置项
@@ -110,6 +133,7 @@ title: 在线搜索扩展说明文档
**若选择 LX Server 接口版:**
- **地址配置**:输入有效的 API 地址,系统自动校验格式
- **接口测试 (V1.1.2)**:点击测试按钮验证地址连通性
- **平台管理**:管理支持搜索的音乐平台,支持添加或删除平台配置,实现聚合搜索
### 5.3 高级设置
@@ -118,18 +142,21 @@ title: 在线搜索扩展说明文档
- **AI 大模型配置**
- 输入框接口地址、API Key、模型名称
- 说明:非必须功能,追求极致搜索体验的用户建议配置
- **安全设置 (V1.1.2)**
- 密码校验:可设置访问密码,保护配置界面安全
---
## 6. 常见问题与提示
## 6. 常见问题
- **设备绑定**:使用推送功能前,务必在系统首页完成小爱音箱的设备绑定
- **密码校验**:密码校验功能默认未开启,如需开启请在`conf/plugins-config.json`下设置校验密码!
- **资源兼容性**MusicFree 部分插件如B站源获取的音频流可能不被小爱音箱支持此类资源建议使用**网页端播放**
- **优先级逻辑**
- 选定 **LX Server** 时:只调用 LX Server 接口
- 选定 **MusicFree** 时:调用已启用且排序靠前的 MusicFree 插件
- **语音命令配置**:自定义语音口令生效前,请检查【允许唤醒的命令】列表中是否包含 `singer_play``online_play`
<img width="509" height="102" alt="Image" src="https://gproxy.hanxi.cc/proxy/user-attachments/assets/aff9a971-0f88-4ff4-8042-63cef51478b1" />
## 评论
### 评论 1 - hanxi