Class TTSAbstract

constructor

• new TTS(sampleRate, numChannels, capabilities): tts.TTS

• Parameters

  • sampleRate: number
  • numChannels: number
  • capabilities: TTSCapabilities

  Returns tts.TTS

Abstract label

capabilities

• get capabilities(): TTSCapabilities

• Returns this TTS's capabilities

  Returns TTSCapabilities

model

• get model(): string

• Get the model name/identifier for this TTS instance.

  Returns string

  The model name if available, "unknown" otherwise.

  Remarks

  Plugins should override this property to provide their model information.

numChannels

• get numChannels(): number

• Returns the channel count of audio frames returned by this TTS

  Returns number

provider

• get provider(): string

• Get the provider name for this TTS instance.

  Returns string

  The provider name if available, "unknown" otherwise.

  Remarks

  Plugins should override this property to provide their provider information.

sampleRate

• get sampleRate(): number

• Returns the sample rate of audio frames returned by this TTS

  Returns number

close

• close(): Promise<void>

• Returns Promise<void>

Abstract stream

• stream(options?): tts.SynthesizeStream

• Returns a SynthesizeStream that can be used to push text and receive audio data

  Parameters

  • Optional options: {
        connOptions?: APIConnectOptions;
    }

    Optional configuration including connection options

    • Optional connOptions?: APIConnectOptions

  Returns tts.SynthesizeStream

Abstract synthesize

• synthesize(text, connOptions?, abortSignal?): tts.ChunkedStream

• Receives text and returns synthesis in the form of a ChunkedStream

  Parameters

  • text: string
  • Optional connOptions: APIConnectOptions
  • Optional abortSignal: AbortSignal

  Returns tts.ChunkedStream