Skip to main content

Common plugin for GetStream

Project description

GetStream Common Plugin

This package provides shared abstract base classes and utilities for all GetStream AI plugins.

Purpose

The common plugin defines the standard interfaces that all GetStream AI plugins implement:

  • STT (Speech-to-Text): Base class for transcription plugins
  • TTS (Text-to-Speech): Base class for synthesis plugins
  • VAD (Voice Activity Detection): Base class for speech detection plugins
  • STS (Speech-to-Speech): Base class for direct speech transformation plugins

Installation

This package is automatically installed as a dependency when you install any GetStream AI plugin:

# Installing any plugin will include the common interfaces
pip install getstream-plugins-deepgram
pip install getstream-plugins-elevenlabs
# etc.

Usage

Plugin developers should inherit from these base classes:

from getstream.plugins.common import STT, TTS, VAD, STS

class MySTTPlugin(STT):
    async def process_audio(self, pcm_data):
        # Your STT implementation
        pass

class MyTTSPlugin(TTS):
    async def synthesize(self, text):
        # Your TTS implementation
        pass

Requirements

  • Python 3.10+
  • getstream[webrtc]

For Plugin Developers

If you're creating a new GetStream AI plugin, make sure to:

  1. Add getstream-plugins-common as a dependency in your pyproject.toml
  2. Inherit from the appropriate base class (STT, TTS, VAD, or STS)
  3. Implement the required abstract methods
  4. Follow the event emission patterns defined in the base classes

This ensures consistency across all GetStream AI plugins and provides users with a unified interface.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

getstream_plugins_common-0.1.0-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file getstream_plugins_common-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for getstream_plugins_common-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9688aab298b2d07e124216843b72c92960619f9568b2d4d8571bff8906404fb4
MD5 fb0d680a1b1620ba781a472c54d8ae6b
BLAKE2b-256 cc4d5db28256b3d570259cec735deb23e1a2e49cf7c16f518a37a511fcff7f9d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page