Skip to content

Commit 2bad334

Browse files
committed
feat(plugins): add Rumik AI TTS plugin
1 parent e87d3ee commit 2bad334

11 files changed

Lines changed: 609 additions & 0 deletions

File tree

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Rumik AI plugin for LiveKit Agents
2+
3+
Support for speech synthesis (TTS) with the [Rumik AI](https://rumik.ai/) API.
4+
5+
## Installation
6+
7+
```bash
8+
pip install livekit-plugins-rumik
9+
```
10+
11+
## Pre-requisites
12+
13+
You'll need an API key from Rumik AI. It can be set as an environment variable: `RUMIK_API_KEY`
14+
15+
## Usage
16+
17+
### Text-to-Speech
18+
19+
```python
20+
from livekit.plugins import rumik
21+
22+
# Standard tone-steered TTS (muga)
23+
tts = rumik.TTS(model="muga")
24+
25+
# Rich instruct-based TTS (mulberry)
26+
tts = rumik.TTS(
27+
model="mulberry",
28+
description="warm, upbeat narrator",
29+
speaker="speaker_2",
30+
)
31+
```
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Copyright 2026 LiveKit, Inc.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
"""Rumik AI plugin for LiveKit Agents
16+
17+
See https://docs.livekit.io/agents/integrations/rumik/ for more information.
18+
"""
19+
20+
from .tts import TTS as TTS, ChunkedStream as ChunkedStream
21+
from .version import __version__ as __version__
22+
23+
__all__ = ["TTS", "ChunkedStream", "__version__"]
24+
25+
from livekit.agents import Plugin
26+
27+
28+
class RumikPlugin(Plugin):
29+
def __init__(self) -> None:
30+
super().__init__(__name__, __version__, __package__)
31+
32+
33+
Plugin.register_plugin(RumikPlugin())
34+
35+
# Cleanup docs of unexported modules
36+
_module = dir()
37+
NOT_IN_ALL = [m for m in _module if m not in __all__]
38+
39+
__pdoc__ = {}
40+
41+
for n in NOT_IN_ALL:
42+
__pdoc__[n] = False
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Simple logger for the plugin
2+
import logging
3+
4+
logger = logging.getLogger("livekit.plugins.rumik")
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
from typing import Literal
2+
3+
TTSModels = Literal[
4+
"muga",
5+
"mulberry",
6+
]
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Marker file for PEP 561.

0 commit comments

Comments
 (0)