Référence API - VOICEVOX Core for PHP

`Onnxruntime`

Chargeur d’ONNX Runtime. Singleton au niveau du processus : une seule instance par processus.

Méthodes

Méthode	Description
`static loadOnce(string $filename = ''): self`	Charge et initialise ONNX Runtime. À partir du deuxième appel, ignore les arguments et retourne l’instance existante.
`static get(): ?self`	Retourne l’instance existante. Retourne `null` si elle n’est pas encore initialisée.
`supportedDevices(): string`	Retourne les informations des périphériques disponibles sous forme de chaîne JSON.
`static libRecommendedVersionedFilename(): string`	Retourne le nom de fichier versionné de la bibliothèque ONNX Runtime recommandée (par exemple `libvoicevox_onnxruntime.1.23.2.dylib`).
`static libRecommendedUnversionedFilename(): string`	Retourne le nom de fichier non versionné de la bibliothèque ONNX Runtime recommandée.
`static libMinRequiredMinorVersion(): int`	Retourne la version mineure minimale prise en charge d’ONNX Runtime 1.x.
`static libMaxSupportedMinorVersion(): int`	Retourne la version mineure maximale prise en charge d’ONNX Runtime 1.x.

libVersionedFilename() et libUnversionedFilename() sont conservées en tant qu’alias obsolètes.

Constantes

Constante	Description
`LIB_MIN_REQUIRED_MINOR_VERSION`	Version mineure minimale prise en charge d’ONNX Runtime 1.x (`17`)
`LIB_MAX_SUPPORTED_MINOR_VERSION`	Version mineure maximale prise en charge d’ONNX Runtime 1.x (`29`)
`LIB_RECOMMENDED_NAME`	Nom de base de la bibliothèque recommandée (`voicevox_onnxruntime`)
`LIB_RECOMMENDED_VERSION`	Version d’ONNX Runtime recommandée (`1.23.2`)

LIB_NAME et LIB_VERSION sont conservées en tant qu’alias obsolètes.

`OpenJtalk`

Analyseur de texte utilisant OpenJTalk.

Méthodes

Méthode	Description
`__construct(string $openJtalkDictDir)`	Initialise avec le chemin du dossier du dictionnaire OpenJTalk.
`analyze(string $text): string`	Analyse un texte japonais et retourne le JSON du tableau d’accent phrases.
`useUserDict(UserDict $userDict): void`	Applique un dictionnaire utilisateur. À rappeler si le dictionnaire est modifié.

`VoiceModelFile`

Fichier de modèle vocal (fichier .vvm).

Méthodes

Méthode	Description
`static open(string $path): self`	Ouvre un fichier `.vvm`.
`id(): string`	Retourne l’ID du modèle vocal sous forme de chaîne hex (16 octets).
`createMetasJson(): string`	Retourne les métadonnées des locuteurs sous forme de chaîne JSON.
`close(): void`	Ferme le fichier et libère les ressources.

`Synthesizer`

Classe principale de synthèse vocale.

Méthodes

Méthode	Description
`__construct(Onnxruntime $onnxruntime, OpenJtalk $openJtalk, AccelerationMode $accelerationMode = Auto, int $cpuNumThreads = 0)`	Initialise le synthétiseur.
`onnxruntime(): Onnxruntime`	Retourne l’instance `Onnxruntime` détenue par ce synthétiseur.
`isGpuMode(): bool`	Retourne si le mode GPU est actif.
`metas(): string`	Retourne les métadonnées des locuteurs chargés sous forme de chaîne JSON.
`loadVoiceModel(VoiceModelFile $model, OnExistingVoiceModelId $onExisting = Error): void`	Charge un modèle vocal. `$onExisting` permet de choisir le comportement lorsqu’un modèle portant le même ID est déjà chargé.
`unloadVoiceModel(string $voiceModelId): void`	Décharge le modèle vocal spécifié par son ID hex.
`isLoadedVoiceModel(string $voiceModelId): bool`	Vérifie si un modèle vocal est chargé.
`createAudioQuery(string $text, int $styleId): string`	Génère un JSON AudioQuery à partir d’un texte japonais.
`createAudioQueryFromKana(string $kana, int $styleId): string`	Génère un JSON AudioQuery à partir d’une notation kana de style AquesTalk.
`createAccentPhrases(string $text, int $styleId): string`	Génère le JSON d’un tableau d’accent phrases à partir d’un texte japonais.
`createAccentPhrasesFromKana(string $kana, int $styleId): string`	Génère le JSON d’un tableau d’accent phrases à partir d’une notation kana.
`replaceMoraData(string $accentPhrasesJson, int $styleId): string`	Retourne de nouvelles accent phrases avec la hauteur et la durée des mores mises à jour.
`replacePhonemeLength(string $accentPhrasesJson, int $styleId): string`	Retourne de nouvelles accent phrases avec les durées de phonèmes mises à jour.
`replaceMoraPitch(string $accentPhrasesJson, int $styleId): string`	Retourne de nouvelles accent phrases avec la hauteur des mores mise à jour.
`synthesis(string $audioQueryJson, int $styleId, bool $enableInterrogativeUpspeak = true): string`	Synthétise la voix à partir d’un JSON AudioQuery. Retourne un binaire WAV.
`createAudioFeature(string $audioQueryJson, int $styleId, bool $enableInterrogativeUpspeak = true): AudioFeature`	Crée `AudioFeature`, la représentation intermédiaire utilisée pour le rendu par trames.
`tts(string $text, int $styleId, bool $enableInterrogativeUpspeak = true): string`	Synthétise la voix à partir d’un texte japonais en une seule étape. Retourne un binaire WAV.
`ttsFromKana(string $kana, int $styleId, bool $enableInterrogativeUpspeak = true): string`	Synthétise la voix à partir d’une notation kana. Retourne un binaire WAV.
`createSingFrameAudioQuery(string $scoreJson, int $styleId): string`	Génère un JSON de query de synthèse chantée à partir d’un JSON de partition.
`frameSynthesis(string $frameAudioQueryJson, int $styleId): string`	Synthétise la voix chantée à partir d’une frame audio query. Retourne un binaire WAV.
`createSingFrameF0(string $scoreJson, string $frameAudioQueryJson, int $styleId): string`	Retourne les F0 (fréquence fondamentale) par frame à partir de la partition et de la query, sous forme de tableau JSON de float.
`createSingFrameVolume(string $scoreJson, string $frameAudioQueryJson, int $styleId): string`	Retourne le volume par frame à partir de la partition et de la query, sous forme de tableau JSON de float.

`AudioFeature` et `AudioFeatureSlice`

AudioFeature possède la représentation intermédiaire native, et AudioFeatureSlice conserve une référence à l’AudioFeature dont il est issu. Le rendu s’exécute de manière synchrone et retourne des données PCM 16 bits brutes.

Classe / Méthode	Description
`AudioFeature::length(): int`	Retourne le nombre total de trames.
`AudioFeature::isEmpty(): bool`	Retourne si l’`AudioFeature` est vide.
`AudioFeature::whole(): AudioFeatureSlice`	Retourne une slice représentant l’ensemble.
`AudioFeature::slice(int $startInclusive, int $end, bool $endIsInclusive = false, bool $clamp = false, bool $allowStartExceedsEnd = false): AudioFeatureSlice`	Crée une slice représentant une plage de trames. Par défaut, la position de fin est exclue.
`AudioFeature::render(): string`	Effectue le rendu de l’ensemble en PCM.
`AudioFeatureSlice::length(): int`	Retourne le nombre de trames de la slice.
`AudioFeatureSlice::isEmpty(): bool`	Retourne si la slice est vide.
`AudioFeatureSlice::slice(int $startInclusive, int $end, bool $endIsInclusive = false, bool $clamp = false, bool $allowStartExceedsEnd = false): AudioFeatureSlice`	Crée une sous-slice avec les mêmes options de plage.
`AudioFeatureSlice::render(): string`	Effectue le rendu de la slice en PCM.

`VoicevoxCore`

Fonctions utilitaires globales de VOICEVOX Core.

Méthodes

Méthode	Description
`getVersion(): string`	Retourne la version de VOICEVOX Core au format SemVer.
`getFrameRate(): float`	Retourne le nombre de trames par seconde (`93.75` dans CORE 0.17.1).
`audioQueryFrameLength(string $audioQueryJson, bool $enableInterrogativeUpspeak = true): int`	Retourne le nombre estimé de trames de l’audio.
`audioQueryCreateFromAccentPhrases(string $accentPhrasesJson): string`	Génère un JSON AudioQuery à partir d’un JSON de tableau d’accent phrases.
`audioQueryValidate(string $audioQueryJson): void`	Valide un JSON `AudioQuery`. Lève une `VoicevoxException` si invalide.
`accentPhraseValidate(string $accentPhraseJson): void`	Valide un JSON `AccentPhrase`. Lève une `VoicevoxException` si invalide.
`moraValidate(string $moraJson): void`	Valide un JSON `Mora`. Lève une `VoicevoxException` si invalide.
`scoreValidate(string $scoreJson): void`	Valide un JSON `Score`. Lève une `VoicevoxException` si invalide.
`noteValidate(string $noteJson): void`	Valide un JSON `Note`. Lève une `VoicevoxException` si invalide.
`frameAudioQueryValidate(string $frameAudioQueryJson): void`	Valide un JSON `FrameAudioQuery`. Lève une `VoicevoxException` si invalide.
`framePhonemeValidate(string $framePhonemeJson): void`	Valide un JSON `FramePhoneme`. Lève une `VoicevoxException` si invalide.
`ensureCompatible(string $scoreJson, string $frameAudioQueryJson): void`	Vérifie que la combinaison partition + query de synthèse chantée est valide. Lève une `VoicevoxException` si invalide.

`UserDict`

Dictionnaire utilisateur pour enregistrer la prononciation de mots personnalisés.

Méthodes

Méthode	Description
`__construct()`	Crée un dictionnaire utilisateur vide.
`load(string $path): void`	Charge un dictionnaire utilisateur depuis un fichier.
`save(string $path): void`	Enregistre le dictionnaire utilisateur dans un fichier.
`addWord(string $surface, string $pronunciation, int $accentType, UserDictWordType $wordType = CommonNoun, int $priority = 5): string`	Ajoute un mot. Retourne l’UUID du mot sous forme de chaîne hex.
`updateWord(string $wordUuid, string $surface, string $pronunciation, int $accentType, UserDictWordType $wordType = CommonNoun, int $priority = 5): void`	Met à jour un mot existant identifié par son UUID.
`removeWord(string $wordUuid): void`	Supprime le mot identifié par son UUID.
`importDict(UserDict $other): void`	Importe les mots depuis un autre `UserDict`.
`toJson(): string`	Retourne tous les mots sous forme de chaîne JSON.

$priority doit être compris entre 0 et 10. Une valeur hors de cette plage lève une InvalidArgumentException.

Enum : `AccelerationMode`

Mode d’accélération matérielle du synthétiseur.

Case	Valeur	Description
`Auto`	`0`	Sélectionne automatiquement le meilleur mode disponible.
`Cpu`	`1`	Force le mode CPU.
`Gpu`	`2`	Force le mode GPU.

Enum : `OnExistingVoiceModelId`

Comportement de Synthesizer::loadVoiceModel() lorsqu’un modèle vocal portant le même ID est déjà chargé.

Case	Valeur	Description
`Error`	`0`	Lève une erreur. C’est le comportement par défaut.
`Reload`	`1`	Recharge le modèle vocal existant.
`Skip`	`2`	Ne fait rien.

Enum : `UserDictWordType`

Nature grammaticale d’une entrée du dictionnaire utilisateur.

Case	Valeur	Description
`ProperNoun`	`0`	Nom propre
`CommonNoun`	`1`	Nom commun
`Verb`	`2`	Verbe
`Adjective`	`3`	Adjectif
`Suffix`	`4`	Suffixe

`VoicevoxException`

Exception levée lorsque l’appel de l’API C de VOICEVOX Core retourne un code d’erreur. Le message d’exception contient la description d’erreur fournie par la bibliothèque.

GitHub Copilot

SDK

AI SDK

VOICEVOX

Kits de démarrage

Flux et RSS

Middleware

Référence API - VOICEVOX Core for PHP

`Onnxruntime`

Méthodes

Constantes

`OpenJtalk`

Méthodes

`VoiceModelFile`

Méthodes

`Synthesizer`

Méthodes

`AudioFeature` et `AudioFeatureSlice`

`VoicevoxCore`

Méthodes

`UserDict`

Méthodes

Enum : `AccelerationMode`

Enum : `OnExistingVoiceModelId`

Enum : `UserDictWordType`

`VoicevoxException`

​Onnxruntime

​Méthodes

​Constantes

​OpenJtalk

​Méthodes

​VoiceModelFile

​Méthodes

​Synthesizer

​Méthodes

​AudioFeature et AudioFeatureSlice

​VoicevoxCore

​Méthodes

​UserDict

​Méthodes

​Enum : AccelerationMode

​Enum : OnExistingVoiceModelId

​Enum : UserDictWordType

​VoicevoxException

`Onnxruntime`

Méthodes

Constantes

`OpenJtalk`

Méthodes

`VoiceModelFile`

Méthodes

`Synthesizer`

Méthodes

`AudioFeature` et `AudioFeatureSlice`

`VoicevoxCore`

Méthodes

`UserDict`

Méthodes

Enum : `AccelerationMode`

Enum : `OnExistingVoiceModelId`

Enum : `UserDictWordType`

`VoicevoxException`