HipcallTts (hipcall_tts v0.5.0)

Main public API for hipcall_tts.

Provides:

generate/1 for request/response TTS generation
stream/1 for streaming (delegates to provider)
Introspection helpers (providers/0, models/1, voices/1, languages/1, capabilities/1)

Summary

Types

params()

Functions

capabilities(provider)

Get capabilities for a provider.

compatible_models(provider, voice_id)

List models compatible with a specific voice for a provider.

generate(params)

Generate speech audio from text.

languages(provider)

List languages for a provider.

models(provider)

List models for a provider.

providers()

List available provider names.

stream(params)

Stream speech audio.

voices(provider)

List voices for a provider.

Types

params()

@type params() :: keyword() | map()

Functions

capabilities(provider)

@spec capabilities(atom()) :: {:ok, map()} | {:error, String.t()}

Get capabilities for a provider.

compatible_models(provider, voice_id)

@spec compatible_models(atom(), String.t()) :: {:ok, list()} | {:error, String.t()}

List models compatible with a specific voice for a provider.

generate(params)

@spec generate(params()) :: {:ok, binary()} | {:error, any()}

Generate speech audio from text.

Parameters are validated via HipcallTts.Schema.generate_schema/0.

Returns {:ok, audio_binary} or {:error, error}.

languages(provider)

@spec languages(atom()) :: {:ok, list()} | {:error, String.t()}

List languages for a provider.

models(provider)

@spec models(atom()) :: {:ok, list()} | {:error, String.t()}

List models for a provider.

providers()

@spec providers() :: [atom()]

List available provider names.

stream(params)

@spec stream(params()) :: {:ok, Enumerable.t()} | {:error, any()}

Stream speech audio.

Currently delegates directly to the provider's stream/1.

voices(provider)

@spec voices(atom()) :: {:ok, list()} | {:error, String.t()}

List voices for a provider.