Class: Aws::Polly::Types::SynthesisTask
- Inherits:
-
Struct
- Object
- Struct
- Aws::Polly::Types::SynthesisTask
- Defined in:
- gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb
Overview
SynthesisTask object that provides information about a speech synthesis task.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#creation_time ⇒ Time
Timestamp for the time the synthesis task was started.
-
#engine ⇒ String
Specifies the engine (
standard
,neural
,long-form
orgenerative
) for Amazon Polly to use when processing input text for speech synthesis. -
#language_code ⇒ String
Optional language code for a synthesis task.
-
#lexicon_names ⇒ Array<String>
List of one or more pronunciation lexicon names you want the service to apply during synthesis.
-
#output_format ⇒ String
The format in which the returned output will be encoded.
-
#output_uri ⇒ String
Pathway for the output speech file.
-
#request_characters ⇒ Integer
Number of billable characters synthesized.
-
#sample_rate ⇒ String
The audio frequency specified in Hz.
-
#sns_topic_arn ⇒ String
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
-
#speech_mark_types ⇒ Array<String>
The type of speech marks returned for the input text.
-
#task_id ⇒ String
The Amazon Polly generated identifier for a speech synthesis task.
-
#task_status ⇒ String
Current status of the individual speech synthesis task.
-
#task_status_reason ⇒ String
Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
-
#text_type ⇒ String
Specifies whether the input text is plain text or SSML.
-
#voice_id ⇒ String
Voice ID to use for the synthesis.
Instance Attribute Details
#creation_time ⇒ Time
Timestamp for the time the synthesis task was started.
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 787 class SynthesisTask < Struct.new( :engine, :task_id, :task_status, :task_status_reason, :output_uri, :creation_time, :request_characters, :sns_topic_arn, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text_type, :voice_id, :language_code) SENSITIVE = [] include Aws::Structure end |
#engine ⇒ String
Specifies the engine (standard
, neural
, long-form
or
generative
) for Amazon Polly to use when processing input text for
speech synthesis. Using a voice that is not supported for the engine
selected will result in an error.
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 787 class SynthesisTask < Struct.new( :engine, :task_id, :task_status, :task_status_reason, :output_uri, :creation_time, :request_characters, :sns_topic_arn, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text_type, :voice_id, :language_code) SENSITIVE = [] include Aws::Structure end |
#language_code ⇒ String
Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).
If a bilingual voice is used and no language code is specified,
Amazon Polly uses the default language of the bilingual voice. The
default language for any voice is the one returned by the
DescribeVoices operation for the LanguageCode
parameter. For
example, if no language code is specified, Aditi will use Indian
English rather than Hindi.
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 787 class SynthesisTask < Struct.new( :engine, :task_id, :task_status, :task_status_reason, :output_uri, :creation_time, :request_characters, :sns_topic_arn, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text_type, :voice_id, :language_code) SENSITIVE = [] include Aws::Structure end |
#lexicon_names ⇒ Array<String>
List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 787 class SynthesisTask < Struct.new( :engine, :task_id, :task_status, :task_status_reason, :output_uri, :creation_time, :request_characters, :sns_topic_arn, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text_type, :voice_id, :language_code) SENSITIVE = [] include Aws::Structure end |
#output_format ⇒ String
The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 787 class SynthesisTask < Struct.new( :engine, :task_id, :task_status, :task_status_reason, :output_uri, :creation_time, :request_characters, :sns_topic_arn, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text_type, :voice_id, :language_code) SENSITIVE = [] include Aws::Structure end |
#output_uri ⇒ String
Pathway for the output speech file.
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 787 class SynthesisTask < Struct.new( :engine, :task_id, :task_status, :task_status_reason, :output_uri, :creation_time, :request_characters, :sns_topic_arn, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text_type, :voice_id, :language_code) SENSITIVE = [] include Aws::Structure end |
#request_characters ⇒ Integer
Number of billable characters synthesized.
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 787 class SynthesisTask < Struct.new( :engine, :task_id, :task_status, :task_status_reason, :output_uri, :creation_time, :request_characters, :sns_topic_arn, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text_type, :voice_id, :language_code) SENSITIVE = [] include Aws::Structure end |
#sample_rate ⇒ String
The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000".
Valid values for pcm are "8000" and "16000" The default value is "16000".
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 787 class SynthesisTask < Struct.new( :engine, :task_id, :task_status, :task_status_reason, :output_uri, :creation_time, :request_characters, :sns_topic_arn, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text_type, :voice_id, :language_code) SENSITIVE = [] include Aws::Structure end |
#sns_topic_arn ⇒ String
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 787 class SynthesisTask < Struct.new( :engine, :task_id, :task_status, :task_status_reason, :output_uri, :creation_time, :request_characters, :sns_topic_arn, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text_type, :voice_id, :language_code) SENSITIVE = [] include Aws::Structure end |
#speech_mark_types ⇒ Array<String>
The type of speech marks returned for the input text.
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 787 class SynthesisTask < Struct.new( :engine, :task_id, :task_status, :task_status_reason, :output_uri, :creation_time, :request_characters, :sns_topic_arn, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text_type, :voice_id, :language_code) SENSITIVE = [] include Aws::Structure end |
#task_id ⇒ String
The Amazon Polly generated identifier for a speech synthesis task.
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 787 class SynthesisTask < Struct.new( :engine, :task_id, :task_status, :task_status_reason, :output_uri, :creation_time, :request_characters, :sns_topic_arn, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text_type, :voice_id, :language_code) SENSITIVE = [] include Aws::Structure end |
#task_status ⇒ String
Current status of the individual speech synthesis task.
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 787 class SynthesisTask < Struct.new( :engine, :task_id, :task_status, :task_status_reason, :output_uri, :creation_time, :request_characters, :sns_topic_arn, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text_type, :voice_id, :language_code) SENSITIVE = [] include Aws::Structure end |
#task_status_reason ⇒ String
Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 787 class SynthesisTask < Struct.new( :engine, :task_id, :task_status, :task_status_reason, :output_uri, :creation_time, :request_characters, :sns_topic_arn, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text_type, :voice_id, :language_code) SENSITIVE = [] include Aws::Structure end |
#text_type ⇒ String
Specifies whether the input text is plain text or SSML. The default value is plain text.
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 787 class SynthesisTask < Struct.new( :engine, :task_id, :task_status, :task_status_reason, :output_uri, :creation_time, :request_characters, :sns_topic_arn, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text_type, :voice_id, :language_code) SENSITIVE = [] include Aws::Structure end |
#voice_id ⇒ String
Voice ID to use for the synthesis.
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 |
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 787 class SynthesisTask < Struct.new( :engine, :task_id, :task_status, :task_status_reason, :output_uri, :creation_time, :request_characters, :sns_topic_arn, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text_type, :voice_id, :language_code) SENSITIVE = [] include Aws::Structure end |