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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-polly/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, long-form or generative) 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) 


805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 805

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 uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

Returns:

  • (String) 


805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 805

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


805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 805

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, ogg_opus, mu-law, a-law, or pcm. For speech marks, this will be json.

Returns:

  • (String) 


805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 805

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) 


805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 805

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) 


805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 805

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

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

Valid value for ogg_opus is "48000".

Valid value for mu-law and a-law is "8000".

Returns:

  • (String) 


805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 805

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) 


805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 805

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


805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 805

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) 


805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 805

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) 


805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 805

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) 


805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/types.rb', line 805

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