Interface TextToSpeechStreamCapability<TInput, TOutput>

Description

Capability contract for TextToSpeechStreamCapability.

interface TextToSpeechStreamCapability<
    TInput = unknown,
    TOutput = NormalizedAudio[],
> {
    textToSpeechStream(
        request: AIRequest<TInput>,
        ctx: MultiModalExecutionContext,
        signal?: AbortSignal,
    ): AsyncGenerator<AIResponseChunk<TOutput>>;
}

Type Parameters

TInput = unknown
TOutput = NormalizedAudio[]

Hierarchy (View Summary)

ProviderCapability
- TextToSpeechStreamCapability

Implemented by

Index

Methods

textToSpeechStream

Methods

textToSpeechStream

textToSpeechStream(
    request: AIRequest<TInput>,
    ctx: MultiModalExecutionContext,
    signal?: AbortSignal,
): AsyncGenerator<AIResponseChunk<TOutput>>
Stream speech synthesis output from text.
Parameters
- request: AIRequest<TInput>
  Unified AI request containing TTS input
- ctx: MultiModalExecutionContext
  Execution context
- Optionalsignal: AbortSignal
  Optional abort signal
Returns AsyncGenerator<AIResponseChunk<TOutput>>
AsyncGenerator yielding partial and final audio output
- Defined in src/core/provider/capabilities/AudioCapability.ts:136