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:
{
engine: "standard", # accepts standard, neural
language_code: "arb", # accepts arb, 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
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: "Aditi", # required, accepts Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#engine ⇒ String
Specifies the engine (‘standard` or `neural`) for Amazon Polly to use when processing input text for speech synthesis.
-
#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
#engine ⇒ String
Specifies the engine (‘standard` or `neural`) 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.
987 988 989 990 991 992 993 994 995 996 997 998 999 |
# File 'lib/aws-sdk-polly/types.rb', line 987 class SynthesizeSpeechInput < Struct.new( :engine, :language_code, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text, :text_type, :voice_id) SENSITIVE = [] include Aws::Structure end |
#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
987 988 989 990 991 992 993 994 995 996 997 998 999 |
# File 'lib/aws-sdk-polly/types.rb', line 987 class SynthesizeSpeechInput < Struct.new( :engine, :language_code, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text, :text_type, :voice_id) 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. For information about storing lexicons, see [PutLexicon].
[1]: docs.aws.amazon.com/polly/latest/dg/API_PutLexicon.html
987 988 989 990 991 992 993 994 995 996 997 998 999 |
# File 'lib/aws-sdk-polly/types.rb', line 987 class SynthesizeSpeechInput < Struct.new( :engine, :language_code, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text, :text_type, :voice_id) 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.
When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
987 988 989 990 991 992 993 994 995 996 997 998 999 |
# File 'lib/aws-sdk-polly/types.rb', line 987 class SynthesizeSpeechInput < Struct.new( :engine, :language_code, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text, :text_type, :voice_id) 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”.
Valid values for pcm are “8000” and “16000” The default value is “16000”.
987 988 989 990 991 992 993 994 995 996 997 998 999 |
# File 'lib/aws-sdk-polly/types.rb', line 987 class SynthesizeSpeechInput < Struct.new( :engine, :language_code, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text, :text_type, :voice_id) SENSITIVE = [] include Aws::Structure end |
#speech_mark_types ⇒ Array<String>
The type of speech marks returned for the input text.
987 988 989 990 991 992 993 994 995 996 997 998 999 |
# File 'lib/aws-sdk-polly/types.rb', line 987 class SynthesizeSpeechInput < Struct.new( :engine, :language_code, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text, :text_type, :voice_id) SENSITIVE = [] 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.
987 988 989 990 991 992 993 994 995 996 997 998 999 |
# File 'lib/aws-sdk-polly/types.rb', line 987 class SynthesizeSpeechInput < Struct.new( :engine, :language_code, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text, :text_type, :voice_id) SENSITIVE = [] 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].
987 988 989 990 991 992 993 994 995 996 997 998 999 |
# File 'lib/aws-sdk-polly/types.rb', line 987 class SynthesizeSpeechInput < Struct.new( :engine, :language_code, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text, :text_type, :voice_id) SENSITIVE = [] 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
987 988 989 990 991 992 993 994 995 996 997 998 999 |
# File 'lib/aws-sdk-polly/types.rb', line 987 class SynthesizeSpeechInput < Struct.new( :engine, :language_code, :lexicon_names, :output_format, :sample_rate, :speech_mark_types, :text, :text_type, :voice_id) SENSITIVE = [] include Aws::Structure end |