Aller au contenu principal

Synthèse vocale Plugin Capacitor

Synthétisez de la parole à partir de texte avec un contrôle total sur la langue, la voix, la hauteur, le débit 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 Speech Synthesis dans Capacitor

Tester sur l'appareil

Téléchargez l'application Capgo, puis scannez le QR code.

QR code d'aperçu du plugin Speech Synthesis code

Utiliser @capgo/capacitor-speech-synthesis

Plugin Speech Synthesis pour synthétiser la parole à partir de texte.

Installer

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

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

Importer

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

Aperçu de API

Méthode Description
speak Lit le texte fourni avec les options spécifiées. L'énoncé est ajouté à la file d'attente de lecture.
synthesizeToFile Synthétise la parole dans un fichier audio (Android/iOS uniquement). Renvoie le chemin du fichier dans lequel l'audio a été enregistré.
cancel Annule tous les énoncés en file d'attente et arrête la lecture en cours.
pause Met immédiatement la lecture en pause.
resume Reprend la lecture mise en pause.
isSpeaking Vérifie si une synthèse vocale est en cours.
isAvailable Vérifie si la synthèse vocale est disponible sur l'appareil.
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 le moteur de synthèse vocale (optimisation iOS). Cela peut réduire la latence de la première requête de synthèse.
activateAudioSession Active la session audio avec une catégorie spécifique (iOS uniquement).
deactivateAudioSession Désactive la session audio (iOS uniquement).

Exemples

speak()

Lit le texte fourni avec les options spécifiées. L'énoncé est ajouté à la file d'attente de lecture.

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 dans un fichier audio (Android/iOS uniquement). Renvoie le chemin du fichier dans lequel 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 tous les énoncés en file d'attente et arrête la lecture en cours.

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

await SpeechSynthesis.cancel();

pause()

Met immédiatement la lecture en pause.

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

await SpeechSynthesis.pause();

resume()

Reprend la lecture mise en pause.

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

await SpeechSynthesis.resume();

isSpeaking()

Vérifie si une synthèse vocale est en cours.

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

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

Le tableau ci-dessus liste les 14 méthodes principales. Les helpers de listener et de version, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.

Écouter les événements

addListener renvoie un handle. Appelez handle.remove() lors du démontage de l'écran, ou SpeechSynthesis.removeAllListeners() pour supprimer tous les listeners.

Référence complète

Continuer à partir de « Utiliser @capgo/capacitor-speech-synthesis »

Si vous utilisez Utiliser @capgo/capacitor-speech-synthesis pour planifier le travail sur les plugins natifs, connectez-l’à @capgo/capacitor-speech-synthesis pour les détails d’implémentation dans @capgo/capacitor-speech-synthesis, Prise en main pour les détails d'implémentation dans Getting Started Capgo Répertoire des plugins pour le workflow produit dans Capgo Plugin Directory, Plugins Capacitor par Capgo pour les détails d'implémentation dans les plugins Capacitor par Capgo, et Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Adding or Updating Plugins.

FAQ

FAQ du plugin Speech Synthesis

Comment installer le plugin Speech Synthesis dans une application Capacitor ?

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

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

Oui. Speech Synthesis est un package Capacitor : il fonctionne donc avec n'importe quel framework web qui s'exécute dans Capacitor, y compris Ionic, React, Vue, Angular, Svelte et le JavaScript pur.

Quelle version de Capacitor @capgo/capacitor-speech-synthesis prend-il en charge ?

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

@capgo/capacitor-speech-synthesis est-il gratuit et open source ?

Oui. Le code source de code est public sur GitHub à l'adresse https://github.com/Cap-go/capacitor-speech-synthesis/ et le package s'installe gratuitement depuis npm. Les rapports de bugs et les pull requests sont les bienvenus.

Puis-je mettre à jour code utilisant Speech Synthesis sans passer par une revue de l'App Store ?

L'installation ou la mise à jour du plugin modifie le code natif, ce qui impose un nouveau build pour les stores. Ensuite, les changements JavaScript, HTML et CSS qui appellent le plugin peuvent être livrés instantanément via les live updates de Capgo.

Déployez les modifications de Speech Synthesis sans attendre la revue de l’application

Une fois le plugin intégré à votre build de store, Capgo live updates déploie vos changements JavaScript, HTML et CSS aux utilisateurs en quelques minutes.

Commencez avec Capgo