@speechineer/angular

Speechineer for Angular. Register it once with provideSpeechineer (your API key, or a token your server signs), then call one inject function per capability in a component or service: injectSpeechToForm to fill a form by voice, injectTextToForm to fill it from text. Each returns the session (start, stop, end / extract) with its state as signals (values(), transcript(), isListening(), errors(), …). The client, the form definition, the callbacks, and the state types are shared by every package and documented once in the Core reference.

Setup

The provider function: give it your credentials (or a client you created) in your application providers and every inject function uses the same client.

provideSpeechineer()

function provideSpeechineer(clientOrOptions): EnvironmentProviders;

Register Speechineer once, in your application providers. Pass the client options (apiKey / token, account, baseUrl) — or a client you created with createClient — and every inject… function uses it.

Parameters

Returns

EnvironmentProviders

Example

// app.config.ts
import { provideSpeechineer } from "@speechineer/angular";

export const appConfig: ApplicationConfig = {
  providers: [provideSpeechineer({ apiKey: environment.speechineerKey })],
};

injectSpeechineer()

function injectSpeechineer(): SpeechineerClient;

The client provideSpeechineer registered — for the rare case where you want to create a session yourself (client.speechToForm(...)) instead of using an inject function. Call it in an injection context (a constructor or a field initializer).

Returns

SpeechineerClient

Capability: Speech to form

Fill a form by voice: values stream into values() (and onFieldValue) as the user speaks; add transcript: true to also receive the spoken text.

InjectSpeechToFormOptions

The options of injectSpeechToForm: the session options every framework shares, plus an optional client to use instead of the provided one.

Extends

• SpeechToFormOptions

Properties

InjectSpeechToFormResult

type InjectSpeechToFormResult = SpeechToFormSession & SessionSignals;

What injectSpeechToForm returns: the session (start, stop, end, …) plus its state as signals.

injectSpeechToForm()

function injectSpeechToForm(options): InjectSpeechToFormResult;

Fill a form by voice. Call it in an injection context; the session is released with the component. Render from the signals (isListening(), values(), …) and drive it with start() / stop() / end().

Pass a plain object when the options never change. Pass a function when they depend on signals: it is re-read whenever those signals change, so callbacks and initialValues follow the component instead of staying at the values they had when the session was created. That matters for initialValues in particular — a session that reconnects sends the values the form holds at that moment, not the ones it started with.

Parameters

Returns

InjectSpeechToFormResult

Example

import { Component } from "@angular/core";
import { injectSpeechToForm, FormField } from "@speechineer/angular";

@Component({
  selector: "talk-to-form",
  template: `
    <button type="button" (click)="voice.isListening() ? voice.stop() : talk()">
      {{ voice.isListening() ? "Stop" : "Talk" }}
    </button>
    <input [value]="voice.values()['patientName'] ?? ''" readonly />
  `,
})
export class TalkToForm {
  readonly voice = injectSpeechToForm({
    form: { source: "inline", key: "patient-intake", version: "1", language: "en",
      fields: [FormField.text("patientName", "Extract the patient full name")] },
  });

  // A template cannot catch, and `start()` rejects when the session cannot open — the
  // same error is in `voice.errors()`, so this only keeps the rejection from going
  // unhandled.
  talk() {
    void this.voice.start().catch(() => {});
  }
}

Capability: Text to form

No recording at all — turn text the user typed or pasted into field values, as often as you like.

InjectTextToFormOptions

The options of injectTextToForm: the session options every framework shares, plus an optional client to use instead of the provided one.

Extends

• TextToFormOptions

Properties

InjectTextToFormResult

type InjectTextToFormResult = TextToFormSession & SessionSignals;

What injectTextToForm returns: the session (extract, start, end, …) plus its state as signals.

injectTextToForm()

function injectTextToForm(options): InjectTextToFormResult;

Extract field values from text. Call it in an injection context; extract(text) opens the session on first use and merges every result into values().

As with injectSpeechToForm, pass a function instead of a plain object when the options depend on signals and should follow the component.

Parameters

Returns

InjectTextToFormResult

Session state

The state as signals — one per field you typically render.

SessionSignals

The session state as signals — the same shape every framework reports, one signal per field you typically render, plus state for the whole object.

Properties