Class: Aws::Polly::Types::SynthesizeSpeechInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Polly::Types::SynthesizeSpeechInput
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-polly/types.rb
Overview
When making an API call, you may pass SynthesizeSpeechInput data as a hash:
{
lexicon_names: ["LexiconName"],
output_format: "json", # required, accepts json, mp3, ogg_vorbis, pcm
sample_rate: "SampleRate",
speech_mark_types: ["sentence"], # accepts sentence, ssml, viseme, word
text: "Text", # required
text_type: "ssml", # accepts ssml, text
voice_id: "Geraint", # required, accepts Geraint, Gwyneth, Mads, Naja, Hans, Marlene, Nicole, Russell, Amy, Brian, Emma, Raveena, Ivy, Joanna, Joey, Justin, Kendra, Kimberly, Matthew, Salli, Conchita, Enrique, Miguel, Penelope, Chantal, Celine, Lea, Mathieu, Dora, Karl, Carla, Giorgio, Mizuki, Liv, Lotte, Ruben, Ewa, Jacek, Jan, Maja, Ricardo, Vitoria, Cristiano, Ines, Carmen, Maxim, Tatyana, Astrid, Filiz, Vicki, Takumi, Seoyeon, Aditi, Zhiyu, Bianca, Lucia, Mia
language_code: "cmn-CN", # accepts cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR
}
Instance Attribute Summary collapse
-
#language_code ⇒ String
Optional language code for the Synthesize Speech request.
-
#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.
-
#sample_rate ⇒ String
The audio frequency specified in Hz.
-
#speech_mark_types ⇒ Array<String>
The type of speech marks returned for the input text.
-
#text ⇒ String
Input text to synthesize.
-
#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
#language_code ⇒ String
Optional language code for the Synthesize Speech request. 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 will use the default language of the bilingual voice. The default language for any voice is the one returned by the
- DescribeVoices][1
-
operation for the ‘LanguageCode` parameter. For
example, if no language code is specified, Aditi will use Indian English rather than Hindi.
[1]: docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html
681 682 683 684 685 686 687 688 689 690 691 |
# File 'lib/aws-sdk-polly/types.rb', line 681 class SynthesizeSpeechInput < Struct.new( :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text, :text_type, :voice_id, :language_code) 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. For information about storing lexicons, see [PutLexicon].
[1]: docs.aws.amazon.com/polly/latest/dg/API_PutLexicon.html
681 682 683 684 685 686 687 688 689 690 691 |
# File 'lib/aws-sdk-polly/types.rb', line 681 class SynthesizeSpeechInput < Struct.new( :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text, :text_type, :voice_id, :language_code) 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.
When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
681 682 683 684 685 686 687 688 689 690 691 |
# File 'lib/aws-sdk-polly/types.rb', line 681 class SynthesizeSpeechInput < Struct.new( :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text, :text_type, :voice_id, :language_code) include Aws::Structure end |
#sample_rate ⇒ String
The audio frequency specified in Hz.
The valid values for ‘mp3` and `ogg_vorbis` are “8000”, “16000”, and “22050”. The default value is “22050”.
Valid values for ‘pcm` are “8000” and “16000” The default value is “16000”.
681 682 683 684 685 686 687 688 689 690 691 |
# File 'lib/aws-sdk-polly/types.rb', line 681 class SynthesizeSpeechInput < Struct.new( :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text, :text_type, :voice_id, :language_code) include Aws::Structure end |
#speech_mark_types ⇒ Array<String>
The type of speech marks returned for the input text.
681 682 683 684 685 686 687 688 689 690 691 |
# File 'lib/aws-sdk-polly/types.rb', line 681 class SynthesizeSpeechInput < Struct.new( :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text, :text_type, :voice_id, :language_code) include Aws::Structure end |
#text ⇒ String
Input text to synthesize. If you specify ‘ssml` as the `TextType`, follow the SSML format for the input text.
681 682 683 684 685 686 687 688 689 690 691 |
# File 'lib/aws-sdk-polly/types.rb', line 681 class SynthesizeSpeechInput < Struct.new( :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text, :text_type, :voice_id, :language_code) include Aws::Structure end |
#text_type ⇒ String
Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see [Using SSML].
681 682 683 684 685 686 687 688 689 690 691 |
# File 'lib/aws-sdk-polly/types.rb', line 681 class SynthesizeSpeechInput < Struct.new( :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text, :text_type, :voice_id, :language_code) include Aws::Structure end |
#voice_id ⇒ String
Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the [DescribeVoices] operation.
[1]: docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html
681 682 683 684 685 686 687 688 689 690 691 |
# File 'lib/aws-sdk-polly/types.rb', line 681 class SynthesizeSpeechInput < Struct.new( :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text, :text_type, :voice_id, :language_code) include Aws::Structure end |