#[non_exhaustive]pub struct SettingsBuilder { /* private fields */ }
Expand description
A builder for Settings
.
Implementations§
Source§impl SettingsBuilder
impl SettingsBuilder
Sourcepub fn vocabulary_name(self, input: impl Into<String>) -> Self
pub fn vocabulary_name(self, input: impl Into<String>) -> Self
The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
Sourcepub fn set_vocabulary_name(self, input: Option<String>) -> Self
pub fn set_vocabulary_name(self, input: Option<String>) -> Self
The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
Sourcepub fn get_vocabulary_name(&self) -> &Option<String>
pub fn get_vocabulary_name(&self) -> &Option<String>
The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
Sourcepub fn show_speaker_labels(self, input: bool) -> Self
pub fn show_speaker_labels(self, input: bool) -> Self
Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.
If you enable ShowSpeakerLabels
in your request, you must also include MaxSpeakerLabels
.
For more information, see Partitioning speakers (diarization).
Sourcepub fn set_show_speaker_labels(self, input: Option<bool>) -> Self
pub fn set_show_speaker_labels(self, input: Option<bool>) -> Self
Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.
If you enable ShowSpeakerLabels
in your request, you must also include MaxSpeakerLabels
.
For more information, see Partitioning speakers (diarization).
Sourcepub fn get_show_speaker_labels(&self) -> &Option<bool>
pub fn get_show_speaker_labels(&self) -> &Option<bool>
Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.
If you enable ShowSpeakerLabels
in your request, you must also include MaxSpeakerLabels
.
For more information, see Partitioning speakers (diarization).
Sourcepub fn max_speaker_labels(self, input: i32) -> Self
pub fn max_speaker_labels(self, input: i32) -> Self
Specify the maximum number of speakers you want to partition in your media.
Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.
If you specify the MaxSpeakerLabels
field, you must set the ShowSpeakerLabels
field to true.
Sourcepub fn set_max_speaker_labels(self, input: Option<i32>) -> Self
pub fn set_max_speaker_labels(self, input: Option<i32>) -> Self
Specify the maximum number of speakers you want to partition in your media.
Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.
If you specify the MaxSpeakerLabels
field, you must set the ShowSpeakerLabels
field to true.
Sourcepub fn get_max_speaker_labels(&self) -> &Option<i32>
pub fn get_max_speaker_labels(&self) -> &Option<i32>
Specify the maximum number of speakers you want to partition in your media.
Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.
If you specify the MaxSpeakerLabels
field, you must set the ShowSpeakerLabels
field to true.
Sourcepub fn channel_identification(self, input: bool) -> Self
pub fn channel_identification(self, input: bool) -> Self
Enables channel identification in multi-channel audio.
Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
For more information, see Transcribing multi-channel audio.
Sourcepub fn set_channel_identification(self, input: Option<bool>) -> Self
pub fn set_channel_identification(self, input: Option<bool>) -> Self
Enables channel identification in multi-channel audio.
Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
For more information, see Transcribing multi-channel audio.
Sourcepub fn get_channel_identification(&self) -> &Option<bool>
pub fn get_channel_identification(&self) -> &Option<bool>
Enables channel identification in multi-channel audio.
Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
For more information, see Transcribing multi-channel audio.
Sourcepub fn show_alternatives(self, input: bool) -> Self
pub fn show_alternatives(self, input: bool) -> Self
To include alternative transcriptions within your transcription output, include ShowAlternatives
in your transcription request.
If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
If you include ShowAlternatives
, you must also include MaxAlternatives
, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.
For more information, see Alternative transcriptions.
Sourcepub fn set_show_alternatives(self, input: Option<bool>) -> Self
pub fn set_show_alternatives(self, input: Option<bool>) -> Self
To include alternative transcriptions within your transcription output, include ShowAlternatives
in your transcription request.
If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
If you include ShowAlternatives
, you must also include MaxAlternatives
, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.
For more information, see Alternative transcriptions.
Sourcepub fn get_show_alternatives(&self) -> &Option<bool>
pub fn get_show_alternatives(&self) -> &Option<bool>
To include alternative transcriptions within your transcription output, include ShowAlternatives
in your transcription request.
If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
If you include ShowAlternatives
, you must also include MaxAlternatives
, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.
For more information, see Alternative transcriptions.
Sourcepub fn max_alternatives(self, input: i32) -> Self
pub fn max_alternatives(self, input: i32) -> Self
Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.
If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.
If you include MaxAlternatives
in your request, you must also include ShowAlternatives
with a value of true
.
For more information, see Alternative transcriptions.
Sourcepub fn set_max_alternatives(self, input: Option<i32>) -> Self
pub fn set_max_alternatives(self, input: Option<i32>) -> Self
Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.
If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.
If you include MaxAlternatives
in your request, you must also include ShowAlternatives
with a value of true
.
For more information, see Alternative transcriptions.
Sourcepub fn get_max_alternatives(&self) -> &Option<i32>
pub fn get_max_alternatives(&self) -> &Option<i32>
Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.
If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.
If you include MaxAlternatives
in your request, you must also include ShowAlternatives
with a value of true
.
For more information, see Alternative transcriptions.
Sourcepub fn vocabulary_filter_name(self, input: impl Into<String>) -> Self
pub fn vocabulary_filter_name(self, input: impl Into<String>) -> Self
The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
Note that if you include VocabularyFilterName
in your request, you must also include VocabularyFilterMethod
.
Sourcepub fn set_vocabulary_filter_name(self, input: Option<String>) -> Self
pub fn set_vocabulary_filter_name(self, input: Option<String>) -> Self
The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
Note that if you include VocabularyFilterName
in your request, you must also include VocabularyFilterMethod
.
Sourcepub fn get_vocabulary_filter_name(&self) -> &Option<String>
pub fn get_vocabulary_filter_name(&self) -> &Option<String>
The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
Note that if you include VocabularyFilterName
in your request, you must also include VocabularyFilterMethod
.
Sourcepub fn vocabulary_filter_method(self, input: VocabularyFilterMethod) -> Self
pub fn vocabulary_filter_method(self, input: VocabularyFilterMethod) -> Self
Specify how you want your custom vocabulary filter applied to your transcript.
To replace words with ***
, choose mask
.
To delete words, choose remove
.
To flag words without changing them, choose tag
.
Sourcepub fn set_vocabulary_filter_method(
self,
input: Option<VocabularyFilterMethod>,
) -> Self
pub fn set_vocabulary_filter_method( self, input: Option<VocabularyFilterMethod>, ) -> Self
Specify how you want your custom vocabulary filter applied to your transcript.
To replace words with ***
, choose mask
.
To delete words, choose remove
.
To flag words without changing them, choose tag
.
Sourcepub fn get_vocabulary_filter_method(&self) -> &Option<VocabularyFilterMethod>
pub fn get_vocabulary_filter_method(&self) -> &Option<VocabularyFilterMethod>
Specify how you want your custom vocabulary filter applied to your transcript.
To replace words with ***
, choose mask
.
To delete words, choose remove
.
To flag words without changing them, choose tag
.
Trait Implementations§
Source§impl Clone for SettingsBuilder
impl Clone for SettingsBuilder
Source§fn clone(&self) -> SettingsBuilder
fn clone(&self) -> SettingsBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for SettingsBuilder
impl Debug for SettingsBuilder
Source§impl Default for SettingsBuilder
impl Default for SettingsBuilder
Source§fn default() -> SettingsBuilder
fn default() -> SettingsBuilder
Source§impl PartialEq for SettingsBuilder
impl PartialEq for SettingsBuilder
impl StructuralPartialEq for SettingsBuilder
Auto Trait Implementations§
impl Freeze for SettingsBuilder
impl RefUnwindSafe for SettingsBuilder
impl Send for SettingsBuilder
impl Sync for SettingsBuilder
impl Unpin for SettingsBuilder
impl UnwindSafe for SettingsBuilder
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);