#[non_exhaustive]pub struct Artwork {
pub input_key: Option<String>,
pub max_width: Option<String>,
pub max_height: Option<String>,
pub sizing_policy: Option<String>,
pub padding_policy: Option<String>,
pub album_art_format: Option<String>,
pub encryption: Option<Encryption>,
}
Expand description
The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20.
To remove artwork or leave the artwork empty, you can either set Artwork
to null, or set the Merge Policy
to "Replace" and use an empty Artwork
array.
To pass through existing artwork unchanged, set the Merge Policy
to "Prepend", "Append", or "Fallback", and use an empty Artwork
array.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.input_key: Option<String>
The name of the file to be used as album art. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by PipelineId
; the InputBucket
object in that pipeline identifies the bucket.
If the file name includes a prefix, for example, cooking/pie.jpg
, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.
max_width: Option<String>
The maximum width of the output album art in pixels. If you specify auto
, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 4096, inclusive.
max_height: Option<String>
The maximum height of the output album art in pixels. If you specify auto
, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 3072, inclusive.
sizing_policy: Option<String>
Specify one of the following values to control scaling of the output album art:
-
Fit:
Elastic Transcoder scales the output art so it matches the value that you specified in eitherMaxWidth
orMaxHeight
without exceeding the other value. -
Fill:
Elastic Transcoder scales the output art so it matches the value that you specified in eitherMaxWidth
orMaxHeight
and matches or exceeds the other value. Elastic Transcoder centers the output art and then crops it in the dimension (if any) that exceeds the maximum value. -
Stretch:
Elastic Transcoder stretches the output art to match the values that you specified forMaxWidth
andMaxHeight
. If the relative proportions of the input art and the output art are different, the output art will be distorted. -
Keep:
Elastic Transcoder does not scale the output art. If either dimension of the input art exceeds the values that you specified forMaxWidth
andMaxHeight
, Elastic Transcoder crops the output art. -
ShrinkToFit:
Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one ofMaxWidth
andMaxHeight
without exceeding either value. If you specify this option, Elastic Transcoder does not scale the art up. -
ShrinkToFill
Elastic Transcoder scales the output art down so that its 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 the art up.
padding_policy: Option<String>
When you set PaddingPolicy
to Pad
, Elastic Transcoder may add white bars to the top and bottom and/or left and right sides of the output album art to make the total size of the output art match the values that you specified for MaxWidth
and MaxHeight
.
album_art_format: Option<String>
The format of album art, if any. Valid formats are .jpg
and .png
.
encryption: Option<Encryption>
The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
Implementations§
Source§impl Artwork
impl Artwork
Sourcepub fn input_key(&self) -> Option<&str>
pub fn input_key(&self) -> Option<&str>
The name of the file to be used as album art. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by PipelineId
; the InputBucket
object in that pipeline identifies the bucket.
If the file name includes a prefix, for example, cooking/pie.jpg
, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.
Sourcepub fn max_width(&self) -> Option<&str>
pub fn max_width(&self) -> Option<&str>
The maximum width of the output album art in pixels. If you specify auto
, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 4096, inclusive.
Sourcepub fn max_height(&self) -> Option<&str>
pub fn max_height(&self) -> Option<&str>
The maximum height of the output album art in pixels. If you specify auto
, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 3072, inclusive.
Sourcepub fn sizing_policy(&self) -> Option<&str>
pub fn sizing_policy(&self) -> Option<&str>
Specify one of the following values to control scaling of the output album art:
-
Fit:
Elastic Transcoder scales the output art so it matches the value that you specified in eitherMaxWidth
orMaxHeight
without exceeding the other value. -
Fill:
Elastic Transcoder scales the output art so it matches the value that you specified in eitherMaxWidth
orMaxHeight
and matches or exceeds the other value. Elastic Transcoder centers the output art and then crops it in the dimension (if any) that exceeds the maximum value. -
Stretch:
Elastic Transcoder stretches the output art to match the values that you specified forMaxWidth
andMaxHeight
. If the relative proportions of the input art and the output art are different, the output art will be distorted. -
Keep:
Elastic Transcoder does not scale the output art. If either dimension of the input art exceeds the values that you specified forMaxWidth
andMaxHeight
, Elastic Transcoder crops the output art. -
ShrinkToFit:
Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one ofMaxWidth
andMaxHeight
without exceeding either value. If you specify this option, Elastic Transcoder does not scale the art up. -
ShrinkToFill
Elastic Transcoder scales the output art down so that its 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 the art up.
Sourcepub fn padding_policy(&self) -> Option<&str>
pub fn padding_policy(&self) -> Option<&str>
When you set PaddingPolicy
to Pad
, Elastic Transcoder may add white bars to the top and bottom and/or left and right sides of the output album art to make the total size of the output art match the values that you specified for MaxWidth
and MaxHeight
.
Sourcepub fn album_art_format(&self) -> Option<&str>
pub fn album_art_format(&self) -> Option<&str>
The format of album art, if any. Valid formats are .jpg
and .png
.
Sourcepub fn encryption(&self) -> Option<&Encryption>
pub fn encryption(&self) -> Option<&Encryption>
The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
Trait Implementations§
impl StructuralPartialEq for Artwork
Auto Trait Implementations§
impl Freeze for Artwork
impl RefUnwindSafe for Artwork
impl Send for Artwork
impl Sync for Artwork
impl Unpin for Artwork
impl UnwindSafe for Artwork
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);