Class DescribeVoicesRequest

Namespace

Amazon.Polly.Model

Assembly

AWSSDK.Polly.dll

Container for the parameters to the DescribeVoices operation. Returns the list of voices that are available for use when requesting speech synthesis. Each voice speaks a specified language, is either male or female, and is identified by an ID, which is the ASCII version of the voice name.

When synthesizing speech (

SynthesizeSpeech

), you provide the voice ID for the voice you want from the list of voices returned by

DescribeVoices

.

For example, you want your news reader application to read news in a specific language, but giving a user the option to choose the voice. Using the

DescribeVoices

operation you can provide the user with a list of available voices to select from.

You can optionally specify a language code to filter the available voices. For example, if you specify

en-US

, the operation returns a list of all available US English voices.

This operation requires permissions to perform the

polly:DescribeVoices

action.

public class DescribeVoicesRequest : AmazonPollyRequest

Inheritance

object

AmazonPollyRequest

DescribeVoicesRequest

Constructors

DescribeVoicesRequest()

public DescribeVoicesRequest()

Properties

Engine

Gets and sets the property Engine.

Specifies the engine (

standard

or

neural

) used by Amazon Polly when processing input text for speech synthesis.

public Engine Engine { get; set; }

Property Value

Engine

IncludeAdditionalLanguageCodes

Gets and sets the property IncludeAdditionalLanguageCodes.

Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify

yes

but not if you specify

no

.

public bool IncludeAdditionalLanguageCodes { get; set; }

Property Value

bool

LanguageCode

Gets and sets the property LanguageCode.

The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.

public LanguageCode LanguageCode { get; set; }

Property Value

LanguageCode

NextToken

Gets and sets the property NextToken.

An opaque pagination token returned from the previous

DescribeVoices

operation. If present, this indicates where to continue the listing.

public string NextToken { get; set; }

Property Value

string