Class SynthesisTask

Inheritance
object
SynthesisTask
Inherited Members
Namespace: Glitch9.AIDevKit.AmazonAws.Polly
Assembly: Glitch9.AIDevKit.Provider.AmazonAws.dll
Syntax
public class SynthesisTask

Properties

| Edit this page View Source

CreationTime

Optional. Timestamp for the time the synthesis task was started.

Declaration
[JsonProperty("CreationTime")]
public UnixTime? CreationTime { get; set; }
Property Value
Type Description
UnixTime?
| Edit this page View Source

Engine

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

Declaration
[JsonProperty("Engine")]
public string Engine { get; set; }
Property Value
Type Description
string
| Edit this page View Source

LanguageCode

Optional. Optional language code for a synthesis task.

Declaration
[JsonProperty("LanguageCode")]
public string LanguageCode { get; set; }
Property Value
Type Description
string
| Edit this page View Source

LexiconNames

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

Declaration
[JsonProperty("LexiconNames")]
public List<string> LexiconNames { get; set; }
Property Value
Type Description
List<string>
| Edit this page View Source

OutputFormat

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

Declaration
[JsonProperty("OutputFormat")]
public string OutputFormat { get; set; }
Property Value
Type Description
string
| Edit this page View Source

OutputUri

Optional. Pathway for the output speech file.

Declaration
[JsonProperty("OutputUri")]
public string OutputUri { get; set; }
Property Value
Type Description
string
| Edit this page View Source

RequestCharacters

Optional. Number of billable characters synthesized.

Declaration
[JsonProperty("RequestCharacters")]
public int? RequestCharacters { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

SampleRate

Optional. The audio frequency specified in Hz.

Declaration
[JsonProperty("SampleRate")]
public string SampleRate { get; set; }
Property Value
Type Description
string
| Edit this page View Source

SnsTopicArn

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

Declaration
[JsonProperty("SnsTopicArn")]
public string SnsTopicArn { get; set; }
Property Value
Type Description
string
| Edit this page View Source

SpeechMarkTypes

Optional. The type of speech marks returned for the input text.

Declaration
[JsonProperty("SpeechMarkTypes")]
public List<string> SpeechMarkTypes { get; set; }
Property Value
Type Description
List<string>
| Edit this page View Source

TaskId

Optional. The Amazon Polly generated identifier for a speech synthesis task.

Declaration
[JsonProperty("TaskId")]
public string TaskId { get; set; }
Property Value
Type Description
string
| Edit this page View Source

TaskStatus

Optional. Current status of the individual speech synthesis task.

Declaration
[JsonProperty("TaskStatus")]
public string TaskStatus { get; set; }
Property Value
Type Description
string
| Edit this page View Source

TaskStatusReason

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

Declaration
[JsonProperty("TaskStatusReason")]
public string TaskStatusReason { get; set; }
Property Value
Type Description
string
| Edit this page View Source

TextType

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

Declaration
[JsonProperty("TextType")]
public string TextType { get; set; }
Property Value
Type Description
string
| Edit this page View Source

VoiceId

Optional. Voice ID to use for the synthesis.

Declaration
[JsonProperty("VoiceId")]
public string VoiceId { get; set; }
Property Value
Type Description
string

Extension Methods