Interface SynthesisTask

SynthesisTask object that provides information about a speech synthesis task.

interface SynthesisTask {
    CreationTime?: Date;
    Engine?: Engine;
    LanguageCode?: LanguageCode;
    LexiconNames?: string[];
    OutputFormat?: OutputFormat;
    OutputUri?: string;
    RequestCharacters?: number;
    SampleRate?: string;
    SnsTopicArn?: string;
    SpeechMarkTypes?: SpeechMarkType[];
    TaskId?: string;
    TaskStatus?: TaskStatus;
    TaskStatusReason?: string;
    TextType?: TextType;
    VoiceId?: VoiceId;
}

Properties

CreationTime? Engine? LanguageCode? LexiconNames? OutputFormat? OutputUri? RequestCharacters? SampleRate? SnsTopicArn? SpeechMarkTypes? TaskId? TaskStatus? TaskStatusReason? TextType? VoiceId?

Properties

Optional CreationTime

CreationTime?: Date

Timestamp for the time the synthesis task was started.

Optional Engine

Engine?: Engine

Specifies the engine (standard, neural, long-form or generative) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

Optional LanguageCode

LanguageCode?: LanguageCode

Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

Optional LexiconNames

LexiconNames?: string[]

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.

Optional OutputFormat

OutputFormat?: OutputFormat

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

Optional OutputUri

OutputUri?: string

Pathway for the output speech file.

Optional RequestCharacters

RequestCharacters?: number

Number of billable characters synthesized.

Optional SampleRate

SampleRate?: string

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000".

Valid values for pcm are "8000" and "16000" The default value is "16000".

Optional SnsTopicArn

SnsTopicArn?: string

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

Optional SpeechMarkTypes

SpeechMarkTypes?: SpeechMarkType[]

The type of speech marks returned for the input text.

Optional TaskId

TaskId?: string

The Amazon Polly generated identifier for a speech synthesis task.

Optional TaskStatus

TaskStatus?: TaskStatus

Current status of the individual speech synthesis task.

Optional TaskStatusReason

TaskStatusReason?: string

Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

Optional TextType

TextType?: TextType

Specifies whether the input text is plain text or SSML. The default value is plain text.

Optional VoiceId

VoiceId?: VoiceId

Voice ID to use for the synthesis.

Settings

Member Visibility

Theme

On This Page