Class: Aws::Polly::Types::StartSpeechSynthesisTaskInput

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

Overview

Note:

When making an API call, you may pass StartSpeechSynthesisTaskInput 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
  output_s3_bucket_name: "OutputS3BucketName", # required
  output_s3_key_prefix: "OutputS3KeyPrefix",
  sample_rate: "SampleRate",
  sns_topic_arn: "SnsTopicArn",
  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, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:

  • (String) 


730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/aws-sdk-polly/types.rb', line 730

class StartSpeechSynthesisTaskInput < Struct.new(
  :engine,
  :language_code,
  :lexicon_names,
  :output_format,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :sample_rate,
  :sns_topic_arn,
  :speech_mark_types,
  :text,
  :text_type,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

Optional language code for the Speech Synthesis 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

Returns:

  • (String) 


730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/aws-sdk-polly/types.rb', line 730

class StartSpeechSynthesisTaskInput < Struct.new(
  :engine,
  :language_code,
  :lexicon_names,
  :output_format,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :sample_rate,
  :sns_topic_arn,
  :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.

Returns:

  • (Array<String>) 


730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/aws-sdk-polly/types.rb', line 730

class StartSpeechSynthesisTaskInput < Struct.new(
  :engine,
  :language_code,
  :lexicon_names,
  :output_format,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :sample_rate,
  :sns_topic_arn,
  :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.

Returns:

  • (String) 


730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/aws-sdk-polly/types.rb', line 730

class StartSpeechSynthesisTaskInput < Struct.new(
  :engine,
  :language_code,
  :lexicon_names,
  :output_format,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :sample_rate,
  :sns_topic_arn,
  :speech_mark_types,
  :text,
  :text_type,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#output_s3_bucket_name ⇒ String

Amazon S3 bucket name to which the output file will be saved.

Returns:

  • (String) 


730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/aws-sdk-polly/types.rb', line 730

class StartSpeechSynthesisTaskInput < Struct.new(
  :engine,
  :language_code,
  :lexicon_names,
  :output_format,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :sample_rate,
  :sns_topic_arn,
  :speech_mark_types,
  :text,
  :text_type,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#output_s3_key_prefix ⇒ String

The Amazon S3 key prefix for the output speech file.

Returns:

  • (String) 


730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/aws-sdk-polly/types.rb', line 730

class StartSpeechSynthesisTaskInput < Struct.new(
  :engine,
  :language_code,
  :lexicon_names,
  :output_format,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :sample_rate,
  :sns_topic_arn,
  :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”.

Returns:

  • (String) 


730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/aws-sdk-polly/types.rb', line 730

class StartSpeechSynthesisTaskInput < Struct.new(
  :engine,
  :language_code,
  :lexicon_names,
  :output_format,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :sample_rate,
  :sns_topic_arn,
  :speech_mark_types,
  :text,
  :text_type,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_arn ⇒ String

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

Returns:

  • (String) 


730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/aws-sdk-polly/types.rb', line 730

class StartSpeechSynthesisTaskInput < Struct.new(
  :engine,
  :language_code,
  :lexicon_names,
  :output_format,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :sample_rate,
  :sns_topic_arn,
  :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>) 


730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/aws-sdk-polly/types.rb', line 730

class StartSpeechSynthesisTaskInput < Struct.new(
  :engine,
  :language_code,
  :lexicon_names,
  :output_format,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :sample_rate,
  :sns_topic_arn,
  :speech_mark_types,
  :text,
  :text_type,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#text ⇒ String

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

Returns:

  • (String) 


730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/aws-sdk-polly/types.rb', line 730

class StartSpeechSynthesisTaskInput < Struct.new(
  :engine,
  :language_code,
  :lexicon_names,
  :output_format,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :sample_rate,
  :sns_topic_arn,
  :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.

Returns:

  • (String) 


730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/aws-sdk-polly/types.rb', line 730

class StartSpeechSynthesisTaskInput < Struct.new(
  :engine,
  :language_code,
  :lexicon_names,
  :output_format,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :sample_rate,
  :sns_topic_arn,
  :speech_mark_types,
  :text,
  :text_type,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#voice_id ⇒ String

Voice ID to use for the synthesis.

Returns:

  • (String) 


730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/aws-sdk-polly/types.rb', line 730

class StartSpeechSynthesisTaskInput < Struct.new(
  :engine,
  :language_code,
  :lexicon_names,
  :output_format,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :sample_rate,
  :sns_topic_arn,
  :speech_mark_types,
  :text,
  :text_type,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end