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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SynthesizeSpeechInput as input to an Aws::Client method, you can use a vanilla 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, 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
}

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>)

    List of one or more pronunciation lexicon names you want the service to apply during synthesis.

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

Possible values:

  • json
  • mp3
  • ogg_vorbis
  • pcm

Returns:

  • (String)

    The format in which the returned output will be encoded.

#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)

    The audio frequency specified in Hz.

#speech_mark_typesArray<String>

The type of speech marks returned for the input text.

Returns:

  • (Array<String>)

    The type of speech marks returned for the input text.

#textString

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

Returns:

  • (String)

    Input text to synthesize.

#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)

    Specifies whether the input text is plain text or SSML.

#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)

    Voice ID to use for the synthesis.