Interface: ITTSProvider
Makaio Framework / contracts / ITTSProvider
Interface: ITTSProvider
Section titled “Interface: ITTSProvider”Defined in: ../../../packages/contracts/src/capabilities/voice/types.ts:107
Text-to-speech capability provider.
Providers implement audio synthesis for the voice pipeline. The response is an async iterable so callers can stream audio to the client progressively without buffering the full utterance.
Extends
Section titled “Extends”Properties
Section titled “Properties”capabilities
Section titled “capabilities”
readonlycapabilities:TTSProviderCapabilities
Defined in: ../../../packages/contracts/src/capabilities/voice/types.ts:113
Structured capabilities for provider selection.
capabilityId
Section titled “capabilityId”
readonlycapabilityId:"tts"
Defined in: ../../../packages/contracts/src/capabilities/voice/types.ts:109
Discriminant that identifies the TTS capability slot in the registry.
displayName
Section titled “displayName”
readonlydisplayName:string
Defined in: ../../../packages/contracts/src/capability/types.ts:11
Human-readable name for display in UI
Inherited from
Section titled “Inherited from”ICapabilityProvider.displayName
readonlyid:string
Defined in: ../../../packages/contracts/src/capability/types.ts:9
Unique identifier for this provider instance
Inherited from
Section titled “Inherited from”providerKey?
Section titled “providerKey?”
readonlyoptionalproviderKey?:string
Defined in: ../../../packages/contracts/src/capability/types.ts:17
Stable provider identity used for joins across registries.
Unlike id, this should remain stable across runtime re-registration.
Inherited from
Section titled “Inherited from”ICapabilityProvider.providerKey
runtime
Section titled “runtime”
readonlyruntime:ProviderRuntime
Defined in: ../../../packages/contracts/src/capabilities/voice/types.ts:111
Where this provider runs.
Methods
Section titled “Methods”isAvailable()
Section titled “isAvailable()”isAvailable():
Promise<boolean>
Defined in: ../../../packages/contracts/src/capabilities/voice/types.ts:126
Check whether this provider is ready to accept requests.
Returns
Section titled “Returns”Promise<boolean>
true when the underlying adapter is initialised and reachable
synthesize()
Section titled “synthesize()”synthesize(
request):AsyncIterable<AudioChunk>
Defined in: ../../../packages/contracts/src/capabilities/voice/types.ts:120
Synthesize text into a stream of PCM audio chunks.
Parameters
Section titled “Parameters”request
Section titled “request”Text content and optional language preference
Returns
Section titled “Returns”AsyncIterable<AudioChunk>
Async iterable of audio chunks, delivered in order
validate()?
Section titled “validate()?”
optionalvalidate():Promise<{error?:string;valid:boolean; }>
Defined in: ../../../packages/contracts/src/capability/types.ts:22
Optional validation method to check provider configuration/credentials.
Returns
Section titled “Returns”Promise<{ error?: string; valid: boolean; }>
Validation result with optional error message