Aws

AWSPollyTTS

AWS Polly text-to-speech provider. Creates a configured AWS Polly TTS provider (24 kHz output) for use in a voice agent.

Constructor

new AWSPollyTTS(opts: AWSPollyTTSOptions)

awsAccessKeyId

string

AWS access key ID. Falls back to the AWS_ACCESS_KEY_ID env var.

awsSecretAccessKey

string

AWS secret access key.

awsSessionToken

string

Optional AWS session token for temporary credentials.

region

string

AWS region. Default: 'us-east-1'.

voice

string

Polly voice ID. Default: 'Joanna'.

engine

string

Polly synthesis engine, e.g. 'neural' or 'standard'. Default: 'neural'.

speed

number

Speaking speed multiplier.

pitch

number

Voice pitch adjustment.

close

close(): Promise<void>

Release any resources held by the provider.

closeEmitter

closeEmitter(): Promise<void>

Close the emitter: drop all handlers and stop emitting. Waits up to 2 seconds for in-flight async handlers to settle before returning.

emit

emit(event: string, ...args: any[]): void

event

string

required

getRuntimeConfig

getRuntimeConfig(): Record<string, any>

returns

Record<string, any>

interrupt

interrupt(): Promise<void>

Stop the current synthesis.

listenerCount

listenerCount(event: string): number

event

string

required

returns

number

off

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

event

string

required

handler

EventHandler

required

on

on(event: string, handler: EventHandler): EventHandler

event

string

required

handler

EventHandler

required

returns

EventHandler

once

once(event: string, handler: EventHandler): EventHandler

event

string

required

handler

EventHandler

required

returns

EventHandler

onFirstAudioByte

onFirstAudioByte(callback: FirstAudioByteCallback): void

callback

FirstAudioByteCallback

required

removeAllListeners

removeAllListeners(event?: string): void

event

string

synthesize

synthesize(text: any, ..._extra: any[]): Promise<void>

Synthesize and speak text on the active session.

text

any

required

Node JS SDK

Core

Speech-to-text

LLM

Text-to-speech

Realtime models

Avatars

Turn detection

Voice activity detection

Noise cancellation

AWSPollyTTS

Constructor

close

closeEmitter

emit

getRuntimeConfig

interrupt

listenerCount

off

on

once

onFirstAudioByte

removeAllListeners

synthesize

​AWSPollyTTS

​Constructor

​close

​closeEmitter

​emit

​getRuntimeConfig

​interrupt

​listenerCount

​off

​on

​once

​onFirstAudioByte

​removeAllListeners

​synthesize

AWSPollyTTS

Constructor

close

closeEmitter

emit

getRuntimeConfig

interrupt

listenerCount

off

on

once

onFirstAudioByte

removeAllListeners

synthesize