AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

C#
public class SynthesizeSpeechRequest : AmazonPollyRequest
         IAmazonWebServiceRequest

The SynthesizeSpeechRequest type exposes the following members

Constructors

NameDescription
Public Method SynthesizeSpeechRequest()

Properties

NameTypeDescription
Public Property 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.

Public Property 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.

Public Property 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", and "22050". The default value is "22050".

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

Public Property SpeechMarkTypes System.Collections.Generic.List<System.String>

Gets and sets the property SpeechMarkTypes.

The type of speech marks returned for the input text.

Public Property 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.

Public Property 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.

Public Property 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 response = client.SynthesizeSpeech(new SynthesizeSpeechRequest 
{
    LexiconNames = new List {
        "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;
integer requestCharacters = response.RequestCharacters;

            

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms