API 参考

推荐从 Convbased 调用高层接口：

import { Convbased } from "@convbased/sdk";

const session = await Convbased.startVoiceChange(options);
const converted = await Convbased.convertFile(options);
const speech = await Convbased.textToSpeech(options);

三项函数也支持具名导入。

高层函数

函数	签名	返回
startVoiceChange	startVoiceChange(opts: StartVoiceChangeOptions)	Promise<VoiceSession>
convertFile	convertFile(opts: ConvertFileOptions)	Promise<ConvertedFile>
textToSpeech	textToSpeech(opts: TextToSpeechOptions)	Promise<TtsResult>

完整参数语义见实时变声、文件变声和文本转语音。

VoiceSession

startVoiceChange() resolve 后返回会话句柄：

成员	签名	说明
stream	MediaStream | null	转换后的音频流。
setPitch	setPitch(semitones: number)	按半音调整音高。
update	update(preferences: VoicePreferences)	更新传入的调音字段。
setMuted	setMuted(muted: boolean)	设置麦克风静音状态。
mute / unmute	mute() / unmute()	静音或取消静音。
stop	stop(): Promise<void>	结束会话并释放 SDK 获取的麦克风流。

文本转语音类型

TextToSpeechOptions 支持：

• mode：general、expressive、advanced。
• voice 或 voices：单参考或有序多参考，两者不能同时使用。
• emotionVoice：独立情感参考。
• promptText：参考音频转写。
• params：GeneralTtsParams、ExpressiveTtsParams 或 AdvancedTtsParams。

TtsResult 包含 mode、billingQuantity、billingUnit、audioDurationSec、amountCharged、balanceAfter 和可选 subtitle。

需要构建动态模式选择器时，使用 new TtsClient({ auth }).getModes() 获取 TtsModeInfo[]。

主要导出类型

分组	类型
鉴权	SdkAuthentication、SdkAuthOptions、SdkTokenRequest、SdkAuthError
实时变声	StartVoiceChangeOptions、VoiceSession、VoiceStatus、VoiceOutput、VoicePreferences
文件变声	ConvertFileOptions、ConvertedFile、FileInferencePreferences
文本转语音	TextToSpeechOptions、TtsResult、TtsGenerationMode、TtsModeInfo、TtsBillingUnit、TtsReference、TtsParams

其余低层客户端和辅助类型以软件包随附的 .d.ts 为准。