Skip to content

voice

FieldValue
Prefixvoice
Namespace constantVoiceNamespace
Subjects constantVoiceSubjects
Kindbus
Schema recordVoiceSchemas
Tierframework
Package@makaio/contracts
Defined inpackages/contracts/src/capabilities/voice/namespace.ts
KeyWireTypeSchema
session.startvoice.session.startrpcschemas.ts
session.stopvoice.session.stoprpcschemas.ts
statusvoice.statuseventschemas.ts
synthesis.endvoice.synthesis.endeventschemas.ts
synthesis.startvoice.synthesis.starteventschemas.ts
transcriptionvoice.transcriptioneventschemas.ts

Start a voice session and receive the resolved pipeline strategy.

The response is a discriminated union on audioTransport:

  • 'none' — all processing is client-side; no WebSocket is needed.
  • 'ws' — server-side audio transport; connect to audioWsUrl using bindToken.

Subject: voice.session.start Type: Request (RPC)

Request:

FieldTypeRequired
sessionIdstringyes

Response:

FieldTypeRequired
audioTransport"none" | "ws"yes
strategy{ stt: { runtime: "server" | "client"; providerId: string; providerName: string; }; tts: { runtime: "server" | "client"; providerId: string; providerName: string; }; }yes

Stop an active voice session.

Subject: voice.session.stop Type: Request (RPC)

Request:

FieldTypeRequired
sessionIdstringyes

Response:

Empty object.

Emitted when the voice pipeline state changes.

Subject: voice.status Type: Event

FieldTypeRequired
sessionIdstringyes
state"error" | "idle" | "recording" | "transcribing" | "synthesizing"yes

Emitted when TTS synthesis completes for a message.

Subject: voice.synthesis.end Type: Event

FieldTypeRequired
messageIdstring | undefinedno
sessionIdstringyes

Emitted when TTS synthesis begins for a message.

Subject: voice.synthesis.start Type: Event

FieldTypeRequired
messageIdstring | undefinedno
sessionIdstringyes

Emitted when a complete transcription is available for a session.

Subject: voice.transcription Type: Event

FieldTypeRequired
confidencenumber | undefinedno
languagestringyes
messageIdstring | undefinedno
sessionIdstringyes
textstringyes

Auto-generated by yarn docs:bus. Do not edit manually.