Skip to main content

Usage guide

Setup, environment variables, and Python/JavaScript/Go usage examples.

​
PaplaTTS

Papla Media Text-to-Speech provider plugin. Wraps the Papla Media TTS API, which is powered by the P1 model, a synthesis engine designed for ultra-realistic English voices, authentic accents, and instant voice cloning from short audio samples.

​
Constructor

​
api_key
str | None
Papla Media API key. Falls back to the PAPLA_API_KEY environment variable when None.
​
model_id
str
default:"papla_p1"
TTS model identifier, also used as the voice ID for the synthesis request. Defaults to "papla_p1" (the P1 ultra-realistic English model). Consult the Papla Media API docs for a full list of available model IDs and cloned voices.
​
sample_rate
int
default:"24000"
Output audio sample rate in Hz. Defaults to 24000.

​
aclose

Release any resources held by the provider.

​
emit

Emit an event, invoking all registered handlers with the given arguments. Handlers are called in registration order. Coroutine handlers are scheduled on the running event loop. If the emitter is closed, the call is a no-op.
​
event
T
required
The event to emit.

​
interrupt

Interrupt and cancel the current synthesis for the active session, if any.

​
off

Remove a previously registered handler for an event. If the handler is not registered for the event, the call is a no-op.
​
event
T
required
The event the handler was registered for.
​
callback
Callable[..., Any]
required
The handler to remove.

​
on

Register a handler for an event. Can be used directly by passing a callback, or as a decorator when callback is omitted.
​
event
T
required
The event to listen for.
​
callback
Callable[..., Any] | None
The handler to invoke when the event is emitted. If None, a decorator is returned that registers the decorated function.
​
returns
Callable[..., Any]
The registered callback when callback is provided, otherwise a decorator that registers and returns the function it wraps.

​
on_first_audio_byte

Register the callback invoked when the first audio byte is produced.
​
callback
'Callable[[int, int], Awaitable[None] | None]'
required
A callable, optionally async, invoked with synthesis timing information when the first audio byte is emitted.

​
synthesize

Synthesize the given text into speech. Implementations should convert the text to audio. The default behavior forwards the text to the active session for playback when one is present.
​
text
Any
required
The text to synthesize; coerced to a string if needed.