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

Inheritance Hierarchy

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

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

Syntax

C#
public class DescribeVoicesRequest : AmazonPollyRequest
         IAmazonWebServiceRequest

The DescribeVoicesRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeVoicesRequest()

Properties

NameTypeDescription
Public Property LanguageCode Amazon.Polly.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 Property NextToken System.String

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.

Examples

Returns the list of voices that are available for use when requesting speech synthesis. Displayed languages are those within the specified language code. If no language code is specified, voices for all available languages are displayed.

To describe available voices


var response = client.DescribeVoices(new DescribeVoicesRequest 
{
    LanguageCode = "en-GB"
});

List voices = response.Voices;

            

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