主题
JavaScript SDK
@convbased/sdk 是面向浏览器的 Convbased 语音 SDK。普通接入只需使用三项高层入口:
| 能力 | 入口 | 说明 |
|---|---|---|
| 实时变声 | Convbased.startVoiceChange | 采集麦克风,把转换后的音频流接入指定输出。 |
| 文件变声 | Convbased.convertFile | 转换整段音频,返回下载地址。 |
| 文本转语音 | Convbased.textToSpeech | 按产品模式生成语音,可选参考音频。 |
每个入口都把连接、上传和任务状态处理收成一次调用。
运行环境
- SDK 依赖浏览器的 WebRTC、媒体采集、
Blob和MediaStream能力,不支持纯 Node.js 运行时。 - 一次
startVoiceChange对应一次会话,结束后再次调用即开新会话。
安装
bash
npm install @convbased/sdk
# 或
bun add @convbased/sdk生产服务端点已内置。调用时传入统一的 auth 配置,以及该能力需要的模型或输入内容;参见鉴权。
免构建引入
CDN 提供单文件产物,并通过 window.Convbased 暴露包的导出成员:
html
<script src="https://cdn.weights.chat/sdk/convbased-sdk.global.js"></script>
<script>
const session = await Convbased.startVoiceChange({ auth, modelId, output: audioEl });
</script>auth 的配置方式见鉴权。
产物与版本
本文描述 @convbased/sdk 0.3 API。0.2 的 apiKey 调用方式与本文不兼容。软件包采用 MIT 许可,提供 ESM、CommonJS 与浏览器全局构建。