Class ChunkedStreamv2

Batch synthesis against POST /v2/speak.

Hierarchy (view full)

tts.ChunkedStream
- ChunkedStreamv2

Index

Constructors

Properties

Accessors

abortSignal inputText

Methods

[asyncIterator] close collect next

Constructors

constructor

new ChunkedStreamv2(tts, text, opts, connOptions?, abortSignal?): ChunkedStreamv2
Parameters
- tts: TTSv2
- text: string
- opts: TTSv2Options
- Optional connOptions: APIConnectOptions
- Optional abortSignal: AbortSignal
Returns ChunkedStreamv2
Overrides ChunkedStream.constructor
- Defined in plugins/deepgram/src/tts_v2.ts:269

Properties

label

label: string = 'deepgram.ChunkedStreamv2'

Accessors

abortSignal

get abortSignal(): AbortSignal
Returns AbortSignal
Inherited from tts.ChunkedStream.abortSignal
- Defined in agents/dist/tts/tts.d.ts:359

inputText

get inputText(): string
Returns string
Inherited from tts.ChunkedStream.inputText
- Defined in agents/dist/tts/tts.d.ts:358

Methods

[asyncIterator]

[asyncIterator](): tts.ChunkedStream
Returns tts.ChunkedStream
Inherited from ChunkedStream.[asyncIterator]
- Defined in agents/dist/tts/tts.d.ts:381

close

close(): void
Close both the input and output of the TTS stream

Returns void
Inherited from ChunkedStream.close
- Defined in agents/dist/tts/tts.d.ts:380

collect

collect(): Promise<AudioFrame>
Collect every frame into one in a single call

Returns Promise<AudioFrame>
Inherited from ChunkedStream.collect
- Defined in agents/dist/tts/tts.d.ts:377

next

next(): Promise<IteratorResult<SynthesizedAudio, any>>
Returns Promise<IteratorResult<SynthesizedAudio, any>>
Inherited from ChunkedStream.next
- Defined in agents/dist/tts/tts.d.ts:378