AWS SDK for C++  1.9.69
AWS SDK for C++
Public Member Functions | List of all members
Aws::ElasticTranscoder::Model::PresetWatermark Class Reference

#include <PresetWatermark.h>

Public Member Functions

 PresetWatermark ()
 
 PresetWatermark (Aws::Utils::Json::JsonView jsonValue)
 
PresetWatermarkoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
PresetWatermarkWithId (const Aws::String &value)
 
PresetWatermarkWithId (Aws::String &&value)
 
PresetWatermarkWithId (const char *value)
 
const Aws::StringGetMaxWidth () const
 
bool MaxWidthHasBeenSet () const
 
void SetMaxWidth (const Aws::String &value)
 
void SetMaxWidth (Aws::String &&value)
 
void SetMaxWidth (const char *value)
 
PresetWatermarkWithMaxWidth (const Aws::String &value)
 
PresetWatermarkWithMaxWidth (Aws::String &&value)
 
PresetWatermarkWithMaxWidth (const char *value)
 
const Aws::StringGetMaxHeight () const
 
bool MaxHeightHasBeenSet () const
 
void SetMaxHeight (const Aws::String &value)
 
void SetMaxHeight (Aws::String &&value)
 
void SetMaxHeight (const char *value)
 
PresetWatermarkWithMaxHeight (const Aws::String &value)
 
PresetWatermarkWithMaxHeight (Aws::String &&value)
 
PresetWatermarkWithMaxHeight (const char *value)
 
const Aws::StringGetSizingPolicy () const
 
bool SizingPolicyHasBeenSet () const
 
void SetSizingPolicy (const Aws::String &value)
 
void SetSizingPolicy (Aws::String &&value)
 
void SetSizingPolicy (const char *value)
 
PresetWatermarkWithSizingPolicy (const Aws::String &value)
 
PresetWatermarkWithSizingPolicy (Aws::String &&value)
 
PresetWatermarkWithSizingPolicy (const char *value)
 
const Aws::StringGetHorizontalAlign () const
 
bool HorizontalAlignHasBeenSet () const
 
void SetHorizontalAlign (const Aws::String &value)
 
void SetHorizontalAlign (Aws::String &&value)
 
void SetHorizontalAlign (const char *value)
 
PresetWatermarkWithHorizontalAlign (const Aws::String &value)
 
PresetWatermarkWithHorizontalAlign (Aws::String &&value)
 
PresetWatermarkWithHorizontalAlign (const char *value)
 
const Aws::StringGetHorizontalOffset () const
 
bool HorizontalOffsetHasBeenSet () const
 
void SetHorizontalOffset (const Aws::String &value)
 
void SetHorizontalOffset (Aws::String &&value)
 
void SetHorizontalOffset (const char *value)
 
PresetWatermarkWithHorizontalOffset (const Aws::String &value)
 
PresetWatermarkWithHorizontalOffset (Aws::String &&value)
 
PresetWatermarkWithHorizontalOffset (const char *value)
 
const Aws::StringGetVerticalAlign () const
 
bool VerticalAlignHasBeenSet () const
 
void SetVerticalAlign (const Aws::String &value)
 
void SetVerticalAlign (Aws::String &&value)
 
void SetVerticalAlign (const char *value)
 
PresetWatermarkWithVerticalAlign (const Aws::String &value)
 
PresetWatermarkWithVerticalAlign (Aws::String &&value)
 
PresetWatermarkWithVerticalAlign (const char *value)
 
const Aws::StringGetVerticalOffset () const
 
bool VerticalOffsetHasBeenSet () const
 
void SetVerticalOffset (const Aws::String &value)
 
void SetVerticalOffset (Aws::String &&value)
 
void SetVerticalOffset (const char *value)
 
PresetWatermarkWithVerticalOffset (const Aws::String &value)
 
PresetWatermarkWithVerticalOffset (Aws::String &&value)
 
PresetWatermarkWithVerticalOffset (const char *value)
 
const Aws::StringGetOpacity () const
 
bool OpacityHasBeenSet () const
 
void SetOpacity (const Aws::String &value)
 
void SetOpacity (Aws::String &&value)
 
void SetOpacity (const char *value)
 
PresetWatermarkWithOpacity (const Aws::String &value)
 
PresetWatermarkWithOpacity (Aws::String &&value)
 
PresetWatermarkWithOpacity (const char *value)
 
const Aws::StringGetTarget () const
 
bool TargetHasBeenSet () const
 
void SetTarget (const Aws::String &value)
 
void SetTarget (Aws::String &&value)
 
void SetTarget (const char *value)
 
PresetWatermarkWithTarget (const Aws::String &value)
 
PresetWatermarkWithTarget (Aws::String &&value)
 
PresetWatermarkWithTarget (const char *value)
 

Detailed Description

Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in the specified size and location, and with the specified opacity for the duration of the transcoded video.

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.

When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.

See Also:

AWS API Reference

Definition at line 42 of file PresetWatermark.h.

Constructor & Destructor Documentation

◆ PresetWatermark() [1/2]

Aws::ElasticTranscoder::Model::PresetWatermark::PresetWatermark ( )

◆ PresetWatermark() [2/2]

Aws::ElasticTranscoder::Model::PresetWatermark::PresetWatermark ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetHorizontalAlign()

const Aws::String& Aws::ElasticTranscoder::Model::PresetWatermark::GetHorizontalAlign ( ) const
inline

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.

Definition at line 439 of file PresetWatermark.h.

◆ GetHorizontalOffset()

const Aws::String& Aws::ElasticTranscoder::Model::PresetWatermark::GetHorizontalOffset ( ) const
inline

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.

Definition at line 530 of file PresetWatermark.h.

◆ GetId()

const Aws::String& Aws::ElasticTranscoder::Model::PresetWatermark::GetId ( ) const
inline

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

Definition at line 55 of file PresetWatermark.h.

◆ GetMaxHeight()

const Aws::String& Aws::ElasticTranscoder::Model::PresetWatermark::GetMaxHeight ( ) const
inline

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.

Definition at line 207 of file PresetWatermark.h.

◆ GetMaxWidth()

const Aws::String& Aws::ElasticTranscoder::Model::PresetWatermark::GetMaxWidth ( ) const
inline

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.

Definition at line 110 of file PresetWatermark.h.

◆ GetOpacity()

const Aws::String& Aws::ElasticTranscoder::Model::PresetWatermark::GetOpacity ( ) const
inline

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.

Definition at line 933 of file PresetWatermark.h.

◆ GetSizingPolicy()

const Aws::String& Aws::ElasticTranscoder::Model::PresetWatermark::GetSizingPolicy ( ) const
inline

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.

Definition at line 309 of file PresetWatermark.h.

◆ GetTarget()

const Aws::String& Aws::ElasticTranscoder::Model::PresetWatermark::GetTarget ( ) const
inline

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.

Definition at line 1036 of file PresetWatermark.h.

◆ GetVerticalAlign()

const Aws::String& Aws::ElasticTranscoder::Model::PresetWatermark::GetVerticalAlign ( ) const
inline

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.

Definition at line 681 of file PresetWatermark.h.

◆ GetVerticalOffset()

const Aws::String& Aws::ElasticTranscoder::Model::PresetWatermark::GetVerticalOffset ( ) const
inline

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.

Definition at line 773 of file PresetWatermark.h.

◆ HorizontalAlignHasBeenSet()

bool Aws::ElasticTranscoder::Model::PresetWatermark::HorizontalAlignHasBeenSet ( ) const
inline

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.

Definition at line 449 of file PresetWatermark.h.

◆ HorizontalOffsetHasBeenSet()

bool Aws::ElasticTranscoder::Model::PresetWatermark::HorizontalOffsetHasBeenSet ( ) const
inline

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.

Definition at line 550 of file PresetWatermark.h.

◆ IdHasBeenSet()

bool Aws::ElasticTranscoder::Model::PresetWatermark::IdHasBeenSet ( ) const
inline

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

Definition at line 61 of file PresetWatermark.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ElasticTranscoder::Model::PresetWatermark::Jsonize ( ) const

◆ MaxHeightHasBeenSet()

bool Aws::ElasticTranscoder::Model::PresetWatermark::MaxHeightHasBeenSet ( ) const
inline

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.

Definition at line 219 of file PresetWatermark.h.

◆ MaxWidthHasBeenSet()

bool Aws::ElasticTranscoder::Model::PresetWatermark::MaxWidthHasBeenSet ( ) const
inline

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.

Definition at line 122 of file PresetWatermark.h.

◆ OpacityHasBeenSet()

bool Aws::ElasticTranscoder::Model::PresetWatermark::OpacityHasBeenSet ( ) const
inline

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.

Definition at line 945 of file PresetWatermark.h.

◆ operator=()

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetHorizontalAlign() [1/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetHorizontalAlign ( Aws::String &&  value)
inline

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.

Definition at line 469 of file PresetWatermark.h.

◆ SetHorizontalAlign() [2/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetHorizontalAlign ( const Aws::String value)
inline

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.

Definition at line 459 of file PresetWatermark.h.

◆ SetHorizontalAlign() [3/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetHorizontalAlign ( const char *  value)
inline

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.

Definition at line 479 of file PresetWatermark.h.

◆ SetHorizontalOffset() [1/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetHorizontalOffset ( Aws::String &&  value)
inline

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.

Definition at line 590 of file PresetWatermark.h.

◆ SetHorizontalOffset() [2/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetHorizontalOffset ( const Aws::String value)
inline

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.

Definition at line 570 of file PresetWatermark.h.

◆ SetHorizontalOffset() [3/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetHorizontalOffset ( const char *  value)
inline

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.

Definition at line 610 of file PresetWatermark.h.

◆ SetId() [1/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetId ( Aws::String &&  value)
inline

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

Definition at line 73 of file PresetWatermark.h.

◆ SetId() [2/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetId ( const Aws::String value)
inline

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

Definition at line 67 of file PresetWatermark.h.

◆ SetId() [3/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetId ( const char *  value)
inline

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

Definition at line 79 of file PresetWatermark.h.

◆ SetMaxHeight() [1/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetMaxHeight ( Aws::String &&  value)
inline

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.

Definition at line 243 of file PresetWatermark.h.

◆ SetMaxHeight() [2/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetMaxHeight ( const Aws::String value)
inline

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.

Definition at line 231 of file PresetWatermark.h.

◆ SetMaxHeight() [3/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetMaxHeight ( const char *  value)
inline

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.

Definition at line 255 of file PresetWatermark.h.

◆ SetMaxWidth() [1/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetMaxWidth ( Aws::String &&  value)
inline

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.

Definition at line 146 of file PresetWatermark.h.

◆ SetMaxWidth() [2/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetMaxWidth ( const Aws::String value)
inline

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.

Definition at line 134 of file PresetWatermark.h.

◆ SetMaxWidth() [3/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetMaxWidth ( const char *  value)
inline

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.

Definition at line 158 of file PresetWatermark.h.

◆ SetOpacity() [1/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetOpacity ( Aws::String &&  value)
inline

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.

Definition at line 969 of file PresetWatermark.h.

◆ SetOpacity() [2/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetOpacity ( const Aws::String value)
inline

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.

Definition at line 957 of file PresetWatermark.h.

◆ SetOpacity() [3/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetOpacity ( const char *  value)
inline

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.

Definition at line 981 of file PresetWatermark.h.

◆ SetSizingPolicy() [1/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetSizingPolicy ( Aws::String &&  value)
inline

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.

Definition at line 360 of file PresetWatermark.h.

◆ SetSizingPolicy() [2/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetSizingPolicy ( const Aws::String value)
inline

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.

Definition at line 343 of file PresetWatermark.h.

◆ SetSizingPolicy() [3/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetSizingPolicy ( const char *  value)
inline

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.

Definition at line 377 of file PresetWatermark.h.

◆ SetTarget() [1/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetTarget ( Aws::String &&  value)
inline

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.

Definition at line 1090 of file PresetWatermark.h.

◆ SetTarget() [2/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetTarget ( const Aws::String value)
inline

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.

Definition at line 1072 of file PresetWatermark.h.

◆ SetTarget() [3/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetTarget ( const char *  value)
inline

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.

Definition at line 1108 of file PresetWatermark.h.

◆ SetVerticalAlign() [1/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetVerticalAlign ( Aws::String &&  value)
inline

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.

Definition at line 711 of file PresetWatermark.h.

◆ SetVerticalAlign() [2/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetVerticalAlign ( const Aws::String value)
inline

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.

Definition at line 701 of file PresetWatermark.h.

◆ SetVerticalAlign() [3/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetVerticalAlign ( const char *  value)
inline

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.

Definition at line 721 of file PresetWatermark.h.

◆ SetVerticalOffset() [1/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetVerticalOffset ( Aws::String &&  value)
inline

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.

Definition at line 836 of file PresetWatermark.h.

◆ SetVerticalOffset() [2/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetVerticalOffset ( const Aws::String value)
inline

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.

Definition at line 815 of file PresetWatermark.h.

◆ SetVerticalOffset() [3/3]

void Aws::ElasticTranscoder::Model::PresetWatermark::SetVerticalOffset ( const char *  value)
inline

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.

Definition at line 857 of file PresetWatermark.h.

◆ SizingPolicyHasBeenSet()

bool Aws::ElasticTranscoder::Model::PresetWatermark::SizingPolicyHasBeenSet ( ) const
inline

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.

Definition at line 326 of file PresetWatermark.h.

◆ TargetHasBeenSet()

bool Aws::ElasticTranscoder::Model::PresetWatermark::TargetHasBeenSet ( ) const
inline

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.

Definition at line 1054 of file PresetWatermark.h.

◆ VerticalAlignHasBeenSet()

bool Aws::ElasticTranscoder::Model::PresetWatermark::VerticalAlignHasBeenSet ( ) const
inline

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.

Definition at line 691 of file PresetWatermark.h.

◆ VerticalOffsetHasBeenSet()

bool Aws::ElasticTranscoder::Model::PresetWatermark::VerticalOffsetHasBeenSet ( ) const
inline

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.

Definition at line 794 of file PresetWatermark.h.

◆ WithHorizontalAlign() [1/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithHorizontalAlign ( Aws::String &&  value)
inline

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.

Definition at line 499 of file PresetWatermark.h.

◆ WithHorizontalAlign() [2/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithHorizontalAlign ( const Aws::String value)
inline

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.

Definition at line 489 of file PresetWatermark.h.

◆ WithHorizontalAlign() [3/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithHorizontalAlign ( const char *  value)
inline

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.

Definition at line 509 of file PresetWatermark.h.

◆ WithHorizontalOffset() [1/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithHorizontalOffset ( Aws::String &&  value)
inline

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.

Definition at line 650 of file PresetWatermark.h.

◆ WithHorizontalOffset() [2/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithHorizontalOffset ( const Aws::String value)
inline

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.

Definition at line 630 of file PresetWatermark.h.

◆ WithHorizontalOffset() [3/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithHorizontalOffset ( const char *  value)
inline

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.

Definition at line 670 of file PresetWatermark.h.

◆ WithId() [1/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithId ( Aws::String &&  value)
inline

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

Definition at line 91 of file PresetWatermark.h.

◆ WithId() [2/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithId ( const Aws::String value)
inline

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

Definition at line 85 of file PresetWatermark.h.

◆ WithId() [3/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithId ( const char *  value)
inline

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

Definition at line 97 of file PresetWatermark.h.

◆ WithMaxHeight() [1/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithMaxHeight ( Aws::String &&  value)
inline

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.

Definition at line 279 of file PresetWatermark.h.

◆ WithMaxHeight() [2/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithMaxHeight ( const Aws::String value)
inline

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.

Definition at line 267 of file PresetWatermark.h.

◆ WithMaxHeight() [3/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithMaxHeight ( const char *  value)
inline

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.

Definition at line 291 of file PresetWatermark.h.

◆ WithMaxWidth() [1/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithMaxWidth ( Aws::String &&  value)
inline

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.

Definition at line 182 of file PresetWatermark.h.

◆ WithMaxWidth() [2/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithMaxWidth ( const Aws::String value)
inline

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.

Definition at line 170 of file PresetWatermark.h.

◆ WithMaxWidth() [3/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithMaxWidth ( const char *  value)
inline

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.

Definition at line 194 of file PresetWatermark.h.

◆ WithOpacity() [1/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithOpacity ( Aws::String &&  value)
inline

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.

Definition at line 1005 of file PresetWatermark.h.

◆ WithOpacity() [2/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithOpacity ( const Aws::String value)
inline

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.

Definition at line 993 of file PresetWatermark.h.

◆ WithOpacity() [3/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithOpacity ( const char *  value)
inline

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.

Definition at line 1017 of file PresetWatermark.h.

◆ WithSizingPolicy() [1/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithSizingPolicy ( Aws::String &&  value)
inline

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.

Definition at line 411 of file PresetWatermark.h.

◆ WithSizingPolicy() [2/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithSizingPolicy ( const Aws::String value)
inline

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.

Definition at line 394 of file PresetWatermark.h.

◆ WithSizingPolicy() [3/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithSizingPolicy ( const char *  value)
inline

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.

Definition at line 428 of file PresetWatermark.h.

◆ WithTarget() [1/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithTarget ( Aws::String &&  value)
inline

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.

Definition at line 1144 of file PresetWatermark.h.

◆ WithTarget() [2/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithTarget ( const Aws::String value)
inline

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.

Definition at line 1126 of file PresetWatermark.h.

◆ WithTarget() [3/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithTarget ( const char *  value)
inline

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.

Definition at line 1162 of file PresetWatermark.h.

◆ WithVerticalAlign() [1/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithVerticalAlign ( Aws::String &&  value)
inline

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.

Definition at line 741 of file PresetWatermark.h.

◆ WithVerticalAlign() [2/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithVerticalAlign ( const Aws::String value)
inline

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.

Definition at line 731 of file PresetWatermark.h.

◆ WithVerticalAlign() [3/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithVerticalAlign ( const char *  value)
inline

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.

Definition at line 751 of file PresetWatermark.h.

◆ WithVerticalOffset() [1/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithVerticalOffset ( Aws::String &&  value)
inline

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.

Definition at line 899 of file PresetWatermark.h.

◆ WithVerticalOffset() [2/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithVerticalOffset ( const Aws::String value)
inline

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.

Definition at line 878 of file PresetWatermark.h.

◆ WithVerticalOffset() [3/3]

PresetWatermark& Aws::ElasticTranscoder::Model::PresetWatermark::WithVerticalOffset ( const char *  value)
inline

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.

Definition at line 920 of file PresetWatermark.h.


The documentation for this class was generated from the following file: