Struct aws_sdk_elastictranscoder::model::preset_watermark::Builder

#[non_exhaustive]
pub struct Builder { /* fields omitted */ }

A builder for PresetWatermark

Implementations

impl Builder

pub fn id(self, input: impl Into<String>) -> Self

A unique identifier for the settings for one watermark. The value of Id can be up to 40 characters long.

pub fn set_id(self, input: Option<String>) -> Self

A unique identifier for the settings for one watermark. The value of Id can be up to 40 characters long.

pub fn max_width(self, input: impl Into<String>) -> Self

The maximum width of the watermark in one of the following formats:

• number of pixels (px): The minimum value is 16 pixels, and the maximum value is the value of MaxWidth.

• integer percentage (%): The range of valid values is 0 to 100. Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation.

  If you specify the value in pixels, it must be less than or equal to the value of MaxWidth.

pub fn set_max_width(self, input: Option<String>) -> Self

The maximum width of the watermark in one of the following formats:

• number of pixels (px): The minimum value is 16 pixels, and the maximum value is the value of MaxWidth.

• integer percentage (%): The range of valid values is 0 to 100. Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation.

  If you specify the value in pixels, it must be less than or equal to the value of MaxWidth.

pub fn max_height(self, input: impl Into<String>) -> Self

The maximum height of the watermark in one of the following formats:

• number of pixels (px): The minimum value is 16 pixels, and the maximum value is the value of MaxHeight.

• integer percentage (%): The range of valid values is 0 to 100. Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation.

If you specify the value in pixels, it must be less than or equal to the value of MaxHeight.

pub fn set_max_height(self, input: Option<String>) -> Self

The maximum height of the watermark in one of the following formats:

• number of pixels (px): The minimum value is 16 pixels, and the maximum value is the value of MaxHeight.

• integer percentage (%): The range of valid values is 0 to 100. Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation.

If you specify the value in pixels, it must be less than or equal to the value of MaxHeight.

pub fn sizing_policy(self, input: impl Into<String>) -> Self

A value that controls scaling of the watermark:

• Fit: Elastic Transcoder scales the watermark so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value.

• Stretch: Elastic Transcoder stretches the watermark to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the watermark and the values of MaxWidth and MaxHeight are different, the watermark will be distorted.

• ShrinkToFit: Elastic Transcoder scales the watermark down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the watermark up.

pub fn set_sizing_policy(self, input: Option<String>) -> Self

A value that controls scaling of the watermark:

• Fit: Elastic Transcoder scales the watermark so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value.

• Stretch: Elastic Transcoder stretches the watermark to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the watermark and the values of MaxWidth and MaxHeight are different, the watermark will be distorted.

• ShrinkToFit: Elastic Transcoder scales the watermark down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the watermark up.

pub fn horizontal_align(self, input: impl Into<String>) -> Self

The horizontal position of the watermark unless you specify a non-zero value for HorizontalOffset:

• Left: The left edge of the watermark is aligned with the left border of the video.

• Right: The right edge of the watermark is aligned with the right border of the video.

• Center: The watermark is centered between the left and right borders.

pub fn set_horizontal_align(self, input: Option<String>) -> Self

The horizontal position of the watermark unless you specify a non-zero value for HorizontalOffset:

• Left: The left edge of the watermark is aligned with the left border of the video.

• Right: The right edge of the watermark is aligned with the right border of the video.

• Center: The watermark is centered between the left and right borders.

pub fn horizontal_offset(self, input: impl Into<String>) -> Self

The amount by which you want the horizontal position of the watermark to be offset from the position specified by HorizontalAlign:

• number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of MaxWidth.

• integer percentage (%): The range of valid values is 0 to 100.

For example, if you specify Left for HorizontalAlign and 5px for HorizontalOffset, the left side of the watermark appears 5 pixels from the left border of the output video.

HorizontalOffset is only valid when the value of HorizontalAlign is Left or Right. If you specify an offset that causes the watermark to extend beyond the left or right border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.

Use the value of Target to specify whether you want to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation.

pub fn set_horizontal_offset(self, input: Option<String>) -> Self

The amount by which you want the horizontal position of the watermark to be offset from the position specified by HorizontalAlign:

• number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of MaxWidth.

• integer percentage (%): The range of valid values is 0 to 100.

For example, if you specify Left for HorizontalAlign and 5px for HorizontalOffset, the left side of the watermark appears 5 pixels from the left border of the output video.

HorizontalOffset is only valid when the value of HorizontalAlign is Left or Right. If you specify an offset that causes the watermark to extend beyond the left or right border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.

Use the value of Target to specify whether you want to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation.

pub fn vertical_align(self, input: impl Into<String>) -> Self

The vertical position of the watermark unless you specify a non-zero value for VerticalOffset:

• Top: The top edge of the watermark is aligned with the top border of the video.

• Bottom: The bottom edge of the watermark is aligned with the bottom border of the video.

• Center: The watermark is centered between the top and bottom borders.

pub fn set_vertical_align(self, input: Option<String>) -> Self

The vertical position of the watermark unless you specify a non-zero value for VerticalOffset:

• Top: The top edge of the watermark is aligned with the top border of the video.

• Bottom: The bottom edge of the watermark is aligned with the bottom border of the video.

• Center: The watermark is centered between the top and bottom borders.

pub fn vertical_offset(self, input: impl Into<String>) -> Self

VerticalOffset

The amount by which you want the vertical position of the watermark to be offset from the position specified by VerticalAlign:

• number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of MaxHeight.

• integer percentage (%): The range of valid values is 0 to 100.

For example, if you specify Top for VerticalAlign and 5px for VerticalOffset, the top of the watermark appears 5 pixels from the top border of the output video.

VerticalOffset is only valid when the value of VerticalAlign is Top or Bottom.

If you specify an offset that causes the watermark to extend beyond the top or bottom border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.

Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation.

pub fn set_vertical_offset(self, input: Option<String>) -> Self

VerticalOffset

The amount by which you want the vertical position of the watermark to be offset from the position specified by VerticalAlign:

• number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of MaxHeight.

• integer percentage (%): The range of valid values is 0 to 100.

For example, if you specify Top for VerticalAlign and 5px for VerticalOffset, the top of the watermark appears 5 pixels from the top border of the output video.

VerticalOffset is only valid when the value of VerticalAlign is Top or Bottom.

If you specify an offset that causes the watermark to extend beyond the top or bottom border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.

Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation.

pub fn opacity(self, input: impl Into<String>) -> Self

A percentage that indicates how much you want a watermark to obscure the video in the location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the watermark completely obscures the video in the specified location). The datatype of Opacity is float.

Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent portion of the video appears as if you had specified a value of 0 for Opacity. The .jpg file format doesn't support transparency.

pub fn set_opacity(self, input: Option<String>) -> Self

A percentage that indicates how much you want a watermark to obscure the video in the location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the watermark completely obscures the video in the specified location). The datatype of Opacity is float.

Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent portion of the video appears as if you had specified a value of 0 for Opacity. The .jpg file format doesn't support transparency.

pub fn target(self, input: impl Into<String>) -> Self

A value that determines how Elastic Transcoder interprets values that you specified for HorizontalOffset, VerticalOffset, MaxWidth, and MaxHeight:

• Content: HorizontalOffset and VerticalOffset values are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any. In addition, MaxWidth and MaxHeight, if specified as a percentage, are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any.

• Frame: HorizontalOffset and VerticalOffset values are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any. In addition, MaxWidth and MaxHeight, if specified as a percentage, are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any.

pub fn set_target(self, input: Option<String>) -> Self

A value that determines how Elastic Transcoder interprets values that you specified for HorizontalOffset, VerticalOffset, MaxWidth, and MaxHeight:

• Content: HorizontalOffset and VerticalOffset values are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any. In addition, MaxWidth and MaxHeight, if specified as a percentage, are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any.

• Frame: HorizontalOffset and VerticalOffset values are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any. In addition, MaxWidth and MaxHeight, if specified as a percentage, are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any.

pub fn build(self) -> PresetWatermark

Consumes the builder and constructs a PresetWatermark

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Builder) -> bool

This method tests for !=.

impl StructuralPartialEq for Builder