An instance of a text-to-speech adapter.

Remarks

This class is abstract, and as such cannot be used directly. Instead, use a provider plugin that exports its own child TTS class, which inherits this class's methods.

Hierarchy (view full)

Constructors

  • Create a new instance of Rime TTS.

    Parameters

    • opts: Partial<TTSOptions> = defaultTTSOptions

      Configuration options for the TTS instance

    Returns TTS

    Remarks

    apiKey must be set to your Rime AI API key, either using the argument or by setting the RIME_API_KEY environmental variable.

Properties

label: string = 'rime.TTS'

Accessors

  • get capabilities(): TTSCapabilities
  • Returns this TTS's capabilities

    Returns TTSCapabilities

  • get numChannels(): number
  • Returns the channel count of audio frames returned by this TTS

    Returns number

  • get sampleRate(): number
  • Returns the sample rate of audio frames returned by this TTS

    Returns number

Methods