Integrate the SDK

Events and logging

While a session runs, Speechineer reports what it is doing as a stream of events — progress and warnings. 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.

Anything that ends the session is not an event. It reaches you as a typed error through onError and state.error instead, so you never have to read an event to find out whether the session is still alive — see Integrate the SDK › Errors.

The event object

Every event is one object:

event is the stable identifier to branch on. level says how important it is — debug, info, warning, error or critical — and only info and above reach the browser: debug chatter stays behind. data carries the details belonging to that event.

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.event} from ${event.source}`, event.data),
});

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

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

Event types

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