You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Polly::Types::SynthesizeSpeechInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb

Overview

Note:

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, Salli, Conchita, Enrique, Miguel, Penelope, Chantal, Celine, Mathieu, Dora, Karl, Carla, Giorgio, Mizuki, Liv, Lotte, Ruben, Ewa, Jacek, Jan, Maja, Ricardo, Vitoria, Cristiano, Ines, Carmen, Maxim, Tatyana, Astrid, Filiz, Vicki
}

Instance Attribute Summary collapse

Instance Attribute Details

#lexicon_namesArray<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.

Returns:

  • (Array<String>)


345
346
347
348
349
350
351
352
353
354
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 345

class SynthesizeSpeechInput < Struct.new(
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text,
  :text_type,
  :voice_id)
  include Aws::Structure
end

#output_formatString

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.

Returns:

  • (String)


345
346
347
348
349
350
351
352
353
354
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 345

class SynthesizeSpeechInput < Struct.new(
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text,
  :text_type,
  :voice_id)
  include Aws::Structure
end

#sample_rateString

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".

Returns:

  • (String)


345
346
347
348
349
350
351
352
353
354
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 345

class SynthesizeSpeechInput < Struct.new(
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text,
  :text_type,
  :voice_id)
  include Aws::Structure
end

#speech_mark_typesArray<String>

The type of speech marks returned for the input text.

Returns:

  • (Array<String>)


345
346
347
348
349
350
351
352
353
354
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 345

class SynthesizeSpeechInput < Struct.new(
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text,
  :text_type,
  :voice_id)
  include Aws::Structure
end

#textString

Input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

Returns:

  • (String)


345
346
347
348
349
350
351
352
353
354
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 345

class SynthesizeSpeechInput < Struct.new(
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text,
  :text_type,
  :voice_id)
  include Aws::Structure
end

#text_typeString

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

Returns:

  • (String)


345
346
347
348
349
350
351
352
353
354
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 345

class SynthesizeSpeechInput < Struct.new(
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text,
  :text_type,
  :voice_id)
  include Aws::Structure
end

#voice_idString

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

Returns:

  • (String)


345
346
347
348
349
350
351
352
353
354
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 345

class SynthesizeSpeechInput < Struct.new(
  :lexicon_names,
  :output_format,
  :sample_rate,
  :speech_mark_types,
  :text,
  :text_type,
  :voice_id)
  include Aws::Structure
end