Class: Aws::Polly::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Polly::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb
Overview
An API client for Polly. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Polly::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#delete_lexicon(params = {}) ⇒ Struct
Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region.
-
#describe_voices(params = {}) ⇒ Types::DescribeVoicesOutput
Returns the list of voices that are available for use when requesting speech synthesis.
-
#get_lexicon(params = {}) ⇒ Types::GetLexiconOutput
Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region.
-
#get_speech_synthesis_task(params = {}) ⇒ Types::GetSpeechSynthesisTaskOutput
Retrieves a specific SpeechSynthesisTask object based on its TaskID.
-
#list_lexicons(params = {}) ⇒ Types::ListLexiconsOutput
Returns a list of pronunciation lexicons stored in an Amazon Web Services Region.
-
#list_speech_synthesis_tasks(params = {}) ⇒ Types::ListSpeechSynthesisTasksOutput
Returns a list of SpeechSynthesisTask objects ordered by their creation date.
-
#put_lexicon(params = {}) ⇒ Struct
Stores a pronunciation lexicon in an Amazon Web Services Region.
-
#start_speech_synthesis_task(params = {}) ⇒ Types::StartSpeechSynthesisTaskOutput
Allows the creation of an asynchronous synthesis task, by starting a new
SpeechSynthesisTask
. -
#synthesize_speech(params = {}) ⇒ Types::SynthesizeSpeechOutput
Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
422 423 424 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 422 def initialize(*args) super end |
Instance Method Details
#delete_lexicon(params = {}) ⇒ Struct
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.
468 469 470 471 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 468 def delete_lexicon(params = {}, = {}) req = build_request(:delete_lexicon, params) req.send_request() end |
#describe_voices(params = {}) ⇒ Types::DescribeVoicesOutput
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.
586 587 588 589 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 586 def describe_voices(params = {}, = {}) req = build_request(:describe_voices, params) req.send_request() end |
#get_lexicon(params = {}) ⇒ Types::GetLexiconOutput
Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region. For more information, see Managing Lexicons.
653 654 655 656 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 653 def get_lexicon(params = {}, = {}) req = build_request(:get_lexicon, params) req.send_request() end |
#get_speech_synthesis_task(params = {}) ⇒ Types::GetSpeechSynthesisTaskOutput
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.
700 701 702 703 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 700 def get_speech_synthesis_task(params = {}, = {}) req = build_request(:get_speech_synthesis_task, params) req.send_request() end |
#list_lexicons(params = {}) ⇒ Types::ListLexiconsOutput
Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons.
769 770 771 772 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 769 def list_lexicons(params = {}, = {}) req = build_request(:list_lexicons, params) req.send_request() end |
#list_speech_synthesis_tasks(params = {}) ⇒ Types::ListSpeechSynthesisTasksOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
829 830 831 832 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 829 def list_speech_synthesis_tasks(params = {}, = {}) req = build_request(:list_speech_synthesis_tasks, params) req.send_request() end |
#put_lexicon(params = {}) ⇒ Struct
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.
881 882 883 884 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 881 def put_lexicon(params = {}, = {}) req = build_request(:put_lexicon, params) req.send_request() end |
#start_speech_synthesis_task(params = {}) ⇒ Types::StartSpeechSynthesisTaskOutput
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.
1010 1011 1012 1013 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 1010 def start_speech_synthesis_task(params = {}, = {}) req = build_request(:start_speech_synthesis_task, params) req.send_request() end |
#synthesize_speech(params = {}) ⇒ Types::SynthesizeSpeechOutput
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.
1167 1168 1169 1170 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 1167 def synthesize_speech(params = {}, = {}, &block) req = build_request(:synthesize_speech, params) req.send_request(, &block) end |