#[non_exhaustive]pub struct InsertableImage {
pub duration: Option<i32>,
pub fade_in: Option<i32>,
pub fade_out: Option<i32>,
pub height: Option<i32>,
pub image_inserter_input: Option<String>,
pub image_x: Option<i32>,
pub image_y: Option<i32>,
pub layer: Option<i32>,
pub opacity: Option<i32>,
pub start_time: Option<String>,
pub width: Option<i32>,
}Expand description
These settings apply to a specific graphic overlay. You can include multiple overlays in your job.
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.duration: Option<i32>Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time.
fade_in: Option<i32>Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If you don’t specify a value for Fade-in, the image will appear abruptly at the overlay start time.
fade_out: Option<i32>Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. If you don’t specify a value for Fade-out, the image will disappear abruptly at the end of the inserted image duration.
height: Option<i32>Specify the height of the inserted image in pixels. If you specify a value that’s larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank.
image_inserter_input: Option<String>Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.
image_x: Option<i32>Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify.
image_y: Option<i32>Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.
layer: Option<i32>Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer.
opacity: Option<i32>Use Opacity to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.
start_time: Option<String>Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.
width: Option<i32>Specify the width of the inserted image in pixels. If you specify a value that’s larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank.
Implementations§
Source§impl InsertableImage
impl InsertableImage
Sourcepub fn duration(&self) -> Option<i32>
pub fn duration(&self) -> Option<i32>
Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time.
Sourcepub fn fade_in(&self) -> Option<i32>
pub fn fade_in(&self) -> Option<i32>
Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If you don’t specify a value for Fade-in, the image will appear abruptly at the overlay start time.
Sourcepub fn fade_out(&self) -> Option<i32>
pub fn fade_out(&self) -> Option<i32>
Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. If you don’t specify a value for Fade-out, the image will disappear abruptly at the end of the inserted image duration.
Sourcepub fn height(&self) -> Option<i32>
pub fn height(&self) -> Option<i32>
Specify the height of the inserted image in pixels. If you specify a value that’s larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank.
Sourcepub fn image_inserter_input(&self) -> Option<&str>
pub fn image_inserter_input(&self) -> Option<&str>
Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.
Sourcepub fn image_x(&self) -> Option<i32>
pub fn image_x(&self) -> Option<i32>
Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify.
Sourcepub fn image_y(&self) -> Option<i32>
pub fn image_y(&self) -> Option<i32>
Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.
Sourcepub fn layer(&self) -> Option<i32>
pub fn layer(&self) -> Option<i32>
Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer.
Sourcepub fn opacity(&self) -> Option<i32>
pub fn opacity(&self) -> Option<i32>
Use Opacity to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.
Sourcepub fn start_time(&self) -> Option<&str>
pub fn start_time(&self) -> Option<&str>
Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.
Source§impl InsertableImage
impl InsertableImage
Sourcepub fn builder() -> InsertableImageBuilder
pub fn builder() -> InsertableImageBuilder
Creates a new builder-style object to manufacture InsertableImage.
Trait Implementations§
Source§impl Clone for InsertableImage
impl Clone for InsertableImage
Source§fn clone(&self) -> InsertableImage
fn clone(&self) -> InsertableImage
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for InsertableImage
impl Debug for InsertableImage
Source§impl PartialEq for InsertableImage
impl PartialEq for InsertableImage
Source§fn eq(&self, other: &InsertableImage) -> bool
fn eq(&self, other: &InsertableImage) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for InsertableImage
Auto Trait Implementations§
impl Freeze for InsertableImage
impl RefUnwindSafe for InsertableImage
impl Send for InsertableImage
impl Sync for InsertableImage
impl Unpin for InsertableImage
impl UnsafeUnpin for InsertableImage
impl UnwindSafe for InsertableImage
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>
renamed to 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);