Table of Contents

Class SynthesizeSpeechRequest

Namespace
Amazon.Polly.Model
Assembly
AWSSDK.Polly.dll

Container for the parameters to the SynthesizeSpeech operation. Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works.

public class SynthesizeSpeechRequest : AmazonPollyRequest
Inheritance
SynthesizeSpeechRequest

Constructors

SynthesizeSpeechRequest() 

public SynthesizeSpeechRequest()

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 Synthesize Speech 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. For information about storing lexicons, see PutLexicon. 

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.

When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format. 

public OutputFormat OutputFormat { get; set; }

Property Value

OutputFormat

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

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.

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. For more information, see Using SSML. 

public TextType TextType { get; set; }

Property Value

TextType

VoiceId

Gets and sets the property VoiceId.

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation. 

public VoiceId VoiceId { get; set; }

Property Value

VoiceId