/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.elastictranscoder.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* 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. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class PresetWatermark implements Serializable, Cloneable, StructuredPojo { /** *
* A unique identifier for the settings for one watermark. The value of Id
can be up to 40 characters
* long.
*
* 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
.
*
* 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
.
*
* 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.
*
* 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. *
** 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.
*
* 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. *
*
* 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.
*
* 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.
*
* 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.
*
* A unique identifier for the settings for one watermark. The value of Id
can be up to 40 characters
* long.
*
Id
can be up to 40
* characters long.
*/
public void setId(String id) {
this.id = id;
}
/**
*
* A unique identifier for the settings for one watermark. The value of Id
can be up to 40 characters
* long.
*
Id
can be up to 40
* characters long.
*/
public String getId() {
return this.id;
}
/**
*
* A unique identifier for the settings for one watermark. The value of Id
can be up to 40 characters
* long.
*
Id
can be up to 40
* characters long.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PresetWatermark withId(String id) {
setId(id);
return this;
}
/**
* * 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*/
public void setMaxHeight(String maxHeight) {
this.maxHeight = maxHeight;
}
/**
*
* 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
.
*
* 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
.
*/
public String getMaxHeight() {
return this.maxHeight;
}
/**
*
* 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
.
*
* 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
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PresetWatermark withMaxHeight(String maxHeight) {
setMaxHeight(maxHeight);
return this;
}
/**
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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. *
*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. *
*
* 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. *
*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. *
*
* 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. *
*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. *
** 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.
*
* 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.
*/
public void setHorizontalOffset(String horizontalOffset) {
this.horizontalOffset = horizontalOffset;
}
/**
*
* 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.
*
* 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.
*/
public String getHorizontalOffset() {
return this.horizontalOffset;
}
/**
*
* 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.
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PresetWatermark withHorizontalOffset(String horizontalOffset) {
setHorizontalOffset(horizontalOffset);
return this;
}
/**
*
* 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. *
*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. *
*
* 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. *
*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. *
*
* 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. *
*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. *
*
* 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.
*
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.
*/
public void setVerticalOffset(String verticalOffset) {
this.verticalOffset = verticalOffset;
}
/**
*
* 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.
*
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.
*/
public String getVerticalOffset() {
return this.verticalOffset;
}
/**
*
* 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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PresetWatermark withVerticalOffset(String verticalOffset) {
setVerticalOffset(verticalOffset);
return this;
}
/**
*
* 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.
*
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.
*/
public void setOpacity(String opacity) {
this.opacity = opacity;
}
/**
*
* 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.
*
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.
*/
public String getOpacity() {
return this.opacity;
}
/**
*
* 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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PresetWatermark withOpacity(String opacity) {
setOpacity(opacity);
return this;
}
/**
*
* 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.
*
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.
*
* 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.
*
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.
*
* 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.
*
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.
*