Class StartSpeechSynthesisTaskRequest

Namespace

Amazon.Polly.Model

Assembly

AWSSDK.Polly.dll

Container for the parameters to the StartSpeechSynthesisTask operation. Allows the creation of an asynchronous synthesis task, by starting a new

SpeechSynthesisTask

. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status.

public class StartSpeechSynthesisTaskRequest : AmazonPollyRequest

Inheritance

object

AmazonPollyRequest

StartSpeechSynthesisTaskRequest

Constructors

StartSpeechSynthesisTaskRequest()

public StartSpeechSynthesisTaskRequest()

Properties

Engine

Gets and sets the property Engine.

Specifies the engine (

standard

or

neural

) 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.

public Engine Engine { get; set; }

Property Value

Engine

LanguageCode

Gets and sets the property LanguageCode.

Optional language code for the Speech Synthesis request. 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 will use 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.

public LanguageCode LanguageCode { get; set; }

Property Value

LanguageCode

LexiconNames

Gets and sets the property LexiconNames.

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.

public List<string> LexiconNames { get; set; }

Property Value

List<string>

OutputFormat

Gets and sets the property 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.

public OutputFormat OutputFormat { get; set; }

Property Value

OutputFormat

OutputS3BucketName

Gets and sets the property OutputS3BucketName.

Amazon S3 bucket name to which the output file will be saved.

public string OutputS3BucketName { get; set; }

Property Value

string

OutputS3KeyPrefix

Gets and sets the property OutputS3KeyPrefix.

The Amazon S3 key prefix for the output speech file.

public string OutputS3KeyPrefix { get; set; }

Property Value

string

SampleRate

Gets and sets the property SampleRate.

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".

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

public string SampleRate { get; set; }

Property Value

string

SnsTopicArn

Gets and sets the property SnsTopicArn.

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

public string SnsTopicArn { get; set; }

Property Value

string

SpeechMarkTypes

Gets and sets the property SpeechMarkTypes.

The type of speech marks returned for the input text.

public List<string> SpeechMarkTypes { get; set; }

Property Value

List<string>

Text

Gets and sets the property Text.

The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

public string Text { get; set; }

Property Value

string

TextType

Gets and sets the property TextType.

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

public TextType TextType { get; set; }

Property Value

TextType

VoiceId

Gets and sets the property VoiceId.

Voice ID to use for the synthesis.

public VoiceId VoiceId { get; set; }

Property Value

VoiceId