Class SpeechSession

Hierarchy

EventEmitter
- SpeechSession

Index

Constructors

Methods

on emit getState start stop flush close ingestFrame transcribeAudio speak interrupt

Constructors

constructor

new SpeechSession(config?, providers?): SpeechSession
Parameters
- config: SpeechSessionConfig = {}
- providers: SpeechSessionProviders = {}
Returns SpeechSession
Overrides EventEmitter.constructor
- Defined in src/speech/SpeechSession.ts:52

Methods

on

on<U>(event, listener): this
Type Parameters
- U extends keyof SpeechSessionEventMap
Parameters
- event: U
- listener: SpeechSessionEventMap[U]
Returns this
Overrides EventEmitter.on
- Defined in src/speech/SpeechSession.ts:38

emit

emit<U>(event, ...args): boolean
Type Parameters
- U extends keyof SpeechSessionEventMap
Parameters
- event: U
- Rest ...args: Parameters<SpeechSessionEventMap[U]>
Returns boolean
Overrides EventEmitter.emit
- Defined in src/speech/SpeechSession.ts:45

getState

getState(): SpeechSessionState
Returns SpeechSessionState
- Defined in src/speech/SpeechSession.ts:76

start

start(): Promise<void>
Returns Promise<void>
- Defined in src/speech/SpeechSession.ts:80

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in src/speech/SpeechSession.ts:95

flush

flush(reason?): Promise<void>
Parameters
- reason: SpeechSessionBoundaryReason = 'manual'
Returns Promise<void>
- Defined in src/speech/SpeechSession.ts:100

close

close(): Promise<void>
Returns Promise<void>
- Defined in src/speech/SpeechSession.ts:104

ingestFrame

ingestFrame(frame): Promise<void>
Parameters
- frame: Float32Array<ArrayBufferLike>
Returns Promise<void>
- Defined in src/speech/SpeechSession.ts:111

transcribeAudio

transcribeAudio(audioBuffer, options?, captureOverride?): Promise<void>
Parameters
- audioBuffer: Buffer<ArrayBufferLike>
- options: SpeechTranscriptionOptions = {}
- Optional captureOverride: SpeechSessionAudioCapture
Returns Promise<void>
- Defined in src/speech/SpeechSession.ts:153

speak

speak(text, options?): Promise<SpeechSynthesisResult>
Parameters
- text: string
- options: SpeechSynthesisOptions = {}
Returns Promise<SpeechSynthesisResult>
- Defined in src/speech/SpeechSession.ts:186

interrupt

interrupt(): void
Returns void
- Defined in src/speech/SpeechSession.ts:207