主题
JavaScript SDK
使用 @convbased/sdk 0.3 在浏览器中接入实时变声、文件变声和文本转语音。
| 功能 | 方法 | 返回值 |
|---|---|---|
| 实时变声 | Convbased.startVoiceChange() | 用于调整参数和结束变声的 VoiceSession |
| 文件变声 | Convbased.convertFile() | 转换后音频的临时下载地址 |
| 文本转语音 | Convbased.textToSpeech() | 合成音频、实际使用的模式和扣费信息 |
安装
bash
npm install @convbased/sdk也可以使用 Bun:
bash
bun add @convbased/sdkSDK 提供 ESM、CommonJS 和可直接用 script 标签引入的浏览器版本。实时变声需在支持 WebRTC、MediaStream 和麦克风采集的浏览器中运行。
鉴权
不要把 API Key 放进浏览器。应用后端先确认当前用户有权使用所请求的模型或功能,再用后端保存的 API Key 换取短期 SDK 令牌;该令牌只能用于本次请求的模型或功能。浏览器通过 tokenProvider 向应用后端取令牌;详见鉴权。
调用方式
ts
import { Convbased } from "@convbased/sdk";
const session = await Convbased.startVoiceChange(options);
const converted = await Convbased.convertFile(options);
const speech = await Convbased.textToSpeech(options);三个函数也可以单独导入,见 API 参考。
免构建引入
不使用打包工具时,用 script 标签引入,SDK 会挂载到 window.Convbased:
html
<script src="https://cdn.weights.chat/sdk/convbased-sdk.global.js"></script>这种引入方式与 npm 包使用相同的鉴权配置和调用方法。