# @diffusionstudio/vits-web 中文文档

规范地址：https://npmcn.com/package/%40diffusionstudio/vits-web/

版本：1\.0\.3
npm 元数据更新时间：2024-09-09T07:52:20.364Z
中文译文更新时间：2026-11-12T07:50:57.654Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40diffusionstudio/vits-web
原文对照：https://npmcn.com/package/%40diffusionstudio/vits-web/?lang=original
项目主页：https://huggingface.co/spaces/diffusionstudio/vits-web
源码仓库：https://github.com/diffusionstudio/vits-web

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

- 包体积（解压后）：155 kB，14 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2024-07-06T13:55:20.588Z
- 最新版本发布：2024-09-09T07:52:20.165Z
- 近 30 天下载量：26295（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

在浏览器中使用基于 VITS 的模型的 Web api !

## 安装

```sh
npm install @diffusionstudio/vits-web
```

也可以使用：`pnpm add @diffusionstudio/vits-web`、`yarn add @diffusionstudio/vits-web`、`bun add @diffusionstudio/vits-web`

## README

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/diffusion-studio/ffmpeg-js/graphs/commit-activity) [![Website shields.io](https://img.shields.io/website-up-down-green-red/http/shields.io.svg)](https://diffusion.studio/) [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/n3mpzfejAb) [![GitHub license](https://badgen.net/github/license/Naereen/Strapdown.js)](https://github.com/diffusion-studio/ffmpeg-js/blob/main/LICENSE) [![TypeScript](https://badgen.net/badge/icon/typescript?icon=typescript&label)](https://typescriptlang.org/)

# 运行基于 VITS 的文本到语音在浏览器中 [ONNX 运行时间](https://onnxruntime.ai/)

一个大喊大叫去 [拉斯皮尔](https://github.com/rhasspy/piper),打开所有现有模型的源码(MIT License)并 [@jozefchutka : @ info: whatsthis](https://github.com/jozefchutka) 他想出了一个建筑的阶梯.

## 使用量

首先,您需要安装库 :

```bash
npm i @diffusionstudio/vits-web
```

然后你可以这样导入图书馆(只有ES)

```typescript
import * as tts from '@diffusionstudio/vits-web';
```

现在你可以开始合成演讲了!

```typescript
const wav = await tts.predict({
  text: "Text to speech in the browser is amazing!",
  voiceId: 'en_US-hfc_female-medium',
});

const audio = new Audio();
audio.src = URL.createObjectURL(wav);
audio.play();

// as seen in /example with Web Worker
```

随着预测函数的初始运行,您将下载模型,然后存储在您的 [来源私有文件系统](https://developer.mozilla.org/en-US/docs/Web/API/File_System_API/Origin_private_file_system)。您也可以提前手动做到这一点 _(建议)_,内容如下:

```typescript
await tts.download('en_US-hfc_female-medium', (progress) => {
  console.log(`Downloading ${progress.url} - ${Math.round(progress.loaded * 100 / progress.total)}%`);
});
```

预测函数还接受下载进度回调作为第二个参数(`tts.predict(..., console.log)`) (中文(简体) ).  

如果您想知道哪些模型已被存储, 请执行以下操作 :

```typescript
console.log(await tts.stored());

// will log ['en_US-hfc_female-medium']
```

您可以通过调用删除

```typescript
await tts.remove('en_US-hfc_female-medium');

// alternatively delete all

await tts.flush();
```

最后但并非最不重要的是,如果你想获取所有可用的声音,请使用这个片段:

```typescript
console.log(await tts.voices());

// Hint: the key can be used as voiceId
```

### **就这样!** 快乐的编码 :)

## 常见问题

### @diffusionstudio/vits-web 是什么？

在浏览器中使用基于 VITS 的模型的 Web api \!

### 如何安装 @diffusionstudio/vits-web？

在项目目录运行 npm install @diffusionstudio/vits-web，或使用 pnpm add / yarn add / bun add。

### @diffusionstudio/vits-web 支持 TypeScript 吗？

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

### @diffusionstudio/vits-web 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @diffusionstudio/vits-web 可以商用吗？

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

### @diffusionstudio/vits-web 的下载量有多少？

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

### @diffusionstudio/vits-web 还在维护吗？

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