Package `vvclient`

Sub-modules

vvclient.audio_query
vvclient.client
vvclient.errors
vvclient.http
vvclient.types

Classes

class Client (base_uri: str = 'http://localhost:50021')

VOICEVOX Engine client

Parameters

base_uri : str: Base URI of the VOICEVOX Engine

Methods

async def close(self) ‑> None

async def create_audio_query(self, text: str, speaker: int, *, core_version: str | None = None, enable_katakana_english: bool = True) ‑> AudioQuery

Create audio query

Parameters

text : str: Voice text
speaker : int: speaker type
core_version : Optional[str]: voicevox_core version
enable_katakana_english : bool: Enable Katakana English (Default is True)

Returns

audio_query : AudioQuery: Audio query

async def fetch_core_versions(self) ‑> List[str]

Get VOICEVOX Core versions"

Returns

core_versions : List[str]: VOICEVOX Core versions

async def fetch_engine_version(self) ‑> str

Show VOICEVOX Engine version

Returns

engine_version : str: VOICEVOX Engine version

async def init_speaker(self, speaker: int, *, skip_reinit: bool = False, core_version: str | None = None) ‑> None

Initialize speaker

Parameters

speaker : intn: Speaker ID
skip_reinit : bool: Skip initialized speaker
core_version : Optional[str]: VOICEVOX Core version

async def is_inited_speaker(self, speaker: int, *, core_version: str | None = None) ‑> bool