使用

Rust 函数库

可以参考 engine-demo 的用法～

首先，您需要从 https://crates.io 引用至少三个组件：

• unm_engine：包含并行查询音源结果的 Executor。
• unm_engine_[想要的引擎]：用于从音源搜索的引擎。
• unm_types：UNM 的基础类型。编写函数时非常需要。

然后，我们可以注册音源：

use unm_engine::executor::Executor;
use unm_engine_bilibili::{BilibiliEngine, ENGINE_ID as BILIBILI_ENGINE_ID};

let mut executor = Executor::new();
executor.register(BILIBILI_ENGINE_ID, BilibiliEngine::new());

// 您也可以直接使用官方預設的引擎集，免去手動註冊的麻煩。
// 首先得引入 `unm_api_utils`，然後就可以：

use unm_api_utils::executor::build_full_executor;
let executor = build_full_executor();

接着就可以直接使用 executor 提供的方法搜索及取回结果了：

use unm_types::{Song, Artist, Context};

let context = Context::default();

let search_result = executor.search(&[BILIBILI_ENGINE_ID], Song {
  id: "".to_string(),
  name: "TT",
  artists: vec![
    Artist {
      id: "".to_string(),
      name: "Twice",
    },
  ],
}, &context).await?;

let result = executor.retrieve(&search_result, &context).await?;

TypeScript (JS) 库

请参考 napi 的 README.md。

RESTful API

请参考 UNM REST API 的 README.md

设置

支持的所有引擎

N-API 和 RESTful API 支持的引擎（以下简称「默认引擎集」）与我们上架到 https://crates.io 的引擎略有不同。

• migu 的 API 坏掉了。等到有更好的 API 会再更新。

引擎文件

• JOOX 引擎：https://docs.rs/unm_engine_joox
• YtDl 引擎：https://docs.rs/unm_engine_ytdl
• QQ 引擎：https://docs.rs/unm_engine_qq

设置全局通用设置（Context）

全局通用设置（Context）包含以下这些设置：

• proxy_uri：要在引擎使用的代理服务器。选填。
• enable_flac：是否抓取 FLAC 音频？默认值是 false。
• search_mode：搜索模式
  • 可以设置是以「速度为主」（FastFirst）或者是以「顺序为主」（OrderFirst）进行搜索
  • 示例请见 https://docs.rs/unm_types/0.2.0-pre.4/unm_types/enum.SearchMode.html
• config：各引擎设置，见下〈设置引擎特定设置（Config）〉

如果您使用 Rust 版，您可以使用 ContextBuilder 构建 Context：

use unm_types::{ContextBuilder, SearchMode};

let context = ContextBuilder::default()
  .proxy_uri("https://www.google.com")
  .search_mode(SearchMode::OrderFirst)
  .build();

如果是使用 JavaScript 版，您可以根据 UNM 的类型定义（VS Code 会提供补全建议） 构建 Object 即可：

const UNM = require("@unblockneteasemusic/rust-napi");

// TS 的語法是 `const context: UNM.Context = {}`
/** @type {UNM.Context} */
const context = {
  proxyUri: "https://www.google.com",
  searchMode: UNM.SearchMode.OrderFirst,
};

设置引擎特定设置（Config）

「引擎特定设置」是每个引擎针对自己的需要，从 Config 取得需要的设置。设置方法请见 engines/README.md

贡献

检查程序的相关命令

cargo check  # 檢查程式碼是否合法 (valid)
cargo test   # 執行本 codebase 的所有 Tests
cargo clippy # Rust linter

UNM (Rust) 的 CI 也会在程序 push 后自动执行上述命令，进行程序测试与检查。

贡献引擎后的建议事项

引擎的 crate 名称格式是：unm_engine_[引擎名称]，放置在 /engines/[引擎名称] 目录。

建议仿照其他引擎，在 engine-demo 和 napi 注册自己的音源。注册音源有 macro 协助，语法目前是这样的：

push_engine!([引擎名稱]: [引擎實體]);

例如：

push_engine!(bilibili: BilibiliEngine);

授权条款

This project is licensed under LGPL-3.0-only.