Skip to main content

Qwen-Audio-TTS Node.js SDK

Use o SDK Node.js de voz para chamar Qwen-Audio-TTS com texto completo ou em streaming e processar áudio, timestamps de palavras e uso.

Instalar o SDK

Requer Node.js 18 ou posterior. Baixe o pacote SDK 0.1.0 e execute no projeto:
npm install ./dashscope-sdk-nodejs-0.1.0.tgz

Início rápido

Obtenha uma chave de API no console e defina-a na variável de ambiente DASHSCOPE_API_KEY. Salve o exemplo como example.mjs e execute node example.mjs.
import { writeFile } from 'node:fs/promises'
import { SpeechSynthesizer } from 'dashscope-sdk-nodejs/tts'

const synth = new SpeechSynthesizer({
  apiKey: process.env.DASHSCOPE_API_KEY,
  workspaceId: process.env.DASHSCOPE_WORKSPACE_ID,
  baseUrl: 'dashscope-intl.aliyuncs.com',
  model: 'qwen-audio-3.1-tts-flash',
  voice: 'longanhuan_v3.1',
  format: 'mp3',
  sampleRate: 24000,
})
synth.on('error', err => console.error(err.code, err.message))

try {
  const audio = await synth.synthesize('Hello, welcome to Qwen Audio.')
  await writeFile('output.mp3', audio)
} finally {
  synth.close()
}

Referência da API

Opções do construtor

Opções do construtor de SpeechSynthesizer:
ParâmetroTipoObrigatórioDescrição
apiKeystringNãoChave de API. Usa DASHSCOPE_API_KEY por padrão.
workspaceIdstringNãoID do espaço de trabalho. Usa DASHSCOPE_WORKSPACE_ID por padrão.
baseUrlstringNãoDefina o hostname como dashscope-intl.aliyuncs.com (Singapura).
modelstringNãoID do modelo. Padrão: qwen-audio-3.1-tts-flash.
voicestringSimID da voz. Escolha uma voz compatível com o modelo.
format'pcm' | 'wav' | 'mp3' | 'opus'NãoCodificação de áudio. Usa o padrão do serviço se omitida.
sampleRate8000 | 16000 | 22050 | 24000 | 44100 | 48000NãoTaxa de amostragem em Hz. Deve corresponder à codificação; o serviço define o valor se omitido.
volumenumberNãoVolume: [0,100]. Padrão do serviço: 50.
ratenumberNãoVelocidade da fala: [0.5,2.0]. Padrão do serviço: 1.0.
pitchnumberNãoTom: [0.5,2.0]. Padrão do serviço: 1.0.
wordTimestampEnabledbooleanNãoRetorna timestamps de palavras. Padrão: false.
languageHintsstring[]NãoDicas de idioma de destino. Apenas o primeiro elemento tem efeito.
instructionstringNãoInstruções de síntese para dialeto, emoção ou papel.
parametersTtsSynthesisParametersNãoParâmetros adicionais, como enable_ssml, seed e hot_fix.
connectTimeoutMsnumberNãoTempo limite de conexão em ms. Padrão: 10000.
taskTimeoutMsnumberNãoTempo limite da confirmação de início/fim em ms. Padrão: 60000; 0 desativa.
parameters.enable_ssmlbooleanNãoAtiva SSML. Envie o texto SSML completo e não vazio uma vez por tarefa. Consulte os limites.
parameters.bit_ratenumberNãoTaxa de bits MP3/Opus em kbps. Intervalo: [6,510]; padrão: 32.
parameters.seednumberNãoSemente aleatória: [0,65535].
parameters.hot_fixRecord<string, unknown>NãoConfiguração de hot-fix em parameters.hot_fix. Consulte a estrutura em eventos do cliente.

Métodos principais

MétodoRetornoDescrição
synthesize(text: string)Promise<Buffer>Sintetiza o texto completo e retorna áudio. Até 20000 caracteres.
begin()Promise<void>Inicia a síntese em streaming; depois envie texto.
sendText(text: string)voidEnvia texto: até 20000 caracteres por chamada e 200000 por tarefa.
end()Promise<Buffer>Encerra a entrada, aguarda a síntese e retorna o áudio completo.
cancel()voidSolicita o cancelamento da síntese.
close(code?: number, reason?: string)voidFecha a conexão e libera os recursos da tarefa.

Eventos de callback

Registre callbacks com on(event, listener). Consulte os campos completos em eventos do servidor.
EventoPayloadDescrição
started{ taskId: string }A tarefa iniciou e aceita entrada.
audioBufferTrecho binário de áudio; pode ocorrer várias vezes.
sentenceBegin{ index: number; text: string }A síntese de uma frase começou.
sentenceEnd{ index: number; text: string; characters?: number; words?: TtsWord[]; usage?: TtsUsage }Síntese da frase concluída; pode incluir timestamps e uso original.
finished{ taskId: string; characters?: number; usage?: TtsUsage }A tarefa terminou e o estado local foi limpo.
failed / errorDashScopeErrorErro com code, message e identificadores da requisição.
close{ code: number; reason: string }Notificação de fechamento da conexão subjacente.
eventServerEventMensagem JSON original do serviço.