Zum Hauptinhalt springen

Sprachsynthese Capacitor Plugin

Text in Sprache umwandeln mit voller Kontrolle über Sprache, Stimme, Tonhöhe, Geschwindigkeit und Lautstärke.

Installieren

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

Anleitung

Speech Synthesis in Capacitor nutzen

Auf dem Gerät testen

Lade die Capgo App herunter und scanne den QR code.

QR-Code zur Speech Synthesis Plugin-Vorschau code

Verwendung von @capgo/capacitor-speech-synthesis

Speech Synthesis Plugin zur Sprachsynthese aus Text.

Installieren

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

bunx cap sync kopiert den nativen code des Plugins in deine nativen Projekte. Nach jedem Plugin-Upgrade erneut ausführen.

Importieren

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

API auf einen Blick

Methode Beschreibung
speak Spricht den angegebenen Text mit den gewählten Optionen aus. Die Sprachausgabe wird der Warteschlange hinzugefügt.
synthesizeToFile Synthetisiert Sprache in eine Audiodatei (nur Android/iOS). Gibt den Pfad der gespeicherten Datei zurück.
cancel Bricht alle geplanten Sprachausgaben ab und stoppt die aktuelle Sprachausgabe.
pause Pausiert die Sprachausgabe sofort.
resume Setzt die pausierte Sprachausgabe fort.
isSpeaking Prüft, ob die Sprachausgabe gerade aktiv ist.
isAvailable Prüft, ob die Sprachausgabe auf dem Gerät verfügbar ist.
getVoices Ruft alle verfügbaren Stimmen ab.
getLanguages Ruft alle verfügbaren Sprachen ab.
isLanguageAvailable Prüft, ob eine bestimmte Sprache verfügbar ist.
isVoiceAvailable Prüft, ob eine bestimmte Stimme verfügbar ist.
initialize Initialisiert die Speech-Synthesis-Engine (iOS-Optimierung). Dies kann die Latenz bei der ersten Sprachausgabe verringern.
activateAudioSession Aktiviert die Audio-Session mit einer spezifischen Kategorie (nur iOS).
deactivateAudioSession Deaktiviert die Audio-Session (nur iOS).

Beispiele

speak()

Spricht den angegebenen Text mit den gewählten Optionen aus. Die Sprachausgabe wird der Queue 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()

Synthetisiert Sprache in eine Audiodatei (nur Android/iOS). Gibt den Dateipfad zurück, unter dem das Audio 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()

Cancels all queued utterances and stops current speech.

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

await SpeechSynthesis.cancel();

pause()

Pausiert die Sprachausgabe sofort.

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

await SpeechSynthesis.pause();

resume()

Setzt die pausierte Sprachausgabe fort.

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

await SpeechSynthesis.resume();

isSpeaking()

Prüft, ob die Speech-Synthesis gerade eine Sprachausgabe tätigt.

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

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

Die obige Tabelle listet die 14 Kernmethoden auf. Listener, Version-Helper und der vollständige Contract jeder Methode sind in der GitHub Repository.

Events abonnieren

addListener gibt ein Handle zurück. Rufe handle.remove() auf, wenn der Screen unmountet, oder SpeechSynthesis.removeAllListeners() auf, um alle Listener zu entfernen.

Vollständige Referenz

Weiter mit „Using @capgo/capacitor-speech-synthesis“

Wenn du es nutzt Verwendung von @capgo/capacitor-speech-synthesis Um die Arbeit an nativen Plugins zu planen, verbinde sie mit @capgo/capacitor-speech-synthesis für die Implementierungsdetails in @capgo/capacitor-speech-synthesis, Erste Schritte für die Implementierungsdetails in Erste Schritte, Capgo Plugin-Verzeichnis für den Produkt-Workflow im 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.

FAQ

Speech Synthesis Plugin FAQ

Wie installiere ich das Speech Synthesis Plugin in einer Capacitor App?

Führe "bun add @capgo/capacitor-speech-synthesis" (oder "npm install @capgo/capacitor-speech-synthesis") aus und danach "bunx cap sync", damit die iOS- und Android-Projekte die nativen code übernehmen. Importiere es in deiner App code aus "@capgo/capacitor-speech-synthesis".

Funktioniert @capgo/capacitor-speech-synthesis mit React, Vue und Angular?

Ja. Speech Synthesis ist ein Capacitor Package und funktioniert daher mit jedem Web-Framework, das in Capacitor läuft, einschließlich Ionic, React, Vue, Angular, Svelte und reinem JavaScript.

Welche Capacitor Version wird von @capgo/capacitor-speech-synthesis unterstützt?

Capgo Plugins folgen der Major-Version von Capacitor: Nutze die Plugin-Major-Version, die zu deiner Capacitor Major-Version passt (z. B. Plugin v8 bei Capacitor 8). Die Kompatibilitätstabelle im GitHub README listet die gepflegten Versionen auf.

Ist @capgo/capacitor-speech-synthesis kostenlos und Open Source?

Ja. Der code Quellcode ist auf GitHub unter https://github.com/Cap-go/capacitor-speech-synthesis/ öffentlich einsehbar und das Package kann kostenlos via npm installiert werden. Bug-Reports und Pull Requests sind willkommen.

Kann ich code mit Speech Synthesis ohne App Store Review aktualisieren?

Die Installation oder ein Upgrade des Plugins ändert den nativen code, weshalb ein neuer Store-Build nötig ist. Danach können JavaScript-, HTML- und CSS-Änderungen, die das Plugin aufrufen, sofort per Capgo Live Updates ausgeliefert werden.

Speech Synthesis Änderungen ohne App-Review ausrollen

Sobald das Plugin in deinem Store-Build ist, bringt Capgo mit Live-Updates deine JavaScript-, HTML- und CSS-Änderungen in Minuten zu den Nutzern.

Starte mit Capgo