Skip to main content

Qwen-Audio-TTS Node.js SDK

Utilisez le SDK vocal Node.js pour appeler Qwen-Audio-TTS avec du texte complet ou en streaming et traiter l’audio, les horodatages des mots et l’utilisation.

Prérequis

Obtenez une clé API dans la console et définissez-la dans la variable d’environnement DASHSCOPE_API_KEY.

Installer le SDK

Nécessite Node.js 18 ou ultérieur. Téléchargez le SDK 0.1.0, puis exécutez dans votre projet :
npm install ./dashscope-sdk-nodejs-0.1.0.tgz

Démarrage rapide

Enregistrez l’exemple dans example.mjs, puis exécutez 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()
}

Paramètres de requête

Options du constructeur de SpeechSynthesizer :
ParamètreTypeObligatoireDescription
apiKeystringNonClé API. Utilise DASHSCOPE_API_KEY par défaut.
workspaceIdstringNonID de l’espace de travail. Utilise DASHSCOPE_WORKSPACE_ID par défaut.
baseUrlstringNonDéfinissez l’hôte sur dashscope-intl.aliyuncs.com (Singapour).
modelstringNonID du modèle. Par défaut : qwen-audio-3.1-tts-flash.
voicestringOuiID de voix. Choisissez une voix compatible avec le modèle.
format'pcm' | 'wav' | 'mp3' | 'opus'NonEncodage audio. Utilise la valeur par défaut du service si omis.
sampleRate8000 | 16000 | 22050 | 24000 | 44100 | 48000NonFréquence d’échantillonnage en Hz. Doit correspondre à l’encodage ; déterminée par le service si omise.
volumenumberNonVolume : [0,100]. Par défaut : 50.
ratenumberNonDébit de parole : [0.5,2.0]. Par défaut : 1.0.
pitchnumberNonHauteur : [0.5,2.0]. Par défaut : 1.0.
wordTimestampEnabledbooleanNonRenvoie les horodatages des mots. Par défaut : false.
languageHintsstring[]Non
Pour les voix multilingues et dialectales de qwen-audio-3.1-tts-flash, ce paramètre permet de spécifier la langue ou le dialecte. Consultez les paramètres des voix multilingues et dialectales pour en savoir plus.
Indications de langue cible. Seul le premier élément est pris en compte.
instructionstringNonInstructions de synthèse pour le dialecte, l’émotion ou le rôle.
parametersTtsSynthesisParametersNonParamètres supplémentaires, tels que enable_ssml, seed et hot_fix.
connectTimeoutMsnumberNonDélai de connexion en ms. Par défaut : 10000.
taskTimeoutMsnumberNonDélai de confirmation de début/fin en ms. Par défaut : 60000 ; 0 le désactive.
parameters.enable_ssmlbooleanNonActive SSML. Envoyez le texte SSML complet et non vide une fois par tâche. Consultez les limites.
parameters.bit_ratenumberNonDébit MP3/Opus en kbps. Plage : [6,510] ; par défaut : 32.
parameters.seednumberNonGraine aléatoire : [0,65535].
parameters.hot_fixRecord<string, unknown>NonConfiguration de correctif via parameters.hot_fix. Consultez la structure dans les événements client.

Référence de l’API

Méthodes principales

MéthodeValeur de retourDescription
synthesize(text: string)Promise<Buffer>Synthétise le texte complet et renvoie l’audio. Au plus 20000 caractères.
begin()Promise<void>Démarre la synthèse en streaming ; envoyez ensuite le texte.
sendText(text: string)voidEnvoie un fragment : au plus 20000 caractères par appel et 200000 par tâche.
end()Promise<Buffer>Termine l’entrée, attend la synthèse et renvoie l’audio complet.
cancel()voidDemande l’annulation de la synthèse.
close(code?: number, reason?: string)voidFerme la connexion et libère les ressources de la tâche.

Événements de callback

Enregistrez les callbacks avec on(event, listener). Consultez les champs complets dans les événements serveur.
ÉvénementCharge utileDescription
started{ taskId: string }La tâche a démarré et accepte les entrées.
audioBufferBloc audio binaire ; peut être émis plusieurs fois.
sentenceBegin{ index: number; text: string }La synthèse d’une phrase a commencé.
sentenceEnd{ index: number; text: string; characters?: number; words?: TtsWord[]; usage?: TtsUsage }Synthèse de phrase terminée ; peut inclure les horodatages et l’utilisation brute.
finished{ taskId: string; characters?: number; usage?: TtsUsage }La tâche est terminée et l’état local effacé.
failed / errorDashScopeErrorErreur avec code, message et identifiants de requête.
close{ code: number; reason: string }Notification de fermeture de la connexion sous-jacente.
eventServerEventMessage JSON brut du service.