API-Referenz - 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 libRecommendedVersionedFilename(): string`	Gibt den empfohlenen versionierten Dateinamen der ONNX-Runtime-Bibliothek zurück (z. B. `libvoicevox_onnxruntime.1.23.2.dylib`).
`static libRecommendedUnversionedFilename(): string`	Gibt den empfohlenen Dateinamen der ONNX-Runtime-Bibliothek ohne Version zurück.
`static libMinRequiredMinorVersion(): int`	Gibt die minimal unterstützte Minor-Version von ONNX Runtime 1.x zurück.
`static libMaxSupportedMinorVersion(): int`	Gibt die maximal unterstützte Minor-Version von ONNX Runtime 1.x zurück.

libVersionedFilename() und libUnversionedFilename() bleiben als veraltete (deprecated) Aliase erhalten.

Konstanten

Konstante	Beschreibung
`LIB_MIN_REQUIRED_MINOR_VERSION`	Minimal unterstützte Minor-Version von ONNX Runtime 1.x (`17`)
`LIB_MAX_SUPPORTED_MINOR_VERSION`	Maximal unterstützte Minor-Version von ONNX Runtime 1.x (`29`)
`LIB_RECOMMENDED_NAME`	Empfohlener Bibliotheks-Basisname (`voicevox_onnxruntime`)
`LIB_RECOMMENDED_VERSION`	Empfohlene ONNX-Runtime-Version (`1.23.2`)

LIB_NAME und LIB_VERSION bleiben als veraltete (deprecated) Aliase erhalten.

`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, OnExistingVoiceModelId $onExisting = Error): void`	Lädt ein Audiomodell. Mit `$onExisting` können Sie das Verhalten wählen, wenn bereits ein Modell mit derselben ID geladen ist.
`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.
`createAudioFeature(string $audioQueryJson, int $styleId, bool $enableInterrogativeUpspeak = true): AudioFeature`	Erstellt die Zwischenrepräsentation `AudioFeature` für das frameweise Rendern.
`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.

`AudioFeature` und `AudioFeatureSlice`

AudioFeature besitzt die native Zwischenrepräsentation, und AudioFeatureSlice hält das zugehörige AudioFeature am Leben. Das Rendern erfolgt synchron und gibt rohe 16-Bit-PCM-Daten zurück.

Klasse / Methode	Beschreibung
`AudioFeature::length(): int`	Gibt die Gesamtzahl der Frames zurück.
`AudioFeature::isEmpty(): bool`	Gibt zurück, ob das `AudioFeature` leer ist.
`AudioFeature::whole(): AudioFeatureSlice`	Gibt einen Slice zurück, der das gesamte Feature abdeckt.
`AudioFeature::slice(int $startInclusive, int $end, bool $endIsInclusive = false, bool $clamp = false, bool $allowStartExceedsEnd = false): AudioFeatureSlice`	Erstellt einen Slice für einen Frame-Bereich. Standardmäßig ist die Endposition nicht enthalten.
`AudioFeature::render(): string`	Rendert das gesamte Feature als PCM.
`AudioFeatureSlice::length(): int`	Gibt die Anzahl der Frames im Slice zurück.
`AudioFeatureSlice::isEmpty(): bool`	Gibt zurück, ob der Slice leer ist.
`AudioFeatureSlice::slice(int $startInclusive, int $end, bool $endIsInclusive = false, bool $clamp = false, bool $allowStartExceedsEnd = false): AudioFeatureSlice`	Erstellt einen Teil-Slice mit denselben Bereichsoptionen.
`AudioFeatureSlice::render(): string`	Rendert den Slice als PCM.

`VoicevoxCore`

Globale Utility-Funktionen von VOICEVOX Core.

Methoden

Methode	Beschreibung
`getVersion(): string`	Gibt die Version von VOICEVOX Core als SemVer-String zurück.
`getFrameRate(): float`	Gibt die Anzahl der Frames pro Sekunde zurück (`93.75` in CORE 0.17.1).
`audioQueryFrameLength(string $audioQueryJson, bool $enableInterrogativeUpspeak = true): int`	Gibt die geschätzte Audiolänge in Frames zurück.
`audioQueryCreateFromAccentPhrases(string $accentPhrasesJson): string`	Erzeugt aus einem JSON eines Akzentphrasen-Arrays ein AudioQuery-JSON.
`audioQueryValidate(string $audioQueryJson): void`	Validiert `AudioQuery`-JSON. Bei Ungültigkeit wird eine `VoicevoxException` geworfen.
`accentPhraseValidate(string $accentPhraseJson): void`	Validiert `AccentPhrase`-JSON. Bei Ungültigkeit wird eine `VoicevoxException` geworfen.
`moraValidate(string $moraJson): void`	Validiert `Mora`-JSON. Bei Ungültigkeit wird eine `VoicevoxException` geworfen.
`scoreValidate(string $scoreJson): void`	Validiert `Score`-JSON. Bei Ungültigkeit wird eine `VoicevoxException` geworfen.
`noteValidate(string $noteJson): void`	Validiert `Note`-JSON. Bei Ungültigkeit wird eine `VoicevoxException` geworfen.
`frameAudioQueryValidate(string $frameAudioQueryJson): void`	Validiert `FrameAudioQuery`-JSON. Bei Ungültigkeit wird eine `VoicevoxException` geworfen.
`framePhonemeValidate(string $framePhonemeJson): void`	Validiert `FramePhoneme`-JSON. Bei Ungültigkeit wird eine `VoicevoxException` geworfen.
`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.

$priority muss im Bereich von 0 bis 10 liegen. Bei Werten außerhalb dieses Bereichs wird eine InvalidArgumentException geworfen.

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: `OnExistingVoiceModelId`

Verhalten von Synthesizer::loadVoiceModel(), wenn bereits ein Audiomodell mit derselben ID geladen ist.

Case	Wert	Beschreibung
`Error`	`0`	Wirft einen Fehler. Dies ist der Standard.
`Reload`	`1`	Lädt das bestehende Audiomodell neu.
`Skip`	`2`	Tut nichts.

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.

GitHub Copilot

SDK

AI SDK

VOICEVOX

Starter Kits

Feeds und RSS

Middleware

API-Referenz - VOICEVOX Core für PHP

`Onnxruntime`

Methoden

Konstanten

`OpenJtalk`

Methoden

`VoiceModelFile`

Methoden

`Synthesizer`

Methoden

`AudioFeature` und `AudioFeatureSlice`

`VoicevoxCore`

Methoden

`UserDict`

Methoden

Enum: `AccelerationMode`

Enum: `OnExistingVoiceModelId`

Enum: `UserDictWordType`

`VoicevoxException`

​Onnxruntime

​Methoden

​Konstanten

​OpenJtalk

​Methoden

​VoiceModelFile

​Methoden

​Synthesizer

​Methoden

​AudioFeature und AudioFeatureSlice

​VoicevoxCore

​Methoden

​UserDict

​Methoden

​Enum: AccelerationMode

​Enum: OnExistingVoiceModelId

​Enum: UserDictWordType

​VoicevoxException

`Onnxruntime`

Methoden

Konstanten

`OpenJtalk`

Methoden

`VoiceModelFile`

Methoden

`Synthesizer`

Methoden

`AudioFeature` und `AudioFeatureSlice`

`VoicevoxCore`

Methoden

`UserDict`

Methoden

Enum: `AccelerationMode`

Enum: `OnExistingVoiceModelId`

Enum: `UserDictWordType`

`VoicevoxException`