Struct StartSpeechSynthesisTaskInput 

#[non_exhaustive]
pub struct StartSpeechSynthesisTaskInput {
    pub engine: Option<Engine>,
    pub language_code: Option<LanguageCode>,
    pub lexicon_names: Option<Vec<String>>,
    pub output_format: Option<OutputFormat>,
    pub output_s3_bucket_name: Option<String>,
    pub output_s3_key_prefix: Option<String>,
    pub sample_rate: Option<String>,
    pub sns_topic_arn: Option<String>,
    pub speech_mark_types: Option<Vec<SpeechMarkType>>,
    pub text: Option<String>,
    pub text_type: Option<TextType>,
    pub voice_id: Option<VoiceId>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

engine: Option<Engine>

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.

language_code: Option<LanguageCode>

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.

lexicon_names: Option<Vec<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.

output_format: Option<OutputFormat>

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.

output_s3_bucket_name: Option<String>

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

output_s3_key_prefix: Option<String>

The Amazon S3 key prefix for the output speech file.

sample_rate: Option<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".

sns_topic_arn: Option<String>

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

speech_mark_types: Option<Vec<SpeechMarkType>>

The type of speech marks returned for the input text.

text: Option<String>

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

text_type: Option<TextType>

Specifies whether the input text is plain text or SSML. The default value is plain text.

voice_id: Option<VoiceId>

Voice ID to use for the synthesis.

Implementations

impl StartSpeechSynthesisTaskInput

pub fn engine(&self) -> Option<&Engine>

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.

pub fn language_code(&self) -> Option<&LanguageCode>

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.

pub fn lexicon_names(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .lexicon_names.is_none().

pub fn output_format(&self) -> Option<&OutputFormat>

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.

pub fn output_s3_bucket_name(&self) -> Option<&str>

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

pub fn output_s3_key_prefix(&self) -> Option<&str>

The Amazon S3 key prefix for the output speech file.

pub fn sample_rate(&self) -> Option<&str>

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

pub fn sns_topic_arn(&self) -> Option<&str>

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

pub fn speech_mark_types(&self) -> &[SpeechMarkType]

The type of speech marks returned for the input text.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .speech_mark_types.is_none().

pub fn text(&self) -> Option<&str>

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

pub fn text_type(&self) -> Option<&TextType>

Specifies whether the input text is plain text or SSML. The default value is plain text.

pub fn voice_id(&self) -> Option<&VoiceId>

Voice ID to use for the synthesis.

impl StartSpeechSynthesisTaskInput

pub fn builder() -> StartSpeechSynthesisTaskInputBuilder

Creates a new builder-style object to manufacture StartSpeechSynthesisTaskInput.

Trait Implementations

impl Clone for StartSpeechSynthesisTaskInput

fn clone(&self) -> StartSpeechSynthesisTaskInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartSpeechSynthesisTaskInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StartSpeechSynthesisTaskInput

fn eq(&self, other: &StartSpeechSynthesisTaskInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartSpeechSynthesisTaskInput