#[non_exhaustive]pub struct StartSpeechSynthesisTaskInputBuilder { /* private fields */ }
Expand description
A builder for StartSpeechSynthesisTaskInput
.
Implementations§
Source§impl StartSpeechSynthesisTaskInputBuilder
impl StartSpeechSynthesisTaskInputBuilder
Sourcepub fn engine(self, input: Engine) -> Self
pub fn engine(self, input: Engine) -> Self
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.
Sourcepub fn set_engine(self, input: Option<Engine>) -> Self
pub fn set_engine(self, input: Option<Engine>) -> Self
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.
Sourcepub fn get_engine(&self) -> &Option<Engine>
pub fn get_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.
Sourcepub fn language_code(self, input: LanguageCode) -> Self
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.
Sourcepub fn set_language_code(self, input: Option<LanguageCode>) -> Self
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.
Sourcepub fn get_language_code(&self) -> &Option<LanguageCode>
pub fn get_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.
Sourcepub fn lexicon_names(self, input: impl Into<String>) -> Self
pub fn lexicon_names(self, input: impl Into<String>) -> Self
Appends an item to lexicon_names
.
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.
Sourcepub fn set_lexicon_names(self, input: Option<Vec<String>>) -> Self
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.
Sourcepub fn get_lexicon_names(&self) -> &Option<Vec<String>>
pub fn get_lexicon_names(&self) -> &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.
Sourcepub fn output_format(self, input: OutputFormat) -> Self
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.
This field is required.Sourcepub fn set_output_format(self, input: Option<OutputFormat>) -> Self
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.
Sourcepub fn get_output_format(&self) -> &Option<OutputFormat>
pub fn get_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.
Sourcepub fn output_s3_bucket_name(self, input: impl Into<String>) -> Self
pub fn output_s3_bucket_name(self, input: impl Into<String>) -> Self
Amazon S3 bucket name to which the output file will be saved.
This field is required.Sourcepub fn set_output_s3_bucket_name(self, input: Option<String>) -> Self
pub fn set_output_s3_bucket_name(self, input: Option<String>) -> Self
Amazon S3 bucket name to which the output file will be saved.
Sourcepub fn get_output_s3_bucket_name(&self) -> &Option<String>
pub fn get_output_s3_bucket_name(&self) -> &Option<String>
Amazon S3 bucket name to which the output file will be saved.
Sourcepub fn output_s3_key_prefix(self, input: impl Into<String>) -> Self
pub fn output_s3_key_prefix(self, input: impl Into<String>) -> Self
The Amazon S3 key prefix for the output speech file.
Sourcepub fn set_output_s3_key_prefix(self, input: Option<String>) -> Self
pub fn set_output_s3_key_prefix(self, input: Option<String>) -> Self
The Amazon S3 key prefix for the output speech file.
Sourcepub fn get_output_s3_key_prefix(&self) -> &Option<String>
pub fn get_output_s3_key_prefix(&self) -> &Option<String>
The Amazon S3 key prefix for the output speech file.
Sourcepub fn sample_rate(self, input: impl Into<String>) -> Self
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". 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".
Sourcepub fn set_sample_rate(self, input: Option<String>) -> Self
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". 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".
Sourcepub fn get_sample_rate(&self) -> &Option<String>
pub fn get_sample_rate(&self) -> &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".
Sourcepub fn sns_topic_arn(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_sns_topic_arn(self, input: Option<String>) -> Self
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.
Sourcepub fn get_sns_topic_arn(&self) -> &Option<String>
pub fn get_sns_topic_arn(&self) -> &Option<String>
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
Sourcepub fn speech_mark_types(self, input: SpeechMarkType) -> Self
pub fn speech_mark_types(self, input: SpeechMarkType) -> Self
Appends an item to speech_mark_types
.
To override the contents of this collection use set_speech_mark_types
.
The type of speech marks returned for the input text.
Sourcepub fn set_speech_mark_types(self, input: Option<Vec<SpeechMarkType>>) -> Self
pub fn set_speech_mark_types(self, input: Option<Vec<SpeechMarkType>>) -> Self
The type of speech marks returned for the input text.
Sourcepub fn get_speech_mark_types(&self) -> &Option<Vec<SpeechMarkType>>
pub fn get_speech_mark_types(&self) -> &Option<Vec<SpeechMarkType>>
The type of speech marks returned for the input text.
Sourcepub fn text(self, input: impl Into<String>) -> Self
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.
This field is required.Sourcepub fn set_text(self, input: Option<String>) -> Self
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.
Sourcepub fn get_text(&self) -> &Option<String>
pub fn get_text(&self) -> &Option<String>
The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.
Sourcepub fn text_type(self, input: TextType) -> Self
pub fn text_type(self, input: TextType) -> Self
Specifies whether the input text is plain text or SSML. The default value is plain text.
Sourcepub fn set_text_type(self, input: Option<TextType>) -> Self
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.
Sourcepub fn get_text_type(&self) -> &Option<TextType>
pub fn get_text_type(&self) -> &Option<TextType>
Specifies whether the input text is plain text or SSML. The default value is plain text.
Sourcepub fn voice_id(self, input: VoiceId) -> Self
pub fn voice_id(self, input: VoiceId) -> Self
Voice ID to use for the synthesis.
This field is required.Sourcepub fn set_voice_id(self, input: Option<VoiceId>) -> Self
pub fn set_voice_id(self, input: Option<VoiceId>) -> Self
Voice ID to use for the synthesis.
Sourcepub fn get_voice_id(&self) -> &Option<VoiceId>
pub fn get_voice_id(&self) -> &Option<VoiceId>
Voice ID to use for the synthesis.
Sourcepub fn build(self) -> Result<StartSpeechSynthesisTaskInput, BuildError>
pub fn build(self) -> Result<StartSpeechSynthesisTaskInput, BuildError>
Consumes the builder and constructs a StartSpeechSynthesisTaskInput
.
Source§impl StartSpeechSynthesisTaskInputBuilder
impl StartSpeechSynthesisTaskInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<StartSpeechSynthesisTaskOutput, SdkError<StartSpeechSynthesisTaskError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<StartSpeechSynthesisTaskOutput, SdkError<StartSpeechSynthesisTaskError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for StartSpeechSynthesisTaskInputBuilder
impl Clone for StartSpeechSynthesisTaskInputBuilder
Source§fn clone(&self) -> StartSpeechSynthesisTaskInputBuilder
fn clone(&self) -> StartSpeechSynthesisTaskInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for StartSpeechSynthesisTaskInputBuilder
impl Default for StartSpeechSynthesisTaskInputBuilder
Source§fn default() -> StartSpeechSynthesisTaskInputBuilder
fn default() -> StartSpeechSynthesisTaskInputBuilder
Source§impl PartialEq for StartSpeechSynthesisTaskInputBuilder
impl PartialEq for StartSpeechSynthesisTaskInputBuilder
Source§fn eq(&self, other: &StartSpeechSynthesisTaskInputBuilder) -> bool
fn eq(&self, other: &StartSpeechSynthesisTaskInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for StartSpeechSynthesisTaskInputBuilder
Auto Trait Implementations§
impl Freeze for StartSpeechSynthesisTaskInputBuilder
impl RefUnwindSafe for StartSpeechSynthesisTaskInputBuilder
impl Send for StartSpeechSynthesisTaskInputBuilder
impl Sync for StartSpeechSynthesisTaskInputBuilder
impl Unpin for StartSpeechSynthesisTaskInputBuilder
impl UnwindSafe for StartSpeechSynthesisTaskInputBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);