com.amazonaws.services.elastictranscoder.model

Class JobWatermark

java.lang.Object

com.amazonaws.services.elastictranscoder.model.JobWatermark

All Implemented Interfaces:

Serializable

public class JobWatermark
extends Object
implements Serializable

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobWatermark()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getInputKey() The name of the .png or .jpg file that you want to use for the watermark.
String	getPresetWatermarkId() The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding.
int	hashCode()
void	setInputKey(String inputKey) The name of the .png or .jpg file that you want to use for the watermark.
void	setPresetWatermarkId(String presetWatermarkId) The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding.
String	toString() Returns a string representation of this object; useful for testing and debugging.
JobWatermark	withInputKey(String inputKey) The name of the .png or .jpg file that you want to use for the watermark.
JobWatermark	withPresetWatermarkId(String presetWatermarkId) The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JobWatermark

public JobWatermark()

Method Detail

getPresetWatermarkId

public String getPresetWatermarkId()

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. The settings are in the preset specified by Preset for the current output. In that preset, the value of Watermarks Id tells Elastic Transcoder which settings to use.

Constraints:
Length: 1 - 40

Returns:

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. The settings are in the preset specified by Preset for the current output. In that preset, the value of Watermarks Id tells Elastic Transcoder which settings to use.

setPresetWatermarkId

public void setPresetWatermarkId(String presetWatermarkId)

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. The settings are in the preset specified by Preset for the current output. In that preset, the value of Watermarks Id tells Elastic Transcoder which settings to use.

Constraints:
Length: 1 - 40

Parameters:

presetWatermarkId - The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. The settings are in the preset specified by Preset for the current output. In that preset, the value of Watermarks Id tells Elastic Transcoder which settings to use.

withPresetWatermarkId

public JobWatermark withPresetWatermarkId(String presetWatermarkId)

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. The settings are in the preset specified by Preset for the current output. In that preset, the value of Watermarks Id tells Elastic Transcoder which settings to use.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 40

Parameters:

presetWatermarkId - The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. The settings are in the preset specified by Preset for the current output. In that preset, the value of Watermarks Id tells Elastic Transcoder which settings to use.

Returns:

A reference to this updated object so that method calls can be chained together.

getInputKey

public String getInputKey()

The name of the .png or .jpg file that you want to use for the watermark. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by Pipeline; the Input Bucket object in that pipeline identifies the bucket.

If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

Constraints:
Length: 1 - 255
Pattern: (^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)

Returns:

The name of the .png or .jpg file that you want to use for the watermark. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by Pipeline; the Input Bucket object in that pipeline identifies the bucket.

If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

setInputKey

public void setInputKey(String inputKey)

The name of the .png or .jpg file that you want to use for the watermark. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by Pipeline; the Input Bucket object in that pipeline identifies the bucket.

If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

Constraints:
Length: 1 - 255
Pattern: (^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)

Parameters:

inputKey - The name of the .png or .jpg file that you want to use for the watermark. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by Pipeline; the Input Bucket object in that pipeline identifies the bucket.

If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

withInputKey

public JobWatermark withInputKey(String inputKey)

The name of the .png or .jpg file that you want to use for the watermark. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by Pipeline; the Input Bucket object in that pipeline identifies the bucket.

If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255
Pattern: (^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)

Parameters:

inputKey - The name of the .png or .jpg file that you want to use for the watermark. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by Pipeline; the Input Bucket object in that pipeline identifies the bucket.

If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object