# @distube/soundcloud 中文文档

规范地址：https://npmcn.com/package/%40distube/soundcloud/

版本：2\.0\.4
npm 元数据更新时间：2024-10-27T14:28:20.743Z
中文译文更新时间：2026-11-12T12:21:37.367Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40distube/soundcloud
原文对照：https://npmcn.com/package/%40distube/soundcloud/?lang=original
项目主页：https://github.com/distubejs/extractor-plugins/tree/main/packages/soundcloud#readme
源码仓库：https://github.com/distubejs/extractor-plugins

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：44.5 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：distube 5
- 首次发布：2021-05-25T15:21:27.527Z
- 最新版本发布：2024-10-27T14:28:18.445Z
- 近 30 天下载量：3558（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 0 个）

## 中文简介

用于支持 SoundCloud 的 DisTube 提取器插件 .

## 安装

```sh
npm install @distube/soundcloud
```

也可以使用：`pnpm add @distube/soundcloud`、`yarn add @distube/soundcloud`、`bun add @distube/soundcloud`

## README

[![](https://nodei.co/npm/@distube/soundcloud.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/@distube/soundcloud)

![npm peer dependency version](https://img.shields.io/npm/dependency-version/@distube/soundcloud/peer/distube?style=flat-square) ![npm](https://img.shields.io/npm/dt/@distube/soundcloud?logo=npm&style=flat-square) ![GitHub Repo stars](https://img.shields.io/github/stars/distubejs/extractor-plugins?logo=github&logoColor=white&style=flat-square) [![Discord](https://img.shields.io/discord/732254550689316914?logo=discord&logoColor=white&style=flat-square)](https://discord.gg/feaDd9h)

[![Buy Me a Coffee at ko-fi.com](https://storage.ko-fi.com/cdn/kofi3.png)](https://ko-fi.com/skick)

# @distube/声音云

用于支持 SoundCloud 的 DisTube 提取器插件 .

## 特性

-   使用声云 API
-   支持 SoundCloud 音轨、相册和播放列表
-   在 SoundCloud 上搜索音轨/播放列表
-   从 SoundCloud 直接播放音轨

## 安装

```sh
npm install @distube/soundcloud@latest
```

## 使用量

### 插件

```ts
import { Client } from "discord.js";
import { DisTube } from "distube";
import { SoundCloudPlugin } from "@distube/soundcloud";

const client = new Client();

const distube = new DisTube(client, {
  plugins: [new SoundCloudPlugin()],
});
```

### 搜索

```ts
const scPlugin = new SoundCloudPlugin();
scPlugin.search("A SoundCloud Playlist", "playlist", 3);
```

## 文档

### 新的声音Cloud Plugin( \[声音CloudPlugin 选项\])

-   `SoundCloudPluginOptions.clientId` \[弦\] _(可选)_:你的账户的客户身份.
-   `SoundCloudPluginOptions.oauthToken` \[弦\] _(可选)_:你的账户是Oauth代币. 曾用 SoundCloud Go+ 账户获取更多数据.
-   如何获得 `clientId` 财务报告和审定财务报表 `oauthToken`? 吗? [看这里](https://github.com/Tenpi/soundcloud.ts#getting-started)

#### 示例

```js
new SoundCloudPlugin({
  clientId: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  oauthToken: "0-000000-000000000-xxxxxxxxxxxxxx",
});
```

### 声音 CloudPlugin# search( 清, \[类型\], \[限制\])

搜索 SoundCloud 上的指定查询 .

-   参数
    
    -   `query` \[字符串\]搜索查询.
    -   `type` \[弦\]:结果类型(`track` 或者说 `playlist`) (中文(简体) ). 默认是 `track`。 。 。 .
    -   `limit` \[整数\]:限制结果. 默认是 `10`。 。 。 .
-   回返a `Promise<Song[]|Playlist[]>`
    
    -   回返a `Promise<Song[]>` 若为 `type` 参数是: `track`
    -   回返a `Promise<Playlist[]>` 若为 `type` 参数是: `playlist`

## 常见问题

### @distube/soundcloud 是什么？

用于支持 SoundCloud 的 DisTube 提取器插件 \.

### 如何安装 @distube/soundcloud？

在项目目录运行 npm install @distube/soundcloud，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：distube（5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @distube/soundcloud 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @distube/soundcloud 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @distube/soundcloud 可以商用吗？

@distube/soundcloud 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @distube/soundcloud 的下载量有多少？

根据 npm 官方下载统计，@distube/soundcloud 在 2026/10/13 – 2026/11/11 这 30 天内被下载 3,558 次，日均约 119 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @distube/soundcloud 还在维护吗？

最新版本 2\.0\.4 发布于 2024/10/27（2 年前）；至今共发布 22 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/05/25。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。