Python wrapper for the full elevenlabs API.
The main reason is the different approach to playback. By doing playback purely within python instead of piping to an external process, there are a couple of important extra things that can be done, such as:
- Playback on a specific output device
- Running functions exactly when the playback begins and ends
- Controlling the playback from within python
Documentation now available at https://elevenlabslib.readthedocs.io/en/latest/
Just run pip install elevenlabslib, it's on pypi.
Note: On Linux, you may need to install portaudio. On debian and derivatives, it's sudo apt-get install libportaudio2, and possibly also sudo apt-get install python3-pyaudio.
IMPORTANT: The library requires libsndfile v1.1.0 or newer, as that is when mp3 support was introduced. This won't be an issue on Windows, but may be relevant on other platforms. Check the soundfile repo for more information.
For a far more comprehensive example, check example.py or the docs.
Here is a very simple usage sample.
- Retrieves a voice based on the name
- Plays back (using the included playback functions that use sounddevice) all its samples (and the preview)
- Generates and plays back a new audio
- Deletes the newly created audio from the user history
from elevenlabslib import *
user = User("API_KEY")
voice = user.get_voices_by_name_v2("Rachel")[0] # This is a list because multiple voices can have the same name
voice.generate_play_audio_v2("Test.", playbackOptions=PlaybackOptions(runInBackground=False))
for historyItem in user.get_history_items_paginated():
if historyItem.text == "Test.":
# The first items are the newest, so we can stop as soon as we find one.
historyItem.delete()
break