aws-elixir

View Source AWS.Polly (aws-elixir v1.0.4)

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.

Link to this section Summary

Functions

delete_lexicon(client, name, input, options \\ [])

Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region.

describe_voices(client, engine \\ nil, include_additional_language_codes \\ nil, language_code \\ nil, next_token \\ nil, options \\ [])

Returns the list of voices that are available for use when requesting speech synthesis.

get_lexicon(client, name, options \\ [])

Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region.

get_speech_synthesis_task(client, task_id, options \\ [])

Retrieves a specific SpeechSynthesisTask object based on its TaskID.

list_lexicons(client, next_token \\ nil, options \\ [])

Returns a list of pronunciation lexicons stored in an Amazon Web Services Region.

list_speech_synthesis_tasks(client, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

Returns a list of SpeechSynthesisTask objects ordered by their creation date.

metadata()
put_lexicon(client, name, input, options \\ [])

Stores a pronunciation lexicon in an Amazon Web Services Region.

start_speech_synthesis_task(client, input, options \\ [])

Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask.

synthesize_speech(client, input, options \\ [])

Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.

Link to this section Functions

Link to this function

delete_lexicon(client, name, input, options \\ [])

View Source

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.

Link to this function

describe_voices(client, engine \\ nil, include_additional_language_codes \\ nil, language_code \\ nil, next_token \\ nil, options \\ [])

View Source

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.

Link to this function

get_lexicon(client, name, options \\ [])

View Source

Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region.

For more information, see Managing Lexicons.

Link to this function

get_speech_synthesis_task(client, task_id, options \\ [])

View Source

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.

Link to this function

list_lexicons(client, next_token \\ nil, options \\ [])

View Source

Returns a list of pronunciation lexicons stored in an Amazon Web Services Region.

For more information, see Managing Lexicons.

Link to this function

list_speech_synthesis_tasks(client, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

View Source

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.

Link to this function

metadata()

View Source
Link to this function

put_lexicon(client, name, input, options \\ [])

View Source

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.

Link to this function

start_speech_synthesis_task(client, input, options \\ [])

View Source

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.

Link to this function

synthesize_speech(client, input, options \\ [])

View Source

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.