class Aws::Polly::Types::SynthesizeSpeechInput

@note 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, en-NZ, en-ZA
      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, Gabrielle, 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, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda
    }

@!attribute [rw] engine

Specifies the engine (`standard` or `neural`) for Amazon Polly to
use when processing input text for speech synthesis. For information
on Amazon Polly voices and which voices are available in
standard-only, NTTS-only, and both standard and NTTS formats, see
[Available Voices][1].

**NTTS-only voices**

When using NTTS-only voices such as Kevin (en-US), this parameter is
required and must be set to `neural`. If the engine is not
specified, or is set to `standard`, this will result in an error.

Type: String

Valid Values: `standard` \| `neural`

Required: Yes

**Standard voices**

For standard voices, this is not required; the engine parameter
defaults to `standard`. If the engine is not specified, or is set to
`standard` and an NTTS-only voice is selected, this will result in
an error.

[1]: https://docs.aws.amazon.com/polly/latest/dg/voicelist.html
@return [String]

@!attribute [rw] language_code

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 uses 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]: https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html
@return [String]

@!attribute [rw] lexicon_names

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

[1]: https://docs.aws.amazon.com/polly/latest/dg/API_PutLexicon.html
@return [Array<String>]

@!attribute [rw] output_format

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.
@return [String]

@!attribute [rw] sample_rate

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".
@return [String]

@!attribute [rw] speech_mark_types

The type of speech marks returned for the input text.
@return [Array<String>]

@!attribute [rw] text

Input text to synthesize. If you specify `ssml` as the `TextType`,
follow the SSML format for the input text.
@return [String]

@!attribute [rw] text_type

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

[1]: https://docs.aws.amazon.com/polly/latest/dg/ssml.html
@return [String]

@!attribute [rw] voice_id

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

[1]: https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/SynthesizeSpeechInput AWS API Documentation

Constants

SENSITIVE