@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonPollyAsync extends AmazonPolly
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.
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
Future<DeleteLexiconResult> |
deleteLexiconAsync(DeleteLexiconRequest deleteLexiconRequest)
Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region.
|
Future<DeleteLexiconResult> |
deleteLexiconAsync(DeleteLexiconRequest deleteLexiconRequest,
AsyncHandler<DeleteLexiconRequest,DeleteLexiconResult> asyncHandler)
Deletes the specified pronunciation lexicon stored in an Amazon Web Services 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 Amazon Web Services Region.
|
Future<GetLexiconResult> |
getLexiconAsync(GetLexiconRequest getLexiconRequest,
AsyncHandler<GetLexiconRequest,GetLexiconResult> asyncHandler)
Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region.
|
Future<GetSpeechSynthesisTaskResult> |
getSpeechSynthesisTaskAsync(GetSpeechSynthesisTaskRequest getSpeechSynthesisTaskRequest)
Retrieves a specific SpeechSynthesisTask object based on its TaskID.
|
Future<GetSpeechSynthesisTaskResult> |
getSpeechSynthesisTaskAsync(GetSpeechSynthesisTaskRequest getSpeechSynthesisTaskRequest,
AsyncHandler<GetSpeechSynthesisTaskRequest,GetSpeechSynthesisTaskResult> asyncHandler)
Retrieves a specific SpeechSynthesisTask object based on its TaskID.
|
Future<ListLexiconsResult> |
listLexiconsAsync(ListLexiconsRequest listLexiconsRequest)
Returns a list of pronunciation lexicons stored in an Amazon Web Services Region.
|
Future<ListLexiconsResult> |
listLexiconsAsync(ListLexiconsRequest listLexiconsRequest,
AsyncHandler<ListLexiconsRequest,ListLexiconsResult> asyncHandler)
Returns a list of pronunciation lexicons stored in an Amazon Web Services Region.
|
Future<ListSpeechSynthesisTasksResult> |
listSpeechSynthesisTasksAsync(ListSpeechSynthesisTasksRequest listSpeechSynthesisTasksRequest)
Returns a list of SpeechSynthesisTask objects ordered by their creation date.
|
Future<ListSpeechSynthesisTasksResult> |
listSpeechSynthesisTasksAsync(ListSpeechSynthesisTasksRequest listSpeechSynthesisTasksRequest,
AsyncHandler<ListSpeechSynthesisTasksRequest,ListSpeechSynthesisTasksResult> asyncHandler)
Returns a list of SpeechSynthesisTask objects ordered by their creation date.
|
Future<PutLexiconResult> |
putLexiconAsync(PutLexiconRequest putLexiconRequest)
Stores a pronunciation lexicon in an Amazon Web Services Region.
|
Future<PutLexiconResult> |
putLexiconAsync(PutLexiconRequest putLexiconRequest,
AsyncHandler<PutLexiconRequest,PutLexiconResult> asyncHandler)
Stores a pronunciation lexicon in an Amazon Web Services Region.
|
Future<StartSpeechSynthesisTaskResult> |
startSpeechSynthesisTaskAsync(StartSpeechSynthesisTaskRequest startSpeechSynthesisTaskRequest)
Allows the creation of an asynchronous synthesis task, by starting a new
SpeechSynthesisTask . |
Future<StartSpeechSynthesisTaskResult> |
startSpeechSynthesisTaskAsync(StartSpeechSynthesisTaskRequest startSpeechSynthesisTaskRequest,
AsyncHandler<StartSpeechSynthesisTaskRequest,StartSpeechSynthesisTaskResult> asyncHandler)
Allows the creation of an asynchronous synthesis task, by starting a new
SpeechSynthesisTask . |
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.
|
deleteLexicon, describeVoices, getCachedResponseMetadata, getLexicon, getSpeechSynthesisTask, listLexicons, listSpeechSynthesisTasks, presigners, putLexicon, setEndpoint, setRegion, shutdown, startSpeechSynthesisTask, synthesizeSpeech
Future<DeleteLexiconResult> deleteLexiconAsync(DeleteLexiconRequest deleteLexiconRequest)
Deletes the specified pronunciation lexicon stored in an Amazon Web Services 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.
deleteLexiconRequest
- Future<DeleteLexiconResult> deleteLexiconAsync(DeleteLexiconRequest deleteLexiconRequest, AsyncHandler<DeleteLexiconRequest,DeleteLexiconResult> asyncHandler)
Deletes the specified pronunciation lexicon stored in an Amazon Web Services 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.
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.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.
describeVoicesRequest
- 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.
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.Future<GetLexiconResult> getLexiconAsync(GetLexiconRequest getLexiconRequest)
Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region. For more information, see Managing Lexicons.
getLexiconRequest
- Future<GetLexiconResult> getLexiconAsync(GetLexiconRequest getLexiconRequest, AsyncHandler<GetLexiconRequest,GetLexiconResult> asyncHandler)
Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region. For more information, see Managing Lexicons.
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.Future<GetSpeechSynthesisTaskResult> getSpeechSynthesisTaskAsync(GetSpeechSynthesisTaskRequest getSpeechSynthesisTaskRequest)
Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object contains information about the given speech synthesis task, including the status of the task, and a link to the S3 bucket containing the output of the task.
getSpeechSynthesisTaskRequest
- Future<GetSpeechSynthesisTaskResult> getSpeechSynthesisTaskAsync(GetSpeechSynthesisTaskRequest getSpeechSynthesisTaskRequest, AsyncHandler<GetSpeechSynthesisTaskRequest,GetSpeechSynthesisTaskResult> asyncHandler)
Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object contains information about the given speech synthesis task, including the status of the task, and a link to the S3 bucket containing the output of the task.
getSpeechSynthesisTaskRequest
- 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.Future<ListLexiconsResult> listLexiconsAsync(ListLexiconsRequest listLexiconsRequest)
Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons.
listLexiconsRequest
- Future<ListLexiconsResult> listLexiconsAsync(ListLexiconsRequest listLexiconsRequest, AsyncHandler<ListLexiconsRequest,ListLexiconsResult> asyncHandler)
Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons.
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.Future<ListSpeechSynthesisTasksResult> listSpeechSynthesisTasksAsync(ListSpeechSynthesisTasksRequest listSpeechSynthesisTasksRequest)
Returns a list of SpeechSynthesisTask objects ordered by their creation date. This operation can filter the tasks by their status, for example, allowing users to list only tasks that are completed.
listSpeechSynthesisTasksRequest
- Future<ListSpeechSynthesisTasksResult> listSpeechSynthesisTasksAsync(ListSpeechSynthesisTasksRequest listSpeechSynthesisTasksRequest, AsyncHandler<ListSpeechSynthesisTasksRequest,ListSpeechSynthesisTasksResult> asyncHandler)
Returns a list of SpeechSynthesisTask objects ordered by their creation date. This operation can filter the tasks by their status, for example, allowing users to list only tasks that are completed.
listSpeechSynthesisTasksRequest
- 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.Future<PutLexiconResult> putLexiconAsync(PutLexiconRequest putLexiconRequest)
Stores a pronunciation lexicon in an Amazon Web Services 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.
putLexiconRequest
- Future<PutLexiconResult> putLexiconAsync(PutLexiconRequest putLexiconRequest, AsyncHandler<PutLexiconRequest,PutLexiconResult> asyncHandler)
Stores a pronunciation lexicon in an Amazon Web Services 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.
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.Future<StartSpeechSynthesisTaskResult> startSpeechSynthesisTaskAsync(StartSpeechSynthesisTaskRequest startSpeechSynthesisTaskRequest)
Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask
. This
operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket
for the service to store the output of the synthesis task and two optional parameters (
OutputS3KeyPrefix
and SnsTopicArn
). Once the synthesis task is created, this operation
will return a SpeechSynthesisTask
object, which will include an identifier of this task as well as
the current status. The SpeechSynthesisTask
object is available for 72 hours after starting the
asynchronous synthesis task.
startSpeechSynthesisTaskRequest
- Future<StartSpeechSynthesisTaskResult> startSpeechSynthesisTaskAsync(StartSpeechSynthesisTaskRequest startSpeechSynthesisTaskRequest, AsyncHandler<StartSpeechSynthesisTaskRequest,StartSpeechSynthesisTaskResult> asyncHandler)
Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask
. This
operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket
for the service to store the output of the synthesis task and two optional parameters (
OutputS3KeyPrefix
and SnsTopicArn
). Once the synthesis task is created, this operation
will return a SpeechSynthesisTask
object, which will include an identifier of this task as well as
the current status. The SpeechSynthesisTask
object is available for 72 hours after starting the
asynchronous synthesis task.
startSpeechSynthesisTaskRequest
- 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.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.
synthesizeSpeechRequest
- 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.
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.