PollyClient Class

Member Function Documentation

PollyClient::PollyClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a PollyClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

PollyClient::PollyClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads PollyClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] DeleteLexiconResponse *PollyClient::deleteLexicon(const DeleteLexiconRequest &request)

Sends request to the PollyClient service, and returns a pointer to an DeleteLexiconResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>GetLexicon</code> or <code>ListLexicon</code>

APIs>

For more information, see <a href="http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html">Managing

[slot] DescribeVoicesResponse *PollyClient::describeVoices(const DescribeVoicesRequest &request)

Sends request to the PollyClient service, and returns a pointer to an DescribeVoicesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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.

</p

When synthesizing speech ( <code>SynthesizeSpeech</code> ), you provide the voice ID for the voice you want from the list of voices returned by

<code>DescribeVoices</code>>

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 <code>DescribeVoices</code> 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 <code>en-US</code>, the operation returns a list of all available US English voices.

</p

This operation requires permissions to perform the <code>polly:DescribeVoices</code>

[slot] GetLexiconResponse *PollyClient::getLexicon(const GetLexiconRequest &request)

Sends request to the PollyClient service, and returns a pointer to an GetLexiconResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see <a href="http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html">Managing

[slot] ListLexiconsResponse *PollyClient::listLexicons(const ListLexiconsRequest &request)

Sends request to the PollyClient service, and returns a pointer to an ListLexiconsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a list of pronunciation lexicons stored in an AWS Region. For more information, see <a href="http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html">Managing

[slot] PutLexiconResponse *PollyClient::putLexicon(const PutLexiconRequest &request)

Sends request to the PollyClient service, and returns a pointer to an PutLexiconResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html">Managing

[slot] SynthesizeSpeechResponse *PollyClient::synthesizeSpeech(const SynthesizeSpeechRequest &request)

Sends request to the PollyClient service, and returns a pointer to an SynthesizeSpeechResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/polly/latest/dg/how-text-to-speech-works.html">How it