Verwendung von @capgo/capacitor-speech-synthesis
Speech-Synthese-Plugin zur Synthese von Sprache aus Text.
Installieren
bun add @capgo/capacitor-speech-synthesis
bunx cap sync
bunx cap sync kopiert die native code des Plugins in Ihre native Projekte. Führen Sie es erneut durch, nachdem jede Plugin-Upgrade durchgeführt wurde.
Importieren
import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';
API im Überblick
| Methode | Beschreibung |
|---|---|
speak |
Spricht den angegebenen Text mit angegebenen Optionen. Die Aussage wird zur Sprachwarteschlange hinzugefügt. |
synthesizeToFile |
Erzeugt Sprache in einem Audio-Datei (nur Android/iOS). Gibt den Pfad zurück, an dem die Audio-Datei gespeichert wurde. |
cancel |
Beendet alle geplante Aussagen und stoppt die aktuelle Sprache. |
pause |
Beendet die Sprache sofort. |
resume |
Setzt die Sprache fort. |
isSpeaking |
Überprüft, ob die Sprachsynthese gerade spricht. |
isAvailable |
Überprüft, ob die Sprachsynthese auf dem Gerät verfügbar ist. |
getVoices |
Gibt alle verfügbaren Stimmen zurück. |
getLanguages |
Gibt alle verfügbaren Sprachen zurück. |
isLanguageAvailable |
Überprüft, ob eine bestimmte Sprache verfügbar ist. |
isVoiceAvailable |
Überprüft, ob eine bestimmte Stimme verfügbar ist. |
initialize |
Initialisiert die Sprachsynthesie-Engine (iOS-Optimierung). Dies kann die Latenz für den ersten Sprachanforderung reduzieren. |
activateAudioSession |
Aktiviert die Audio-Sitzung mit einer bestimmten Kategorie (iOS nur). |
deactivateAudioSession |
Deaktiviert die Audio-Sitzung (iOS nur). |
Beispiele
speak()
Spricht den angegebenen Text mit angegebenen Optionen aus. Die Aussage wird zur Sprachwarte hinzugefügt.
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()
Erzeugt Sprache in einem Audio-Datei (Android/iOS nur). Gibt den Pfad zurück, an dem die Audio-Datei gespeichert wurde.
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()
Storniert alle angehängten Aussagen und beendet die aktuelle Sprache.
import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';
await SpeechSynthesis.cancel();
pause()
Sprachausgabe sofort anhalten.
import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';
await SpeechSynthesis.pause();
resume()
Wiederaufnahme der angehaltenen Sprachausgabe.
import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';
await SpeechSynthesis.resume();
isSpeaking()
Überprüft, ob die Sprachsynthese derzeit spricht.
import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';
const { isSpeaking } = await SpeechSynthesis.isSpeaking();
console.log('Is speaking:', isSpeaking);
Die Tabelle oben listet die 14 Kernmethoden. Helfer für Listener und Versionen sowie die vollständige Vertragsvereinbarung jeder Methode sind im GitHub Repository.
Hören Sie auf Ereignisse
addListener eine Verbindung zurückgibt. Rufen Sie handle.remove() wenn das Bildschirm unmontiert wird, oder SpeechSynthesis.removeAllListeners() um alle Listener zu löschen.
Vollständige Referenz
Fortsetzen von Using @capgo/capacitor-speech-synthesis
Wenn Sie Using @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-speech-synthesis verwenden Verwendung von @capgo/capacitor-Sprachsynthese um native Plugin-Arbeit zu planen, verbinden Sie es mit @capgo/capacitor-Sprachsynthese für die Implementierungsdetails in @capgo/capacitor-Sprachsynthese, Getting Started für die Implementierungsdetails in Einstieg Capgo Plugin Directory für den Produktworkflow in Capgo Plugin-Verzeichnis Capacitor Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins von Capgo, und Plugins hinzufügen oder aktualisieren für die Implementierungsdetails in Plugins hinzufügen oder aktualisieren.