Aller directement au contenu principal

Synthèse vocale plugin Capacitor

Synthétisez la parole à partir du texte avec un contrôle total sur la langue, la voix, le ton, la vitesse et le volume.

Installer

bun add @capgo/capacitor-speech-synthesis bunx cap sync
npm, pnpm ou yarn
  • npm install @capgo/capacitor-speech-synthesis
  • pnpm add @capgo/capacitor-speech-synthesis
  • yarn add @capgo/capacitor-speech-synthesis

Guide

Comment utiliser la synthèse vocale dans Capacitor

Tester sur appareil

Télécharger l'application Capgo, puis scanner le code QR code.

Prévisualisation du plugin de synthèse vocale QR code

Utilisation de @capgo/capacitor-speech-synthesis

Plugin de synthèse vocale pour synthétiser la parole à partir du texte.

Installer

bun add @capgo/capacitor-speech-synthesis
bunx cap sync

bunx cap sync copie le code natif du plugin dans vos projets natifs. Exécutez-l’à nouveau après chaque mise à jour du plugin.

Importer

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

Vue d'ensemble de API

Méthode Description
speak Parle le texte donné avec les options spécifiées. L'expression est ajoutée à la file d'attente de la parole.
synthesizeToFile Synthétise la parole dans un fichier audio (seulement Android/iOS). Retourne le chemin du fichier où l'audio a été enregistré.
cancel Annule toutes les phrases programmées et arrête la parole actuelle.
pause Arrête la parole immédiatement.
resume Reprend la parole arrêtée.
isSpeaking Vérifie si la synthèse vocale parle actuellement.
isAvailable Vérifie si la synthèse de parole est disponible sur le dispositif.
getVoices Récupère toutes les voix disponibles.
getLanguages Récupère toutes les langues disponibles.
isLanguageAvailable Vérifie si une langue spécifique est disponible.
isVoiceAvailable Vérifie si une voix spécifique est disponible.
initialize Initialise l'engin de synthèse vocale (optimisation iOS). Cela peut réduire la latence pour la première demande de parole.
activateAudioSession Active la session audio avec une catégorie spécifique (iOS uniquement).
deactivateAudioSession Désactive la session audio (iOS uniquement).

Exemples

speak()

Parle le texte spécifié avec des options spécifiées. L'énoncé est ajouté à la file d'attente de parole.

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

const result = await SpeechSynthesis.speak({
  text: 'Hello, world!',
  language: 'en-US',
  rate: 1.0,
  pitch: 1.0,
  volume: 1.0,
  queueStrategy: 'Add'
});
console.log('Utterance ID:', result.utteranceId);

synthesizeToFile()

Synthétise la parole à un fichier audio (Android/iOS uniquement). Retourne le chemin du fichier où l'audio a été enregistré.

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

const result = await SpeechSynthesis.synthesizeToFile({
  text: 'Hello, world!',
  language: 'en-US'
});
console.log('Audio file saved at:', result.filePath);

cancel()

Annule toutes les énonciations programmées et arrête la parole en cours.

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

await SpeechSynthesis.cancel();

pause()

Arrête la parole immédiatement.

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

await SpeechSynthesis.pause();

resume()

Reprend la parole arrêtée.

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

await SpeechSynthesis.resume();

isSpeaking()

Vérifie si la synthèse vocale est en train de parler.

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

const { isSpeaking } = await SpeechSynthesis.isSpeaking();
console.log('Is speaking:', isSpeaking);

La table ci-dessus liste les 14 méthodes de base. Les helpers de listener et de version, ainsi que la pleine convention de chaque méthode, sont documentés dans le répertoire GitHub.

Écoutez les événements

addListener renvoie un gestionnaire. Appelez handle.remove() lorsque l'écran est démonté, ou SpeechSynthesis.removeAllListeners() pour effacer tous les écouteurs.

Référence complète

Continuez à partir de l'utilisation de @capgo/capacitor-speech-synthesis

Si vous utilisez L'utilisation de @capgo/capacitor-speech-synthesis pour planifier le travail du plugin natif, connectez-l’avec @capgo/capacitor-synthèse vocale pour les détails d'implémentation dans @capgo/capacitor-synthèse vocale Getting Started pour les détails d'implémentation dans Démarrage Répertoire des plugins Capgo pour le flux de travail du produit dans Répertoire des plugins Capgo Plugins Capacitor par Capgo pour les détails d'implémentation dans Plugins Capacitor par Capgo, et Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Ajouter ou mettre à jour des plugins.

FAQ

FAQ du plugin de synthèse vocale

Comment installez-vous le plugin de synthèse vocale dans une application Capacitor?

Exécutez « bun add @capgo/capacitor-speech-synthesis » (ou « npm install @capgo/capacitor-speech-synthesis »), puis exécutez « bunx cap sync » afin que les projets iOS et Android prennent en compte le code natif. Importez-l’à partir de « @capgo/capacitor-speech-synthesis » dans votre application code.

Fonctionne-t-il @capgo/capacitor-speech-synthesis avec React, Vue et Angular ?

Oui. La synthèse vocale est un paquet Capacitor, elle fonctionne donc avec tout framework web qui tourne à l'intérieur de Capacitor, y compris Ionic, React, Vue, Angular, Svelte et JavaScript pur.

Quelle version de Capacitor est prise en charge par @capgo/capacitor-speech-synthesis ?

Les plugins Capgo suivent la version majeure de Capacitor : utilisez la version majeure du plugin qui correspond à votre version majeure de Capacitor (par exemple, plugin v8 avec Capacitor 8). La table de compatibilité dans le README de GitHub liste les versions maintenues.

Est-ce que @capgo/capacitor-speech-synthesis est gratuit et open source ?

Oui. Le code source de code est public sur GitHub à https://github.com/Cap-go/capacitor-speech-synthesis/ et le paquet est gratuit pour l'installer depuis npm. Les rapports de bugs et les demandes de pull sont les bienvenus.

Puis-je mettre à jour code qui utilise la synthèse vocale sans passer par une revue de l'App Store ?

Installing or upgrading the plugin changes native code, so it needs a new store build. After that, JavaScript, HTML and CSS changes that call the plugin can ship instantly with Capgo live updates.

Envoyez les modifications de la synthèse vocale sans attendre l'examen de l'application.

Once the plugin is in your store build, Capgo live updates push your JavaScript, HTML and CSS changes to users in minutes.

Commencez avec Capgo