Metadata-Version: 2.4
Name: livekit-plugins-sonex
Version: 0.1.0
Summary: LiveKit Agents plugin for SonexLabs Text-to-Speech (TTS)
Project-URL: Homepage, https://www.sonexlabs.com
Project-URL: Documentation, https://docs.sonexlabs.com
Project-URL: Repository, https://github.com/sonexlabs/livekit-plugins-sonex
Project-URL: Issues, https://github.com/sonexlabs/livekit-plugins-sonex/issues
Author-email: SonexLabs <hi@sonexlabs.com>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: audio,livekit,livekit-agents,realtime,sonexlabs,text-to-speech,tts,voice,webrtc
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
Requires-Dist: aiohttp>=3.9.0
Requires-Dist: livekit-agents>=1.6.7
Description-Content-Type: text/markdown

# livekit-plugins-sonex

LiveKit Agents plugin for **SonexLabs Text-to-Speech**.

This package allows LiveKit Agents to synthesize speech using SonexLabs' TTS API through the standard LiveKit plugin interface.

---

## Features

- Native LiveKit Agents integration
- Async HTTP client
- High-quality SonexLabs voices
- Supports LiveKit AgentSession
- Simple pip installation

---

## Installation

```bash
pip install livekit-plugins-sonex
```

For local development:

```bash
git clone https://github.com/sonexlabs/livekit-plugins-sonex.git
cd livekit-plugins-sonex

pip install -e .
```

---

## Authentication

The plugin requires a SonexLabs API key.

You can either pass it directly:

```python
tts = sonex.TTS(
    api_key="vsk_xxxxxxxxx",
    voice_id="YOUR_VOICE_ID",
)
```

or configure it as an environment variable.

Linux/macOS

```bash
export SONEX_API_KEY=vsk_xxxxxxxxx
```

Windows PowerShell

```powershell
$env:SONEX_API_KEY="vsk_xxxxxxxxx"
```

---

## Usage

```python
from livekit.agents import AgentSession
from livekit.plugins import sonex

session = AgentSession(
    tts=sonex.TTS(
        voice_id="YOUR_VOICE_ID",
    ),
)
```

---

## Parameters

| Parameter | Description |
|----------|-------------|
| api_key | Sonex API key (optional if SONEX_API_KEY is set) |
| voice_id | Sonex voice ID |
| model | TTS model (default: panini) |
| sample_rate | Output sample rate (default: 24000 Hz) |

---

## Requirements

- Python 3.10+
- livekit-agents

---

## License

Apache-2.0
