Skip to content

Type Alias: ClientVoiceProviderDescriptor

Makaio Framework


Makaio Framework / contracts / ClientVoiceProviderDescriptor

ClientVoiceProviderDescriptor = { capabilities: STTProviderCapabilities; capabilityId: "stt"; displayName: string; id: string; runtime: "client"; } | { capabilities: TTSProviderCapabilities; capabilityId: "tts"; displayName: string; id: string; runtime: "client"; }

Defined in: ../../../packages/contracts/src/capabilities/voice/types.ts:153

JSON-serializable descriptor for a client-runtime voice provider.

Emitted across the bus for provider discovery; the actual executable implementation is registered locally via clientVoiceRuntimeRegistry.

{ capabilities: STTProviderCapabilities; capabilityId: "stt"; displayName: string; id: string; runtime: "client"; }

readonly capabilities: STTProviderCapabilities

STT structured capabilities.

readonly capabilityId: "stt"

Capability type this descriptor represents.

readonly displayName: string

Human-readable name for UI.

readonly id: string

Unique provider identifier.

readonly runtime: "client"

Always ‘client’ for client-side providers.


{ capabilities: TTSProviderCapabilities; capabilityId: "tts"; displayName: string; id: string; runtime: "client"; }

readonly capabilities: TTSProviderCapabilities

TTS structured capabilities.

readonly capabilityId: "tts"

Capability type this descriptor represents.

readonly displayName: string

Human-readable name for UI.

readonly id: string

Unique provider identifier.

readonly runtime: "client"

Always ‘client’ for client-side providers.

  • ClientVoiceProviderDescriptor
    • | { /** Unique provider identifier. */ readonly id: string; /** Human-readable name for UI. */ readonly displayName: string; /** Always 'client' for client-side providers. */ readonly runtime: 'client'; /** Capability type this descriptor represents. */ readonly capabilityId: 'stt'; /** STT structured capabilities. */ readonly capabilities: STTProviderCapabilities; } | { /** Unique provider identifier. */ readonly id: string; /** Human-readable name for UI. */ readonly displayName: string; /** Always 'client' for client-side providers. */ readonly runtime: 'client'; /** Capability type this descriptor represents. */ readonly capabilityId: 'tts'; /** TTS structured capabilities. */ readonly capabilities: TTSProviderCapabilities; }
      • { /** Unique provider identifier. */ readonly id: string; /** Human-readable name for UI. */ readonly displayName: string; /** Always 'client' for client-side providers. */ readonly runtime: 'client'; /** Capability type this descriptor represents. */ readonly capabilityId: 'stt'; /** STT structured capabilities. */ readonly capabilities: STTProviderCapabilities; }
      • { /** Unique provider identifier. */ readonly id: string; /** Human-readable name for UI. */ readonly displayName: string; /** Always 'client' for client-side providers. */ readonly runtime: 'client'; /** Capability type this descriptor represents. */ readonly capabilityId: 'tts'; /** TTS structured capabilities. */ readonly capabilities: TTSProviderCapabilities; }
type ClientVoiceProviderDescriptor = {
id: string;
displayName: string;
runtime: 'client';
capabilityId: 'stt' | 'tts';
capabilities: STTProviderCapabilities | TTSProviderCapabilities;
};