Class TTS

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

constructor

Properties

label

Accessors

capabilities model numChannels provider sampleRate

Methods

close stream synthesize

Constructors

constructor

Properties

label

label: string = 'resemble.TTS'

Accessors

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

Methods

close

  • close(): Promise<void>

  • Returns Promise<void>

stream

synthesize

Settings

Member Visibility

Theme

On This Page

constructorlabelcapabilitiesmodelnumChannelsprovidersampleRateclosestreamsynthesize