API-Referenz - VOICEVOX Core für PHP

Referenz aller Klassen, Methoden und Enums von VOICEVOX Core für PHP.

​

Onnxruntime

Loader für die ONNX Runtime. Prozessweiter Singleton: pro Prozess existiert nur eine Instanz.

​

Methoden

Methode	Beschreibung
static loadOnce(string $filename = ''): self	Lädt und initialisiert die ONNX Runtime. Bei erneutem Aufruf werden die Argumente ignoriert und die bestehende Instanz zurückgegeben.
static get(): ?self	Gibt die bestehende Instanz zurück. Ist noch keine initialisiert, wird null zurückgegeben.
supportedDevices(): string	Gibt Informationen zu verfügbaren Geräten als JSON-String zurück.
static libVersionedFilename(): string	Gibt den versionierten Dateinamen der ONNX-Runtime-Bibliothek zurück (z. B. libvoicevox_onnxruntime.1.17.3.dylib).
static libUnversionedFilename(): string	Gibt den Dateinamen der ONNX-Runtime-Bibliothek ohne Version zurück.

​

Konstanten

Konstante	Beschreibung
LIB_NAME	Bibliotheks-Basisname (voicevox_onnxruntime)
LIB_VERSION	Empfohlene ONNX-Runtime-Version

---

​

OpenJtalk

Textanalysator, der OpenJTalk verwendet.

​

Methoden

Methode	Beschreibung
__construct(string $openJtalkDictDir)	Initialisiert mit dem Pfad zum OpenJTalk-Wörterbuchverzeichnis.
analyze(string $text): string	Analysiert einen japanischen Text und gibt das JSON eines Akzentphrasen-Arrays zurück.
useUserDict(UserDict $userDict): void	Wendet ein Benutzerwörterbuch an. Bei Änderung des Wörterbuchs erneut aufrufen.

---

​

VoiceModelFile

Audiomodell-Datei (.vvm-Datei).

​

Methoden

Methode	Beschreibung
static open(string $path): self	Öffnet eine .vvm-Datei.
id(): string	Gibt die Audiomodell-ID als Hex-String (16 Byte) zurück.
createMetasJson(): string	Gibt die Speaker-Metadaten als JSON-String zurück.
close(): void	Schließt die Datei und gibt die Ressourcen frei.

---

​

Synthesizer

Hauptklasse für die Text-Sprachsynthese.

​

Methoden

Methode	Beschreibung
__construct(Onnxruntime $onnxruntime, OpenJtalk $openJtalk, AccelerationMode $accelerationMode = Auto, int $cpuNumThreads = 0)	Initialisiert den Synthesizer.
onnxruntime(): Onnxruntime	Gibt die von diesem Synthesizer gehaltene Onnxruntime-Instanz zurück.
isGpuMode(): bool	Gibt zurück, ob der GPU-Modus aktiv ist.
metas(): string	Gibt die Metadaten der geladenen Speaker als JSON-String zurück.
loadVoiceModel(VoiceModelFile $model): void	Lädt ein Audiomodell.
unloadVoiceModel(string $voiceModelId): void	Entlädt das über die Hex-ID angegebene Audiomodell.
isLoadedVoiceModel(string $voiceModelId): bool	Prüft, ob das Audiomodell geladen ist.
createAudioQuery(string $text, int $styleId): string	Erzeugt aus japanischem Text ein AudioQuery-JSON.
createAudioQueryFromKana(string $kana, int $styleId): string	Erzeugt aus Kana in AquesTalk-Notation ein AudioQuery-JSON.
createAccentPhrases(string $text, int $styleId): string	Erzeugt aus japanischem Text ein JSON eines Akzentphrasen-Arrays.
createAccentPhrasesFromKana(string $kana, int $styleId): string	Erzeugt aus Kana-Notation ein JSON eines Akzentphrasen-Arrays.
replaceMoraData(string $accentPhrasesJson, int $styleId): string	Gibt neue Akzentphrasen mit aktualisierten Mora-Pitches und Phonemlängen zurück.
replacePhonemeLength(string $accentPhrasesJson, int $styleId): string	Gibt neue Akzentphrasen mit aktualisierten Phonemlängen zurück.
replaceMoraPitch(string $accentPhrasesJson, int $styleId): string	Gibt neue Akzentphrasen mit aktualisierten Mora-Pitches zurück.
synthesis(string $audioQueryJson, int $styleId, bool $enableInterrogativeUpspeak = true): string	Synthetisiert Audio aus einem AudioQuery-JSON. Gibt die WAV-Binärdaten zurück.
tts(string $text, int $styleId, bool $enableInterrogativeUpspeak = true): string	Synthetisiert in einem Schritt Audio aus japanischem Text. Gibt die WAV-Binärdaten zurück.
ttsFromKana(string $kana, int $styleId, bool $enableInterrogativeUpspeak = true): string	Synthetisiert Audio aus Kana-Notation. Gibt die WAV-Binärdaten zurück.
createSingFrameAudioQuery(string $scoreJson, int $styleId): string	Erzeugt aus einem Partitur-JSON ein Gesangs-Synthese-Query-JSON.
frameSynthesis(string $frameAudioQueryJson, int $styleId): string	Synthetisiert Gesangsaudio aus einer Frame-Audio-Query. Gibt die WAV-Binärdaten zurück.
createSingFrameF0(string $scoreJson, string $frameAudioQueryJson, int $styleId): string	Gibt aus Partitur und Gesangs-Query den F0 (Grundfrequenz) pro Frame als JSON-Array von Floats zurück.
createSingFrameVolume(string $scoreJson, string $frameAudioQueryJson, int $styleId): string	Gibt aus Partitur und Gesangs-Query die Lautstärke pro Frame als JSON-Array von Floats zurück.

---

​

VoicevoxCore

Globale Utility-Funktionen von VOICEVOX Core.

​

Methoden

Methode	Beschreibung
static getVersion(): string	Gibt die Version von VOICEVOX Core als SemVer-String zurück.
static audioQueryCreateFromAccentPhrases(string $accentPhrasesJson): string	Erzeugt aus einem JSON eines Akzentphrasen-Arrays ein AudioQuery-JSON.
static audioQueryValidate(string $audioQueryJson): void	Validiert AudioQuery-JSON. Bei Ungültigkeit wird eine VoicevoxException geworfen.
static accentPhraseValidate(string $accentPhraseJson): void	Validiert AccentPhrase-JSON. Bei Ungültigkeit wird eine VoicevoxException geworfen.
static moraValidate(string $moraJson): void	Validiert Mora-JSON. Bei Ungültigkeit wird eine VoicevoxException geworfen.
static scoreValidate(string $scoreJson): void	Validiert Score-JSON. Bei Ungültigkeit wird eine VoicevoxException geworfen.
static noteValidate(string $noteJson): void	Validiert Note-JSON. Bei Ungültigkeit wird eine VoicevoxException geworfen.
static frameAudioQueryValidate(string $frameAudioQueryJson): void	Validiert FrameAudioQuery-JSON. Bei Ungültigkeit wird eine VoicevoxException geworfen.
static framePhonemeValidate(string $framePhonemeJson): void	Validiert FramePhoneme-JSON. Bei Ungültigkeit wird eine VoicevoxException geworfen.
static ensureCompatible(string $scoreJson, string $frameAudioQueryJson): void	Prüft, ob die Kombination aus Partitur und Gesangssynthese-Query gültig ist. Bei Ungültigkeit wird eine VoicevoxException geworfen.

---

​

UserDict

Benutzerwörterbuch zur Registrierung individueller Wortaussprachen.

​

Methoden

Methode	Beschreibung
__construct()	Erstellt ein leeres Benutzerwörterbuch.
load(string $path): void	Lädt ein Benutzerwörterbuch aus einer Datei.
save(string $path): void	Speichert das Benutzerwörterbuch in einer Datei.
addWord(string $surface, string $pronunciation, int $accentType, UserDictWordType $wordType = CommonNoun, int $priority = 5): string	Fügt ein Wort hinzu. Gibt die Wort-UUID als Hex-String zurück.
updateWord(string $wordUuid, string $surface, string $pronunciation, int $accentType, UserDictWordType $wordType = CommonNoun, int $priority = 5): void	Aktualisiert ein durch UUID bestimmtes bestehendes Wort.
removeWord(string $wordUuid): void	Löscht das durch die UUID bestimmte Wort.
importDict(UserDict $other): void	Importiert Wörter aus einem anderen UserDict.
toJson(): string	Gibt alle Wörter als JSON-String zurück.

---

​

Enum: AccelerationMode

Hardware-Beschleunigungsmodus des Synthesizers.

Case	Wert	Beschreibung
Auto	0	Wählt automatisch den besten verfügbaren Modus.
Cpu	1	Erzwingt CPU-Modus.
Gpu	2	Erzwingt GPU-Modus.

---

​

Enum: UserDictWordType

Wortart eines Benutzerwörterbucheintrags.

Case	Wert	Beschreibung
ProperNoun	0	Eigenname
CommonNoun	1	Nomen
Verb	2	Verb
Adjective	3	Adjektiv
Suffix	4	Suffix

---

​

VoicevoxException

Wird geworfen, wenn ein C-API-Aufruf des VOICEVOX Core einen Fehlercode zurückgibt. Die Exception-Meldung enthält die Fehlerbeschreibung aus der Bibliothek.