Struct SynthesisTask

#[non_exhaustive]
pub struct SynthesisTask {

    pub engine: Option<Engine>,
    pub task_id: Option<String>,
    pub task_status: Option<TaskStatus>,
    pub task_status_reason: Option<String>,
    pub output_uri: Option<String>,
    pub creation_time: Option<DateTime>,
    pub request_characters: i32,
    pub sns_topic_arn: Option<String>,
    pub lexicon_names: Option<Vec<String>>,
    pub output_format: Option<OutputFormat>,
    pub sample_rate: Option<String>,
    pub speech_mark_types: Option<Vec<SpeechMarkType>>,
    pub text_type: Option<TextType>,
    pub voice_id: Option<VoiceId>,
    pub language_code: Option<LanguageCode>,
}

SynthesisTask object that provides information about a speech synthesis task.

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.

task_id: Option<String>

The Amazon Polly generated identifier for a speech synthesis task.

task_status: Option<TaskStatus>

Current status of the individual speech synthesis task.

task_status_reason: Option<String>

Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

output_uri: Option<String>

Pathway for the output speech file.

creation_time: Option<DateTime>

Timestamp for the time the synthesis task was started.

request_characters: i32

Number of billable characters synthesized.

sns_topic_arn: Option<String>

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

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.

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

speech_mark_types: Option<Vec<SpeechMarkType>>

The type of speech marks returned 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.

language_code: Option<LanguageCode>

Optional language code for a synthesis task. 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.

Implementations

impl SynthesisTask

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 task_id(&self) -> Option<&str>

The Amazon Polly generated identifier for a speech synthesis task.

pub fn task_status(&self) -> Option<&TaskStatus>

Current status of the individual speech synthesis task.

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

Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

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

Pathway for the output speech file.

pub fn creation_time(&self) -> Option<&DateTime>

Timestamp for the time the synthesis task was started.

pub fn request_characters(&self) -> i32

Number of billable characters synthesized.

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

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

Optional language code for a synthesis task. 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.

impl SynthesisTask

pub fn builder() -> SynthesisTaskBuilder

Creates a new builder-style object to manufacture SynthesisTask.

Trait Implementations

impl Clone for SynthesisTask

fn clone(&self) -> SynthesisTask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SynthesisTask

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

Formats the value using the given formatter.

impl PartialEq for SynthesisTask

fn eq(&self, other: &SynthesisTask) -> 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 SynthesisTask