#[non_exhaustive]pub struct ThumbnailsBuilder { /* private fields */ }
Expand description
A builder for Thumbnails
.
Implementations§
source§impl ThumbnailsBuilder
impl ThumbnailsBuilder
sourcepub fn format(self, input: impl Into<String>) -> Self
pub fn format(self, input: impl Into<String>) -> Self
The format of thumbnails, if any. Valid values are jpg
and png
.
You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
sourcepub fn set_format(self, input: Option<String>) -> Self
pub fn set_format(self, input: Option<String>) -> Self
The format of thumbnails, if any. Valid values are jpg
and png
.
You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
sourcepub fn get_format(&self) -> &Option<String>
pub fn get_format(&self) -> &Option<String>
The format of thumbnails, if any. Valid values are jpg
and png
.
You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
sourcepub fn interval(self, input: impl Into<String>) -> Self
pub fn interval(self, input: impl Into<String>) -> Self
The approximate number of seconds between thumbnails. Specify an integer value.
sourcepub fn set_interval(self, input: Option<String>) -> Self
pub fn set_interval(self, input: Option<String>) -> Self
The approximate number of seconds between thumbnails. Specify an integer value.
sourcepub fn get_interval(&self) -> &Option<String>
pub fn get_interval(&self) -> &Option<String>
The approximate number of seconds between thumbnails. Specify an integer value.
sourcepub fn resolution(self, input: impl Into<String>) -> Self
pub fn resolution(self, input: impl Into<String>) -> Self
To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth
, MaxHeight
, SizingPolicy
, and PaddingPolicy
instead of Resolution
and AspectRatio
. The two groups of settings are mutually exclusive. Do not use them together.
The width and height of thumbnail files in pixels. Specify a value in the format width
x height
where both values are even integers. The values cannot exceed the width and height that you specified in the Video:Resolution
object.
sourcepub fn set_resolution(self, input: Option<String>) -> Self
pub fn set_resolution(self, input: Option<String>) -> Self
To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth
, MaxHeight
, SizingPolicy
, and PaddingPolicy
instead of Resolution
and AspectRatio
. The two groups of settings are mutually exclusive. Do not use them together.
The width and height of thumbnail files in pixels. Specify a value in the format width
x height
where both values are even integers. The values cannot exceed the width and height that you specified in the Video:Resolution
object.
sourcepub fn get_resolution(&self) -> &Option<String>
pub fn get_resolution(&self) -> &Option<String>
To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth
, MaxHeight
, SizingPolicy
, and PaddingPolicy
instead of Resolution
and AspectRatio
. The two groups of settings are mutually exclusive. Do not use them together.
The width and height of thumbnail files in pixels. Specify a value in the format width
x height
where both values are even integers. The values cannot exceed the width and height that you specified in the Video:Resolution
object.
sourcepub fn aspect_ratio(self, input: impl Into<String>) -> Self
pub fn aspect_ratio(self, input: impl Into<String>) -> Self
To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth
, MaxHeight
, SizingPolicy
, and PaddingPolicy
instead of Resolution
and AspectRatio
. The two groups of settings are mutually exclusive. Do not use them together.
The aspect ratio of thumbnails. Valid values include:
auto
, 1:1
, 4:3
, 3:2
, 16:9
If you specify auto
, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file.
sourcepub fn set_aspect_ratio(self, input: Option<String>) -> Self
pub fn set_aspect_ratio(self, input: Option<String>) -> Self
To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth
, MaxHeight
, SizingPolicy
, and PaddingPolicy
instead of Resolution
and AspectRatio
. The two groups of settings are mutually exclusive. Do not use them together.
The aspect ratio of thumbnails. Valid values include:
auto
, 1:1
, 4:3
, 3:2
, 16:9
If you specify auto
, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file.
sourcepub fn get_aspect_ratio(&self) -> &Option<String>
pub fn get_aspect_ratio(&self) -> &Option<String>
To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth
, MaxHeight
, SizingPolicy
, and PaddingPolicy
instead of Resolution
and AspectRatio
. The two groups of settings are mutually exclusive. Do not use them together.
The aspect ratio of thumbnails. Valid values include:
auto
, 1:1
, 4:3
, 3:2
, 16:9
If you specify auto
, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file.
sourcepub fn max_width(self, input: impl Into<String>) -> Self
pub fn max_width(self, input: impl Into<String>) -> Self
The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096.
sourcepub fn set_max_width(self, input: Option<String>) -> Self
pub fn set_max_width(self, input: Option<String>) -> Self
The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096.
sourcepub fn get_max_width(&self) -> &Option<String>
pub fn get_max_width(&self) -> &Option<String>
The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096.
sourcepub fn max_height(self, input: impl Into<String>) -> Self
pub fn max_height(self, input: impl Into<String>) -> Self
The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072.
sourcepub fn set_max_height(self, input: Option<String>) -> Self
pub fn set_max_height(self, input: Option<String>) -> Self
The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072.
sourcepub fn get_max_height(&self) -> &Option<String>
pub fn get_max_height(&self) -> &Option<String>
The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072.
sourcepub fn sizing_policy(self, input: impl Into<String>) -> Self
pub fn sizing_policy(self, input: impl Into<String>) -> Self
Specify one of the following values to control scaling of thumbnails:
-
Fit
: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding the other value. -
Fill
: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnailMaxWidth
orMaxHeight
settings and matches or exceeds the other value. Elastic Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum value. -
Stretch
: Elastic Transcoder stretches thumbnails to match the values that you specified for thumbnailMaxWidth
andMaxHeight
settings. If the relative proportions of the input video and thumbnails are different, the thumbnails will be distorted. -
Keep
: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds the values that you specified for thumbnailMaxWidth
andMaxHeight
settings, Elastic Transcoder crops the thumbnails. -
ShrinkToFit
: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of thumbnailMaxWidth
andMaxHeight
without exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up. -
ShrinkToFill
: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one ofMaxWidth
andMaxHeight
without dropping below either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.
sourcepub fn set_sizing_policy(self, input: Option<String>) -> Self
pub fn set_sizing_policy(self, input: Option<String>) -> Self
Specify one of the following values to control scaling of thumbnails:
-
Fit
: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding the other value. -
Fill
: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnailMaxWidth
orMaxHeight
settings and matches or exceeds the other value. Elastic Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum value. -
Stretch
: Elastic Transcoder stretches thumbnails to match the values that you specified for thumbnailMaxWidth
andMaxHeight
settings. If the relative proportions of the input video and thumbnails are different, the thumbnails will be distorted. -
Keep
: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds the values that you specified for thumbnailMaxWidth
andMaxHeight
settings, Elastic Transcoder crops the thumbnails. -
ShrinkToFit
: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of thumbnailMaxWidth
andMaxHeight
without exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up. -
ShrinkToFill
: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one ofMaxWidth
andMaxHeight
without dropping below either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.
sourcepub fn get_sizing_policy(&self) -> &Option<String>
pub fn get_sizing_policy(&self) -> &Option<String>
Specify one of the following values to control scaling of thumbnails:
-
Fit
: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding the other value. -
Fill
: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnailMaxWidth
orMaxHeight
settings and matches or exceeds the other value. Elastic Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum value. -
Stretch
: Elastic Transcoder stretches thumbnails to match the values that you specified for thumbnailMaxWidth
andMaxHeight
settings. If the relative proportions of the input video and thumbnails are different, the thumbnails will be distorted. -
Keep
: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds the values that you specified for thumbnailMaxWidth
andMaxHeight
settings, Elastic Transcoder crops the thumbnails. -
ShrinkToFit
: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of thumbnailMaxWidth
andMaxHeight
without exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up. -
ShrinkToFill
: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one ofMaxWidth
andMaxHeight
without dropping below either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.
sourcepub fn padding_policy(self, input: impl Into<String>) -> Self
pub fn padding_policy(self, input: impl Into<String>) -> Self
When you set PaddingPolicy
to Pad
, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnail MaxWidth
and MaxHeight
settings.
sourcepub fn set_padding_policy(self, input: Option<String>) -> Self
pub fn set_padding_policy(self, input: Option<String>) -> Self
When you set PaddingPolicy
to Pad
, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnail MaxWidth
and MaxHeight
settings.
sourcepub fn get_padding_policy(&self) -> &Option<String>
pub fn get_padding_policy(&self) -> &Option<String>
When you set PaddingPolicy
to Pad
, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnail MaxWidth
and MaxHeight
settings.
sourcepub fn build(self) -> Thumbnails
pub fn build(self) -> Thumbnails
Consumes the builder and constructs a Thumbnails
.
Trait Implementations§
source§impl Clone for ThumbnailsBuilder
impl Clone for ThumbnailsBuilder
source§fn clone(&self) -> ThumbnailsBuilder
fn clone(&self) -> ThumbnailsBuilder
1.6.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ThumbnailsBuilder
impl Debug for ThumbnailsBuilder
source§impl Default for ThumbnailsBuilder
impl Default for ThumbnailsBuilder
source§fn default() -> ThumbnailsBuilder
fn default() -> ThumbnailsBuilder
source§impl PartialEq for ThumbnailsBuilder
impl PartialEq for ThumbnailsBuilder
impl StructuralPartialEq for ThumbnailsBuilder
Auto Trait Implementations§
impl Freeze for ThumbnailsBuilder
impl RefUnwindSafe for ThumbnailsBuilder
impl Send for ThumbnailsBuilder
impl Sync for ThumbnailsBuilder
impl Unpin for ThumbnailsBuilder
impl UnwindSafe for ThumbnailsBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);