com.amazonaws.services.polly

Interface AmazonPollyAsync

All Superinterfaces:

AmazonPolly

All Known Implementing Classes:

AbstractAmazonPollyAsync, AmazonPollyAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonPollyAsync
extends AmazonPolly

Interface for accessing Amazon Polly asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonPollyAsync instead.

Amazon Polly is a web service that makes it easy to synthesize speech from text.

The Amazon Polly service provides API operations for synthesizing high-quality speech from plain text and Speech Synthesis Markup Language (SSML), along with managing pronunciations lexicons that enable you to get the best results for your application domain.

Field Summary

Fields inherited from interface com.amazonaws.services.polly.AmazonPolly

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<DeleteLexiconResult>	deleteLexiconAsync(DeleteLexiconRequest deleteLexiconRequest) Deletes the specified pronunciation lexicon stored in an AWS Region.
Future<DeleteLexiconResult>	deleteLexiconAsync(DeleteLexiconRequest deleteLexiconRequest, AsyncHandler<DeleteLexiconRequest,DeleteLexiconResult> asyncHandler) Deletes the specified pronunciation lexicon stored in an AWS Region.
Future<DescribeVoicesResult>	describeVoicesAsync(DescribeVoicesRequest describeVoicesRequest) Returns the list of voices that are available for use when requesting speech synthesis.
Future<DescribeVoicesResult>	describeVoicesAsync(DescribeVoicesRequest describeVoicesRequest, AsyncHandler<DescribeVoicesRequest,DescribeVoicesResult> asyncHandler) Returns the list of voices that are available for use when requesting speech synthesis.
Future<GetLexiconResult>	getLexiconAsync(GetLexiconRequest getLexiconRequest) Returns the content of the specified pronunciation lexicon stored in an AWS Region.
Future<GetLexiconResult>	getLexiconAsync(GetLexiconRequest getLexiconRequest, AsyncHandler<GetLexiconRequest,GetLexiconResult> asyncHandler) Returns the content of the specified pronunciation lexicon stored in an AWS Region.
Future<ListLexiconsResult>	listLexiconsAsync(ListLexiconsRequest listLexiconsRequest) Returns a list of pronunciation lexicons stored in an AWS Region.
Future<ListLexiconsResult>	listLexiconsAsync(ListLexiconsRequest listLexiconsRequest, AsyncHandler<ListLexiconsRequest,ListLexiconsResult> asyncHandler) Returns a list of pronunciation lexicons stored in an AWS Region.
Future<PutLexiconResult>	putLexiconAsync(PutLexiconRequest putLexiconRequest) Stores a pronunciation lexicon in an AWS Region.
Future<PutLexiconResult>	putLexiconAsync(PutLexiconRequest putLexiconRequest, AsyncHandler<PutLexiconRequest,PutLexiconResult> asyncHandler) Stores a pronunciation lexicon in an AWS Region.
Future<SynthesizeSpeechResult>	synthesizeSpeechAsync(SynthesizeSpeechRequest synthesizeSpeechRequest) Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.
Future<SynthesizeSpeechResult>	synthesizeSpeechAsync(SynthesizeSpeechRequest synthesizeSpeechRequest, AsyncHandler<SynthesizeSpeechRequest,SynthesizeSpeechResult> asyncHandler) Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.

Methods inherited from interface com.amazonaws.services.polly.AmazonPolly

deleteLexicon, describeVoices, getCachedResponseMetadata, getLexicon, listLexicons, presigners, putLexicon, setEndpoint, setRegion, shutdown, synthesizeSpeech

Method Detail

deleteLexiconAsync

Future<DeleteLexiconResult> deleteLexiconAsync(DeleteLexiconRequest deleteLexiconRequest)

Deletes the specified pronunciation lexicon stored in an AWS Region. A lexicon which has been deleted is not available for speech synthesis, nor is it possible to retrieve it using either the GetLexicon or ListLexicon APIs.

For more information, see Managing Lexicons.

Parameters:

deleteLexiconRequest -

Returns:

A Java Future containing the result of the DeleteLexicon operation returned by the service.

See Also:

AWS API Documentation

deleteLexiconAsync

Future<DeleteLexiconResult> deleteLexiconAsync(DeleteLexiconRequest deleteLexiconRequest,
                                               AsyncHandler<DeleteLexiconRequest,DeleteLexiconResult> asyncHandler)

Deletes the specified pronunciation lexicon stored in an AWS Region. A lexicon which has been deleted is not available for speech synthesis, nor is it possible to retrieve it using either the GetLexicon or ListLexicon APIs.

For more information, see Managing Lexicons.

Parameters:

deleteLexiconRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteLexicon operation returned by the service.

See Also:

AWS API Documentation

describeVoicesAsync

Future<DescribeVoicesResult> describeVoicesAsync(DescribeVoicesRequest describeVoicesRequest)

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.

Parameters:

describeVoicesRequest -

Returns:

A Java Future containing the result of the DescribeVoices operation returned by the service.

See Also:

AWS API Documentation

describeVoicesAsync

Future<DescribeVoicesResult> describeVoicesAsync(DescribeVoicesRequest describeVoicesRequest,
                                                 AsyncHandler<DescribeVoicesRequest,DescribeVoicesResult> asyncHandler)

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.

Parameters:

describeVoicesRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeVoices operation returned by the service.

See Also:

AWS API Documentation

getLexiconAsync

Future<GetLexiconResult> getLexiconAsync(GetLexiconRequest getLexiconRequest)

Returns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see Managing Lexicons.

Parameters:

getLexiconRequest -

Returns:

A Java Future containing the result of the GetLexicon operation returned by the service.

See Also:

AWS API Documentation

getLexiconAsync

Future<GetLexiconResult> getLexiconAsync(GetLexiconRequest getLexiconRequest,
                                         AsyncHandler<GetLexiconRequest,GetLexiconResult> asyncHandler)

Returns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see Managing Lexicons.

Parameters:

getLexiconRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetLexicon operation returned by the service.

See Also:

AWS API Documentation

listLexiconsAsync

Future<ListLexiconsResult> listLexiconsAsync(ListLexiconsRequest listLexiconsRequest)

Returns a list of pronunciation lexicons stored in an AWS Region. For more information, see Managing Lexicons.

Parameters:

listLexiconsRequest -

Returns:

A Java Future containing the result of the ListLexicons operation returned by the service.

See Also:

AWS API Documentation

listLexiconsAsync

Future<ListLexiconsResult> listLexiconsAsync(ListLexiconsRequest listLexiconsRequest,
                                             AsyncHandler<ListLexiconsRequest,ListLexiconsResult> asyncHandler)

Returns a list of pronunciation lexicons stored in an AWS Region. For more information, see Managing Lexicons.

Parameters:

listLexiconsRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListLexicons operation returned by the service.

See Also:

AWS API Documentation

putLexiconAsync

Future<PutLexiconResult> putLexiconAsync(PutLexiconRequest putLexiconRequest)

Stores a pronunciation lexicon in an AWS Region. If a lexicon with the same name already exists in the region, it is overwritten by the new lexicon. Lexicon operations have eventual consistency, therefore, it might take some time before the lexicon is available to the SynthesizeSpeech operation.

For more information, see Managing Lexicons.

Parameters:

putLexiconRequest -

Returns:

A Java Future containing the result of the PutLexicon operation returned by the service.

See Also:

AWS API Documentation

putLexiconAsync

Future<PutLexiconResult> putLexiconAsync(PutLexiconRequest putLexiconRequest,
                                         AsyncHandler<PutLexiconRequest,PutLexiconResult> asyncHandler)

Stores a pronunciation lexicon in an AWS Region. If a lexicon with the same name already exists in the region, it is overwritten by the new lexicon. Lexicon operations have eventual consistency, therefore, it might take some time before the lexicon is available to the SynthesizeSpeech operation.

For more information, see Managing Lexicons.

Parameters:

putLexiconRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the PutLexicon operation returned by the service.

See Also:

AWS API Documentation

synthesizeSpeechAsync

Future<SynthesizeSpeechResult> synthesizeSpeechAsync(SynthesizeSpeechRequest synthesizeSpeechRequest)

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.

Parameters:

synthesizeSpeechRequest -

Returns:

A Java Future containing the result of the SynthesizeSpeech operation returned by the service.

See Also:

AWS API Documentation

synthesizeSpeechAsync

Future<SynthesizeSpeechResult> synthesizeSpeechAsync(SynthesizeSpeechRequest synthesizeSpeechRequest,
                                                     AsyncHandler<SynthesizeSpeechRequest,SynthesizeSpeechResult> asyncHandler)

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.

Parameters:

synthesizeSpeechRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the SynthesizeSpeech operation returned by the service.

See Also:

AWS API Documentation