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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#engine ⇒ String

Specifies the engine (‘standard`, `neural` or `long-form`) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available for each engine, see [Available Voices].

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

**long-form-only voices**

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

Type: String

Valid Values: ‘standard` | `neural` | `long-form`

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]: docs.aws.amazon.com/polly/latest/dg/voicelist.html

Returns:

  • (String) 


932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'lib/aws-sdk-polly/types.rb', line 932

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 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]: docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html

Returns:

  • (String) 


932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'lib/aws-sdk-polly/types.rb', line 932

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

Returns:

  • (Array<String>) 


932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'lib/aws-sdk-polly/types.rb', line 932

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.

Returns:

  • (String) 


932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'lib/aws-sdk-polly/types.rb', line 932

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”. The default value for long-form voices is “24000”.

Valid values for pcm are “8000” and “16000” The default value is “16000”.

Returns:

  • (String) 


932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'lib/aws-sdk-polly/types.rb', line 932

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.

Returns:

  • (Array<String>) 


932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'lib/aws-sdk-polly/types.rb', line 932

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.

Returns:

  • (String) 


932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'lib/aws-sdk-polly/types.rb', line 932

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

[1]: docs.aws.amazon.com/polly/latest/dg/ssml.html

Returns:

  • (String) 


932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'lib/aws-sdk-polly/types.rb', line 932

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

Returns:

  • (String) 


932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'lib/aws-sdk-polly/types.rb', line 932

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