
com.amazonaws.services.elastictranscoder.model.PresetWatermark Maven / Gradle / Ivy
Show all versions of aws-java-sdk-elastictranscoder Show documentation
/* * Copyright 2010-2016 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; /** *
** 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. *
*/ public class PresetWatermark implements Serializable, Cloneable { /** * A unique identifier for the settings for one watermark. The value of *Id
can be up to 40 characters long. */ private String id; /** ** The maximum width of the watermark in one of the following formats: *
*
* */ private String 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
If you specify the value in * pixels, it must be less than or equal to 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.MaxWidth
. ** The maximum height of the watermark in one of the following formats: *
*
* If you specify the value in pixels, it must be less than or equal to the * value of- 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.MaxHeight
. * */ private String maxHeight; /** ** A value that controls scaling of the watermark: *
*
* */ private String sizingPolicy; /** *- 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 ofMaxWidth
andMaxHeight
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
andMaxHeight
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
: **
* */ private String horizontalAlign; /** *- 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: *
*
* For example, if you specify Left for- 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.
*HorizontalAlign
and 5px * forHorizontalOffset
, 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
isLeft
orRight
. * 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
*/ private String horizontalOffset; /** *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
: **
* */ private String verticalAlign; /** *- 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: *
*
* For example, if you specify- 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.
*Top
for *VerticalAlign
and5px
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
*/ private String verticalOffset; /** *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
*/ private String opacity; /** *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
, andMaxHeight
: **
* */ private String target; /** * A unique identifier for the settings for one watermark. The value of *- 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
andMaxHeight
, if specified * as a percentage, are calculated based on the borders of the video * excluding black bars added by Elastic Transcoder, if any.- Frame:
* In addition,HorizontalOffset
and *VerticalOffset
values are calculated based on the borders of * the video including black bars added by Elastic Transcoder, if any.MaxWidth
andMaxHeight
, if * specified as a percentage, are calculated based on the borders of the * video including black bars added by Elastic Transcoder, if any. *Id
can be up to 40 characters long. * * @param id * A unique identifier for the settings for one watermark. The value * ofId
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. * * @return A unique identifier for the settings for one watermark. The value * ofId
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. * * @param id * A unique identifier for the settings for one watermark. The value * ofId
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: *
*
* * * @param 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
If you specify the value in * pixels, it must be less than or equal to 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.MaxWidth
. **
*/ public void setMaxWidth(String maxWidth) { this.maxWidth = 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
If you * specify the value in pixels, it must be less than or equal to the * value ofTarget
to specify whether you want * Elastic Transcoder to include the black bars that are added by * Elastic Transcoder, if any, in the calculation.MaxWidth
. ** The maximum width of the watermark in one of the following formats: *
*
* * * @return 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
If you specify the value in * pixels, it must be less than or equal to 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.MaxWidth
. **
*/ public String getMaxWidth() { return this.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
If you * specify the value in pixels, it must be less than or equal to the * value ofTarget
to specify whether you * want Elastic Transcoder to include the black bars that are added * by Elastic Transcoder, if any, in the calculation.MaxWidth
. ** The maximum width of the watermark in one of the following formats: *
*
* * * @param 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
If you specify the value in * pixels, it must be less than or equal to 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.MaxWidth
. **
* @return Returns a reference to this object so that method calls can be * chained together. */ public PresetWatermark withMaxWidth(String maxWidth) { setMaxWidth(maxWidth); return this; } /** *- 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
If you * specify the value in pixels, it must be less than or equal to the * value ofTarget
to specify whether you want * Elastic Transcoder to include the black bars that are added by * Elastic Transcoder, if any, in the calculation.MaxWidth
. ** The maximum height of the watermark in one of the following formats: *
*
* If you specify the value in pixels, it must be less than or equal to the * value of- 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.MaxHeight
. * * * @param maxHeight * The maximum height of the watermark in one of the following * formats: **
* If you specify the value in pixels, it must be less than or equal * to the value of- 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.MaxHeight
. */ public void setMaxHeight(String maxHeight) { this.maxHeight = maxHeight; } /** ** The maximum height of the watermark in one of the following formats: *
*
* If you specify the value in pixels, it must be less than or equal to the * value of- 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.MaxHeight
. * * * @return The maximum height of the watermark in one of the following * formats: **
* If you specify the value in pixels, it must be less than or equal * to the value of- 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.MaxHeight
. */ public String getMaxHeight() { return this.maxHeight; } /** ** The maximum height of the watermark in one of the following formats: *
*
* If you specify the value in pixels, it must be less than or equal to the * value of- 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.MaxHeight
. * * * @param maxHeight * The maximum height of the watermark in one of the following * formats: **
* If you specify the value in pixels, it must be less than or equal * to the value of- 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.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: *
*
* * * @param sizingPolicy * 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 ofMaxWidth
andMaxHeight
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
andMaxHeight
without exceeding * either value. If you specify this option, Elastic Transcoder does not * scale the watermark up.*
*/ public void setSizingPolicy(String sizingPolicy) { this.sizingPolicy = sizingPolicy; } /** *- Fit: Elastic Transcoder scales the watermark so it * matches the value that you specified in either *
*MaxWidth
orMaxHeight
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 ofMaxWidth
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: *
*
* * * @return 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 ofMaxWidth
andMaxHeight
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
andMaxHeight
without exceeding * either value. If you specify this option, Elastic Transcoder does not * scale the watermark up.*
*/ public String getSizingPolicy() { return this.sizingPolicy; } /** *- Fit: Elastic Transcoder scales the watermark so it * matches the value that you specified in either *
*MaxWidth
orMaxHeight
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 ofMaxWidth
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: *
*
* * * @param sizingPolicy * 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 ofMaxWidth
andMaxHeight
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
andMaxHeight
without exceeding * either value. If you specify this option, Elastic Transcoder does not * scale the watermark up.*
* @return Returns a reference to this object so that method calls can be * chained together. */ public PresetWatermark withSizingPolicy(String sizingPolicy) { setSizingPolicy(sizingPolicy); return this; } /** *- Fit: Elastic Transcoder scales the watermark so it * matches the value that you specified in either *
*MaxWidth
orMaxHeight
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 ofMaxWidth
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
: **
* * * @param horizontalAlign * The horizontal position of the watermark unless you specify a * non-zero value for- 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
: **
*/ public void setHorizontalAlign(String horizontalAlign) { this.horizontalAlign = horizontalAlign; } /** *- 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
: **
* * * @return The horizontal position of the watermark unless you specify a * non-zero value for- 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
: **
*/ public String getHorizontalAlign() { return this.horizontalAlign; } /** *- 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
: **
* * * @param horizontalAlign * The horizontal position of the watermark unless you specify a * non-zero value for- 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
: **
* @return Returns a reference to this object so that method calls can be * chained together. */ public PresetWatermark withHorizontalAlign(String horizontalAlign) { setHorizontalAlign(horizontalAlign); return this; } /** *- 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: *
*
* For example, if you specify Left for- 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.
*HorizontalAlign
and 5px * forHorizontalOffset
, 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
isLeft
orRight
. * 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
* * @param horizontalOffset * The amount by which you want the horizontal position of the * watermark to be offset from the position specified by * HorizontalAlign: *Target
to specify whether you want to * include the black bars that are added by Elastic Transcoder, if any, in * the offset calculation. **
* For example, if you specify Left for- 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. *
*HorizontalAlign
* and 5px forHorizontalOffset
, 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
isLeft
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: *
*
* For example, if you specify Left for- 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.
*HorizontalAlign
and 5px * forHorizontalOffset
, 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
isLeft
orRight
. * 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
* * @return The amount by which you want the horizontal position of the * watermark to be offset from the position specified by * HorizontalAlign: *Target
to specify whether you want to * include the black bars that are added by Elastic Transcoder, if any, in * the offset calculation. **
* For example, if you specify Left for- 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.
*HorizontalAlign
* and 5px forHorizontalOffset
, 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
isLeft
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: *
*
* For example, if you specify Left for- 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.
*HorizontalAlign
and 5px * forHorizontalOffset
, 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
isLeft
orRight
. * 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
* * @param horizontalOffset * The amount by which you want the horizontal position of the * watermark to be offset from the position specified by * HorizontalAlign: *Target
to specify whether you want to * include the black bars that are added by Elastic Transcoder, if any, in * the offset calculation. **
* For example, if you specify Left for- 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. *
*HorizontalAlign
* and 5px forHorizontalOffset
, 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
isLeft
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
: **
* * * @param verticalAlign * The vertical position of the watermark unless you specify a * non-zero value for- 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
: **
*/ public void setVerticalAlign(String verticalAlign) { this.verticalAlign = verticalAlign; } /** *- 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
: **
* * * @return The vertical position of the watermark unless you specify a * non-zero value for- 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
: **
*/ public String getVerticalAlign() { return this.verticalAlign; } /** *- 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
: **
* * * @param verticalAlign * The vertical position of the watermark unless you specify a * non-zero value for- 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
: **
* @return Returns a reference to this object so that method calls can be * chained together. */ public PresetWatermark withVerticalAlign(String verticalAlign) { setVerticalAlign(verticalAlign); return this; } /** *- 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: *
*
* For example, if you specify- 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.
*Top
for *VerticalAlign
and5px
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
* * @param verticalOffset * VerticalOffsetTarget
to specify whether you want Elastic * Transcoder to include the black bars that are added by Elastic * Transcoder, if any, in the offset calculation. ** 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. * *
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. *
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.
*
* 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. *
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. *
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.
*
* 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. * *
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
andMaxHeight
, 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
andMaxHeight
, 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
andMaxHeight
, 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.
*