SynthesizeSpeechRequest Class | AWS SDK for .NET V3

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Polly.AmazonPollyRequest
      Amazon.Polly.Model.SynthesizeSpeechRequest

Namespace: Amazon.Polly.Model
Assembly: AWSSDK.Polly.dll
Version: 3.x.y.z

Syntax

public class SynthesizeSpeechRequest : AmazonPollyRequest
         IAmazonWebServiceRequest

The SynthesizeSpeechRequest type exposes the following members

Constructors

	Name	Description
	SynthesizeSpeechRequest()

Properties

Name	Type	Description
Engine	Amazon.Polly.Engine	Gets and sets the property Engine. Specifies the engine (`standard`, `neural` or `long-form`) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices. NTTS-only voices When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to `neural`. If the engine is not specified, or is set to `standard`, this will result in an error. long-form-only voices When using long-form-only voices such as Danielle (en-US), this parameter is required and must be set to `long-form`. If the engine is not specified, or is set to `standard` or `neural`, this will result in an error. Type: String Valid Values: `standard` \| `neural` \| `long-form` Required: Yes Standard voices For standard voices, this is not required; the engine parameter defaults to `standard`. If the engine is not specified, or is set to `standard` and an NTTS-only voice is selected, this will result in an error.
LanguageCode	Amazon.Polly.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 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.
LexiconNames	System.Collections.Generic.List<System.String>	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.
OutputFormat	Amazon.Polly.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.
SampleRate	System.String	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". The default value for long-form voices is "24000". Valid values for pcm are "8000" and "16000" The default value is "16000".
SpeechMarkTypes	System.Collections.Generic.List<System.String>	Gets and sets the property SpeechMarkTypes. The type of speech marks returned for the input text.
Text	System.String	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.
TextType	Amazon.Polly.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.
VoiceId	Amazon.Polly.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.

Examples

Synthesizes plain text or SSML into a file of human-like speech.

To synthesize speech


var client = new AmazonPollyClient();
var response = client.SynthesizeSpeech(new SynthesizeSpeechRequest 
{
    LexiconNames = new List<string> {
        "example"
    },
    OutputFormat = "mp3",
    SampleRate = "8000",
    Text = "All Gaul is divided into three parts",
    TextType = "text",
    VoiceId = "Joanna"
});

MemoryStream audioStream = response.AudioStream;
string contentType = response.ContentType;
int requestCharacters = response.RequestCharacters;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5