Class AudioCapture

General interface for any audio capture subsystem, user-implementable.

Events:

data(Float32Array[]): Audio data event. Each element of the array is a single channel of audio data.
vad(null): Audio VAD change event. Fired every time the VAD status changes.

Hierarchy

EventEmitter
- AudioCapture

Index

Constructors

constructor

Methods

Constructors

constructor

new AudioCapture(): AudioCapture

Overrides EventEmitter.constructor
- Defined in audio-capture.ts:38
Returns AudioCapture

Methods

Abstract close

close(): void

- Defined in audio-capture.ts:56
Stop this audio capture and remove any underlying data.

Returns void

emitEvent

emitEvent(ev: string, arg: any): void

Inherited from EventEmitter.emitEvent
- Defined in events.ts:70
Emit this event.

Parameters
- ev: string
  
  Event name to emit.
- arg: any
  
  Argument to the event handler(s).
Returns void

Abstract getSampleRate

getSampleRate(): number

- Defined in audio-capture.ts:45
Get the sample rate of this capture. Must never change.

Returns number

getVADState

getVADState(): VADState

- Defined in audio-capture.ts:51
Get the current VAD state. Must also send a "vad" event when this changes.

Returns VADState

off

off(ev: string, handler: EventHandler): void

Inherited from EventEmitter.off
- Defined in events.ts:55
Remove an event handler.

Parameters
- ev: string
  
  Event name.
- handler: EventHandler
  
  Handler to remove.
Returns void

on

on(ev: string, handler: EventHandler): void

Inherited from EventEmitter.on
- Defined in events.ts:33
Set an event handler.

Parameters
- ev: string
  
  Event name, or "*" for all events.
- handler: EventHandler
  
  Event handler for this event.
Returns void

once

once(ev: string, handler: EventHandler): void

Inherited from EventEmitter.once
- Defined in events.ts:44
Set a one-time event handler.

Parameters
- ev: string
  
  Event name, or "*" for all events.
- handler: EventHandler
  
  Event handler for this event.
Returns void

pipe

pipe(to: MessagePort): void

- Defined in audio-capture.ts:62
Redirect data to this MessagePort. This may suppress all future "data" messages, or may not.

Parameters
- to: MessagePort
Returns void

tee

tee(ct: number): AudioCapture[]

- Defined in audio-capture.ts:70
"Tee" this capture into the number of receivers specified.

Parameters
- ct: number
  
  Number of duplicates to make.
Returns AudioCapture[]

Generated using TypeDoc