Skip to main content
Yanked

This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 1.1.2 instead.
Reason given by maintainers: New interface

RealtimeSTT

Easy-to-use, low-latency speech-to-text library for realtime applications

About the Project

RealtimeSTT listens to the microphone and transcribes voice into text.

It's ideal for:

  • Voice Assistants
  • Applications requiring fast and precise speech-to-text conversion

Features

  • Voice Activity Detection: Automatically detects when you start and stop speaking.
  • Wake Word Activation: Only starts transcription upon hearing a specific wake word.
  • Realtime Transcription: Transforms speech to text in real-time.

Hint: Check out RealtimeTTS, the output counterpart of this library, for text-to-voice capabilities. Together, they form a powerful realtime audio wrapper around large language models.

Tech Stack

This library uses:

  • Voice Activity Detection
    • WebRTCVAD for initial voice activity detection.
    • SileroVAD for more accurate verification.
  • Speech-To-Text
  • Wake Word Detection

These components represent the "industry standard" for cutting-edge applications, providing the most modern and effective foundation for building high-end solutions.

Installation

pip install RealtimeSTT

This will install all the necessary dependencies, including a CPU support only version of PyTorch.

Additional steps are needed for a GPU-optimized installation. These steps are recommended for those who require better performance and have a compatible NVIDIA GPU.

To use RealtimeSTT with GPU support via CUDA please follow these steps:

  1. Install NVIDIA CUDA Toolkit 11.8:

  2. Install NVIDIA cuDNN 8.7.0 for CUDA 11.x:

    • Visit NVIDIA cuDNN Archive.
    • Click on "Download cuDNN v8.7.0 (November 28th, 2022), for CUDA 11.x".
    • Download and install the software.
  3. Install PyTorch with CUDA support:

    pip uninstall torch
    pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118
    

Note: To check if your NVIDIA GPU supports CUDA, visit the official CUDA GPUs list.

Quick Start

Basic usage:

Manual Recording

Start and stop of recording are manually triggered.

recorder.start()
recorder.stop()
print(recorder.text())

Automatic Recording

Recording based on voice activity detection.

recorder = AudioToTextRecorder()
print(recorder.text())

Wakewords

Keyword activation before detecting voice. Write the comma-separated list of your desired activation keywords into the wake_words parameter. You can choose wake words from these list: alexa, americano, blueberry, bumblebee, computer, grapefruits, grasshopper, hey google, hey siri, jarvis, ok google, picovoice, porcupine, terminator.

recorder = AudioToTextRecorder(wake_words="jarvis")

print('Say "Jarvis" then speak.')
print(recorder.text())

Callbacks

You can set callback functions to be executed on different events (see Configuration) :

def my_start_callback():
    print("Recording started!")

def my_stop_callback():
    print("Recording stopped!")

recorder = AudioToTextRecorder(on_recording_started=my_start_callback,
                               on_recording_finished=my_stop_callback)

Testing the Library

The test subdirectory contains a set of scripts to help you evaluate and understand the capabilities of the RealtimeTTS library.

  • simple_test.py

    • Description: A "hello world" styled demonstration of the library's simplest usage.
  • wakeword_test.py

    • Description: A demonstration of the wakeword activation.
  • translator.py

    • Dependencies: Run pip install openai realtimetts.
    • Description: Real-time translations into six different languages.
  • openai_voice_interface.py

    • Dependencies: Run pip install openai realtimetts.
    • Description: Wake word activated and voice based user interface to the OpenAI API.
  • advanced_talk.py

    • Dependencies: Run pip install openai keyboard realtimetts.
    • Description: Choose TTS engine and voice before starting AI conversation.
  • minimalistic_talkbot.py

    • Dependencies: Run pip install openai realtimetts.
    • Description: A basic talkbot in 20 lines of code.

Configuration

Initialization Parameters for AudioToTextRecorder

When you initialize the AudioToTextRecorder class, you have various options to customize its behavior.

General Parameters

  • model (str, default="tiny"): Model size or path for transcription.

    • Options: 'tiny', 'tiny.en', 'base', 'base.en', 'small', 'small.en', 'medium', 'medium.en', 'large-v1', 'large-v2'.
    • Note: If a size is provided, the model will be downloaded from the Hugging Face Hub.
  • language (str, default=""): Language code for transcription. If left empty, the model will try to auto-detect the language.

  • on_recording_start: A callable function triggered when recording starts.

  • on_recording_stop: A callable function triggered when recording ends.

  • on_transcription_start: A callable function triggered when transcription starts.

  • spinner (bool, default=True): Provides a spinner animation text with information about the current recorder state.

  • level (int, default=logging.WARNING): Logging level.

Voice Activation Parameters

  • silero_sensitivity (float, default=0.6): Sensitivity for Silero's voice activity detection ranging from 0 (least sensitive) to 1 (most sensitive). Default is 0.6.

  • webrtc_sensitivity (int, default=3): Sensitivity for the WebRTC Voice Activity Detection engine ranging from 1 (least sensitive) to 3 (most sensitive). Default is 3.

  • post_speech_silence_duration (float, default=0.2): Duration in seconds of silence that must follow speech before the recording is considered to be completed. This ensures that any brief pauses during speech don't prematurely end the recording.

  • min_gap_between_recordings (float, default=1.0): Specifies the minimum time interval in seconds that should exist between the end of one recording session and the beginning of another to prevent rapid consecutive recordings.

  • min_length_of_recording (float, default=1.0): Specifies the minimum duration in seconds that a recording session should last to ensure meaningful audio capture, preventing excessively short or fragmented recordings.

  • pre_recording_buffer_duration (float, default=0.2): The time span, in seconds, during which audio is buffered prior to formal recording. This helps counterbalancing the latency inherent in speech activity detection, ensuring no initial audio is missed.

  • on_vad_detect_start: A callable function triggered when the system starts to listen for voice activity.

  • on_vad_detect_stop: A callable function triggered when the system stops to listen for voice activity.

Wake Word Parameters

  • wake_words (str, default=""): Wake words for initiating the recording. Multiple wake words can be provided as a comma-separated string. Supported wake words are: alexa, americano, blueberry, bumblebee, computer, grapefruits, grasshopper, hey google, hey siri, jarvis, ok google, picovoice, porcupine, terminator

  • wake_words_sensitivity (float, default=0.6): Sensitivity level for wake word detection (0 for least sensitive, 1 for most sensitive).

  • wake_word_activation_delay (float, default=0): Duration in seconds after the start of monitoring before the system switches to wake word activation if no voice is initially detected. If set to zero, the system uses wake word activation immediately.

  • wake_word_timeout (float, default=5): Duration in seconds after a wake word is recognized. If no subsequent voice activity is detected within this window, the system transitions back to an inactive state, awaiting the next wake word or voice activation.

  • on_wakeword_detected: A callable function triggered when a wake word is detected.

  • on_wakeword_timeout: A callable function triggered when the system goes back to an inactive state after when no speech was detected after wake word activation.

  • on_wakeword_detection_start: A callable function triggered when the system starts to listen for wake words

  • on_wakeword_detection_end: A callable function triggered when stopping to listen for wake words (e.g. because of timeout or wake word detected)

Contribution

Contributions are always welcome!

License

MIT

Author

Kolja Beigel
Email: kolja.beigel@web.de
GitHub

Metadata

Release files for realtimestt 0.1.28

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for realtimestt 0.1.28
File Size Uploaded Provenance Actions
RealTimeSTT-0.1.28.tar.gz 11.2 kB Without provenance Details for RealTimeSTT-0.1.28.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for realtimestt 0.1.28
File Interpreter ABI Platform Actions
RealTimeSTT-0.1.28-py3-none-any.whl Python 3 none any Details for RealTimeSTT-0.1.28-py3-none-any.whl

Total release size: 23.1 kB

Release files / RealTimeSTT-0.1.28.tar.gz

Download URL RealTimeSTT-0.1.28.tar.gz
Size 11.2 kB
Tags Source
SHA-256 checksum
How to use checksums
065112e3bc25adf47d8548dcead7439f8a511fd52d4d4dedfaac8cb838a5a8b0
BLAKE2b-256 checksum
How to use checksums
85a5116e08fb041d58fcda9690b33df872cda97625e23cd32324067cf46c9df0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.4

Release files / RealTimeSTT-0.1.28-py3-none-any.whl

Download URL RealTimeSTT-0.1.28-py3-none-any.whl
Size 11.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dea0f012f6f383bb4192bfa5ca2a723b9a6d49db26a9de9aca1c49e839628623
BLAKE2b-256 checksum
How to use checksums
f978e9739d326130ecddb5b969fdfcbc2abb9205fecc96783d257966861835bb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.4

Security for realtimestt 0.1.28

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.28 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page