Integrate the SDK

Events and logging

While a session runs, Speechineer's backend reports what it is doing as a stream of events — progress, warnings and failures alike. They reach your code through the session's onEvent callback (Integrate the SDK › Implementation › Wire up the voice session › onEvent) and are informational: use them for logging or a live status display. Nothing you must react to arrives only here.

The event object

Every event is one object:

type is the stable identifier to branch on — the snake_case signal name from Speechineer's backend. level says how important the event is — debug, info, warning, error or critical — and only info and above are sent to the browser: debug chatter stays on the server. payload carries the details that belong to the type.

Listen for events

Listening is a single option: you pass onEvent where you build the session, next to your other callbacks, and it is called for every event that arrives. The option is the same in every framework, and most integrations use it for one of two things — a debug log during development, or a live status display:

const voice = useSpeechToForm({
  form: intakeForm,
  onEvent: (event) => log.push(`[${event.level}] ${event.type} from ${event.source}`, event.payload),
});

readonly voice = injectSpeechToForm({
  form: intakeForm,
  onEvent: (event) => log.push(`[${event.level}] ${event.type} from ${event.source}`, event.payload),
});

const session = speechineer.speechToForm({
  form: intakeForm,
  onEvent: (event) => log.push(`[${event.level}] ${event.type} from ${event.source}`, event.payload),
});

Event types

What Speechineer's backend sends today. The type values are stable, but new ones may appear over time — ignore types you don't know.