Module `voicevox.client`

Classes

class Client (base_url: str = 'http://localhost:50021', timeout: Optional[int] = None)

Voicevox client class

Wrap voicevox engine api.

Parameters

base_url : str: Voicevox engine endpoint uri.

Attributes

http : HttpClient: Http client attribute.
timeout : Optional[int]: You can customize timeout. If you use cpu mode, I recommend to use this.

Methods

async def check_devices(self, core_version: Optional[str] = None) ‑> SupportedDevices

async def check_inited_speaker(self, speaker: int, *, core_version: Optional[str] = None)

Check initialized speaker

Returns whether the speaker with the specified speaker_id is initialized or not.

Parameters

speaker : int: speaker id
core_version : Optional[str]: core version

Returns

bool: If initialized speaker, it return True.

async def close(self) ‑> None

Close http client

You must run this function, when you finish process.

async def create_audio_query(self, text: str, speaker: int, *, core_version: Optional[str] = None) ‑> AudioQuery

Create audio query

If you want do tts, you must run first.

Parameters

text : str: Text message
speaker : int: Speaker id
core_version : str: Core version

Returns

AudioQuery: Audio query, that run synthesis.

async def create_audio_query_from_preset(self, text: str, preset_id: int, *, core_version: Optional[str] = None) ‑> AudioQuery

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

Fetch core versions

This can fetch voicevox core versions.

Returns

List[str]: Core versions

async def fetch_engine_version(self) ‑> str

Fetch engine version

This can fetch voicevox engine version.

Returns

str: Engine version

async def fetch_speaker_info(self, speaker_uuid: str, core_version: Optional[str] = None) ‑> SpeakerInfo

Fetch speaker's info by given uuid.

This function retrieves additional information about a specific speaker, including its voice samples, icon, and portrait images.

Parameters

speaker_uuid : str: speaker's uuid
core_version : Optional[str]: voicevox core version

Returns

SpeakerInfo: Contains additional information of the speaker.

async def fetch_speakers(self, core_version: Optional[str] = None) ‑> List[Speaker]

Fetch speakers

This can fetch voicevox speakers.

Returns

List[Speaker]: Speakers

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

Initilize speaker

Initializes the speaker with the specified speaker_id. Other APIs can be used without executing this function, but it may take some time when it is executed for the first time.

Parameters

speaker : int: speaker id
skip_reinit : bool: Whether to skip reinitialization of speakers who have already been initialized
core_version : Optional[str]: core version

async def multi_synthesis(self, audio_queries: List[AudioQuery], speaker: int, *, core_version: Optional[str] = None) ‑> bytes

Multi synthe

This function is like AudioQuery.synthesis, but it can synthesis multi!

Parameters

audio_queries : List[AudioQuery]: Array of audio query
speaker : int: speaker id
core_version : Optional[str]: voicevox core version

Returns

bytes: Return zip file