From bcb3c09a0a5aa8585130c32aa061be0f6873674b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=8C=AB=E5=A4=B4=E7=8C=AB?= Date: Sun, 21 Jan 2024 22:25:42 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E6=AD=8C=E8=AF=8D=E7=BF=BB=E8=AF=91?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/plugin/protocol.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/plugin/protocol.md b/docs/plugin/protocol.md index 653b29f..005d2b1 100644 --- a/docs/plugin/protocol.md +++ b/docs/plugin/protocol.md @@ -652,8 +652,8 @@ module.exports = { ```javascript interface ILyricSource { - lrc?: string; // 歌词文件的链接 rawLrc?: string; // 文本格式的歌词 + translation?: string; // 文本格式的翻译 } // 获取歌词函数签名 @@ -677,10 +677,9 @@ type getLyric = (musicItem: IMusicItem) => Promise; 返回值是个 `Promise` 对象,其内容键值类型如下: | 键名 | 类型 | 说明 | | :-------------: | :-----------: | :---- | -| `lrc` | `string` | 歌词文件的链接 URL | | `rawLrc`| `string` | 带时间戳的文本格式的歌词文件,如 `[00:00.00] 第一句歌词`。 | +| `translation`| `string` | 带时间戳的文本格式的翻译文件,如 `[00:00.00] 第一句歌词`。 | -如果同时返回 `lrc` 和 `rawLrc`,会优先使用 `rawLrc` 字段。 ::: details 🌰 举个例子: 根据音乐获取歌词: @@ -691,8 +690,8 @@ module.exports = { async getLyric(musicItem) { return { - lrc: "http://xxx.lrc", // 链接 - rawLrc: "[00:00.00] 第一句歌词", // 文本格式的歌词 + rawLrc: "[00:00.00] First Lyric", // 文本格式的歌词 + translation: "[00:00.00] 第一句歌词", // 文本格式的歌词 }; }, };