Struct aws_sdk_polly::client::fluent_builders::StartSpeechSynthesisTask

pub struct StartSpeechSynthesisTask { /* private fields */ }

Fluent builder constructing a request to StartSpeechSynthesisTask.

Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status. The SpeechSynthesisTask object is available for 72 hours after starting the asynchronous synthesis task.

Implementations

impl StartSpeechSynthesisTask

pub async fn send(
    self
) -> Result<StartSpeechSynthesisTaskOutput, SdkError<StartSpeechSynthesisTaskError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn engine(self, input: Engine) -> Self

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.

pub fn set_engine(self, input: Option<Engine>) -> Self

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.

pub fn language_code(self, input: LanguageCode) -> Self

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 set_language_code(self, input: Option<LanguageCode>) -> Self

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, input: impl Into<String>) -> Self

Appends an item to LexiconNames.

To override the contents of this collection use set_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.

pub fn set_lexicon_names(self, input: Option<Vec<String>>) -> Self

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.

pub fn output_format(self, input: OutputFormat) -> Self

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 set_output_format(self, input: Option<OutputFormat>) -> Self

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, input: impl Into<String>) -> Self

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

pub fn set_output_s3_bucket_name(self, input: Option<String>) -> Self

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

pub fn output_s3_key_prefix(self, input: impl Into<String>) -> Self

The Amazon S3 key prefix for the output speech file.

pub fn set_output_s3_key_prefix(self, input: Option<String>) -> Self

The Amazon S3 key prefix for the output speech file.

pub fn sample_rate(self, input: impl Into<String>) -> Self

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

pub fn set_sample_rate(self, input: Option<String>) -> Self

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

pub fn sns_topic_arn(self, input: impl Into<String>) -> Self

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

pub fn set_sns_topic_arn(self, input: Option<String>) -> Self

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

pub fn speech_mark_types(self, input: SpeechMarkType) -> Self

Appends an item to SpeechMarkTypes.

To override the contents of this collection use set_speech_mark_types.

The type of speech marks returned for the input text.

pub fn set_speech_mark_types(self, input: Option<Vec<SpeechMarkType>>) -> Self

The type of speech marks returned for the input text.

pub fn text(self, input: impl Into<String>) -> Self

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

pub fn set_text(self, input: Option<String>) -> Self

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, input: TextType) -> Self

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

pub fn set_text_type(self, input: Option<TextType>) -> Self

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

pub fn voice_id(self, input: VoiceId) -> Self

Voice ID to use for the synthesis.

pub fn set_voice_id(self, input: Option<VoiceId>) -> Self

Voice ID to use for the synthesis.

Trait Implementations

impl Clone for StartSpeechSynthesisTask

fn clone(&self) -> StartSpeechSynthesisTask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartSpeechSynthesisTask

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

Formats the value using the given formatter.