Class SynthesisTask

Namespace

Amazon.Polly.Model

Assembly

AWSSDK.Polly.dll

SynthesisTask object that provides information about a speech synthesis task.

public class SynthesisTask

Inheritance

object

SynthesisTask

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SynthesisTask()

public SynthesisTask()

Properties

CreationTime

Gets and sets the property CreationTime.

Timestamp for the time the synthesis task was started.

public DateTime CreationTime { get; set; }

Property Value

DateTime

LanguageCode

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

OutputUri

Gets and sets the property OutputUri.

Pathway for the output speech file.

public string OutputUri { get; set; }

Property Value

string

RequestCharacters

Gets and sets the property RequestCharacters.

Number of billable characters synthesized.

public int RequestCharacters { get; set; }

Property Value

int

SampleRate

Gets and sets the property SampleRate.

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", and "22050". The default value is "22050".

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>

TaskId

Gets and sets the property TaskId.

The Amazon Polly generated identifier for a speech synthesis task.

public string TaskId { get; set; }

Property Value

string

TaskStatus

Gets and sets the property TaskStatus.

Current status of the individual speech synthesis task.

public TaskStatus TaskStatus { get; set; }

Property Value

TaskStatus

TaskStatusReason

Gets and sets the property TaskStatusReason.

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

public string TaskStatusReason { 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