Interface AudioStreamRequest

Request details to stream audio from text.

interface AudioStreamRequest {
    audioFormat?: AudioStreamFormat;
    input: string;
    language?: string;
    model?: VoiceModelName;
    options?: AudioSpeechRequestOptions;
    voiceId: string;
}

Properties

audioFormat? input language? model? options? voiceId

Properties

OptionalaudioFormat

audioFormat?: AudioStreamFormat

The audio format of the synthesized speech.

Default

"mp3"

input

input: string

The text to be synthesized, either SSML or plain text.

Optionallanguage

language?: string

The language code of the text. Read about the supported languages here.

Example

"en-US"

Optionalmodel

model?: VoiceModelName

The voice model to be used for the synthesis. Read about the supported models here.

Optionaloptions

options?: AudioSpeechRequestOptions

Additional options for the synthesis.

voiceId

voiceId: string

The voice ID to be used for the synthesis.

See

VoicesListEntry.id

Settings

Member Visibility

On This Page

Properties