@aosengine/voice

Interfaces

CaptureEvents

The Voxy events consumed by this module.

Properties

barge-in

barge-in: object;

sequenceId

sequenceId: number;

error

error: object;

code

code: string;

message

message: string;

speech-start

speech-start: object;

sequenceId

sequenceId: number;

state-change

state-change: object;

from

from: string | null;

to

to: string;

utterance-audio

utterance-audio: object;

audio

audio: Blob;

durationMs

durationMs: number;

sequenceId

sequenceId: number;

---

VoiceCapture

Structural port implemented by VoxyCore; permits injected capture in tests.

Methods

avatarIdle()

avatarIdle(): void;

Returns

void

avatarSpeaking()

avatarSpeaking(): void;

Returns

void

isStarted()

isStarted(): boolean;

Returns

boolean

off()

off<K>(event, handler): void;

Type Parameters

Type Parameter
K extends keyof CaptureEvents

Parameters

Parameter	Type
event	K
handler	(value) => void

Returns

void

on()

on<K>(event, handler): void;

Type Parameters

Type Parameter
K extends keyof CaptureEvents

Parameters

Parameter	Type
event	K
handler	(value) => void

Returns

void

start()

start(): Promise<void>;

Returns

Promise<void>

stop()

stop(): void;

Returns

void

---

VoiceModule

Optional module with no capture, network or audio access until start.

Extends

• EngineModule.VoiceService

Properties

id

readonly id: string;

Unique id. Also the service id when init returns a service.

Inherited from

EngineModule.id

order?

readonly optional order?: number;

Sort key. Lower runs first; equal keys keep registration order.

Rough convention: input -100, gameplay -50, physics 0, rendering helpers 200. Gameplay runs before physics so that the commands a guest tick emits are simulated by the step that follows rather than the next one.

Inherited from

EngineModule.order

Methods

beginFrame()?

optional beginFrame(): void;

Run before the frame's fixed steps. Input capture lives here.

Returns

void

Inherited from

EngineModule.beginFrame

dispose()

dispose(): void;

Release everything this module took.

Returns

void

Inherited from

EngineModule.dispose

endFrame()?

optional endFrame(): void;

Run after rendering. Input's end-of-frame bookkeeping lives here.

Returns

void

Inherited from

EngineModule.endFrame

fixedUpdate()?

optional fixedUpdate(dt): void;

Run once per fixed step.

Parameters

Parameter	Type	Description
dt	number	Always ctx.config.fixedDt, whatever time.timeScale is; time scale changes how many steps a frame runs, not their length.

Returns

void

Inherited from

EngineModule.fixedUpdate

init()

init(ctx): void | object | Promise<void | object>;

Acquire resources.

Parameters

Parameter	Type	Description
ctx	EngineContext	The host surface.

Returns

void | object | Promise<void | object>

Nothing, or the service to publish under id.

Inherited from

EngineModule.init

setTranscribing()

setTranscribing(enabled): void;

Keep VAD running, but cancel pending work and require a new utterance before routing audio.

Parameters

Parameter	Type
enabled	boolean

Returns

void

Inherited from

VoiceService.setTranscribing

speaking()

speaking(active): void;

Parameters

Parameter	Type
active	boolean

Returns

void

Inherited from

VoiceService.speaking

start()

start(): Promise<void>;

Returns

Promise<void>

Inherited from

VoiceService.start

stop()

stop(): void;

Returns

void

Inherited from

VoiceService.stop

update()?

optional update(dt, alpha): void;

Run once per frame, after the fixed steps and before rendering.

Parameters

Parameter	Type	Description
dt	number	Clamped wall-clock seconds since the previous frame, scaled by time.timeScale.
alpha	number	Interpolation factor in [0, 1) for smoothing transforms.

Returns

void

Inherited from

EngineModule.update

---

VoiceOptions

Host callbacks, never called across the guest boundary.

Properties

playbackEchoGuardMs?

optional playbackEchoGuardMs?: number;

Speaker-safe mode: suppress captured speech during playback and for this many milliseconds afterward. Omit for hands-free barge-in with headphones.

Methods

createCapture()

createCapture(): 
  | VoiceCapture
| Promise<VoiceCapture>;

Create a fresh VoxyCore configured with sampleRate: 16000. Called only by start.

Returns

| VoiceCapture | Promise<VoiceCapture>

onError()

onError(message): void;

Parameters

Parameter	Type
message	string

Returns

void

onInterrupt()

onInterrupt(): void;

Returns

void

onStatus()

onStatus(status): void;

Parameters

Parameter	Type
status	string

Returns

void

onText()

onText(text): void;

Parameters

Parameter	Type
text	string

Returns

void

transcribe()

transcribe(pcm, signal): Promise<string>;

Send complete raw PCM to a credential-holding relay.

Parameters

Parameter	Type
pcm	Uint8Array<ArrayBuffer>
signal	AbortSignal

Returns

Promise<string>

---

VoiceService

Microphone lifecycle with independent transcription routing.

Extended by

• VoiceModule

Methods

setTranscribing()

setTranscribing(enabled): void;

Keep VAD running, but cancel pending work and require a new utterance before routing audio.

Parameters

Parameter	Type
enabled	boolean

Returns

void

speaking()

speaking(active): void;

Parameters

Parameter	Type
active	boolean

Returns

void

start()

start(): Promise<void>;

Returns

Promise<void>

stop()

stop(): void;

Returns

void

Functions

voice()

function voice(options): VoiceModule;

Build a Voxy lifecycle adapter. Each start after stop receives a new capture instance.

Parameters

Parameter	Type	Description
options	VoiceOptions	Capture factory, relay and presentation callbacks.

Returns

VoiceModule

A host module with explicit start/stop controls.

---

wavToPcm16()

function wavToPcm16(wav): Uint8Array<ArrayBuffer>;

Read a complete mono PCM16/16 kHz WAV utterance, rejecting other formats.

Parameters

Parameter	Type	Description
wav	ArrayBuffer	Voxy's utterance WAV bytes.

Returns

Uint8Array<ArrayBuffer>

Owned little-endian PCM bytes suitable for Parlay.