> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zeroruntime.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Humeai

> Python API reference for the humeai text-to-speech plugin.

<Card title="Usage guide" icon="book" href="/plugins/tts/humeai" horizontal>
  Setup, environment variables, and Python/JavaScript/Go usage examples.
</Card>

## HumeAITTS

Hume AI TTS provider: expressive, emotion-aware speech synthesis via Hume's Octave model.

Uses Hume AI's `/v0/tts` (Octave) endpoint, which supports both
predefined library voices and user-designed or cloned voices.  Voices can
be specified by name (Hume AI library or custom) or by UUID.  The API
outputs audio at a fixed 48 kHz sample rate; the `sample_rate` argument
controls the advertised rate, not the wire format.

### Constructor

```python theme={null}
HumeAITTS(*, api_key: 'str | None' = None, voice: 'str' = 'Serene Assistant', speed: 'float' = 1.0, sample_rate: 'int' = 24000, **kwargs) -> 'None'
```

<ParamField path="api_key" type="str | None">
  Hume AI API key.  Falls back to the `HUMEAI_API_KEY` environment variable when `None`.
</ParamField>

<ParamField path="voice" type="str" default="Serene Assistant">
  Voice name or UUID.  Can be a name from Hume's built-in voice library (e.g. `"Serene Assistant"`, `"Male English Actor"`), the name of a custom saved voice, or a UUID string (e.g. `"9e068547-5ba4-4c8e-8e03-69282a008f04"`).  Browse available voices at `app.hume.ai/voices` or via the `GET /v0/tts/voices/list` endpoint.  Defaults to `"Serene Assistant"`.
</ParamField>

<ParamField path="speed" type="float" default="1.0">
  Speaking speed multiplier on a non-linear scale from `0.5` (much slower) to `2.0` (much faster), where `1.0` is normal pace.  Changes are not strictly proportional to the multiplier value.  Defaults to `1.0`.
</ParamField>

<ParamField path="sample_rate" type="int" default="24000">
  Advertised output sample rate in Hz. Note: Hume AI's API always returns audio at 48 kHz regardless of this value.  Defaults to `24000`.
</ParamField>

### aclose

```python theme={null}
def aclose(self) -> 'None'
```

Release any resources held by the provider.

### emit

```python theme={null}
def emit(self, event: 'T', *args: 'Any') -> 'None'
```

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.

<ParamField path="event" type="T" required>
  The event to emit.
</ParamField>

### interrupt

```python theme={null}
def interrupt(self) -> 'None'
```

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

### off

```python theme={null}
def off(self, event: 'T', callback: 'Callable[..., Any]') -> 'None'
```

Remove a previously registered handler for an event.

If the handler is not registered for the event, the call is a no-op.

<ParamField path="event" type="T" required>
  The event the handler was registered for.
</ParamField>

<ParamField path="callback" type="Callable[..., Any]" required>
  The handler to remove.
</ParamField>

### on

```python theme={null}
def on(self, event: 'T', callback: 'Callable[..., Any] | None' = None) -> 'Callable[..., Any]'
```

Register a handler for an event.

Can be used directly by passing a callback, or as a decorator when
`callback` is omitted.

<ParamField path="event" type="T" required>
  The event to listen for.
</ParamField>

<ParamField path="callback" type="Callable[..., Any] | None">
  The handler to invoke when the event is emitted. If `None`, a decorator is returned that registers the decorated function.
</ParamField>

<ResponseField name="returns" type="Callable[..., Any]">
  The registered callback when `callback` is provided, otherwise a decorator that registers and returns the function it wraps.
</ResponseField>

### on\_first\_audio\_byte

```python theme={null}
def on_first_audio_byte(self, callback: "'Callable[[int, int], Awaitable[None] | None]'") -> 'None'
```

Register the callback invoked when the first audio byte is produced.

<ParamField path="callback" type="'Callable[[int, int], Awaitable[None] | None]'" required>
  A callable, optionally async, invoked with synthesis timing information when the first audio byte is emitted.
</ParamField>

### synthesize

```python theme={null}
def synthesize(self, text: 'Any', **kwargs: 'Any') -> 'None'
```

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.

<ParamField path="text" type="Any" required>
  The text to synthesize; coerced to a string if needed.
</ParamField>