com.amazonaws.services.mediaconvert.model

Class InsertableImage

java.lang.Object

com.amazonaws.services.mediaconvert.model.InsertableImage

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class InsertableImage
extends Object
implements Serializable, Cloneable, StructuredPojo

Settings for Insertable Image

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
InsertableImage()

Method Summary

Modifier and Type	Method and Description
InsertableImage	clone()
boolean	equals(Object obj)
Integer	getDuration() Use Duration (Duration) to set the time, in milliseconds, for the image to remain on the output video.
Integer	getFadeIn() Use Fade in (FadeIut) to set the length, in milliseconds, of the inserted image fade in.
Integer	getFadeOut() Use Fade out (FadeOut) to set the length, in milliseconds, of the inserted image fade out.
Integer	getHeight() Specify the Height (Height) of the inserted image.
String	getImageInserterInput() Use Image location (imageInserterInput) to specify the Amazon S3 location of the image to be inserted into the output.
Integer	getImageX() Use Left (ImageX) to set the distance, in pixels, between the inserted image and the left edge of the frame.
Integer	getImageY() Use Top (ImageY) to set the distance, in pixels, between the inserted image and the top edge of the video frame.
Integer	getLayer() Use Layer (Layer) to specify how overlapping inserted images appear.
Integer	getOpacity() Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image.
String	getStartTime() Use Start time (StartTime) to specify the video timecode when the image is inserted in the output.
Integer	getWidth() Specify the Width (Width) of the inserted image.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDuration(Integer duration) Use Duration (Duration) to set the time, in milliseconds, for the image to remain on the output video.
void	setFadeIn(Integer fadeIn) Use Fade in (FadeIut) to set the length, in milliseconds, of the inserted image fade in.
void	setFadeOut(Integer fadeOut) Use Fade out (FadeOut) to set the length, in milliseconds, of the inserted image fade out.
void	setHeight(Integer height) Specify the Height (Height) of the inserted image.
void	setImageInserterInput(String imageInserterInput) Use Image location (imageInserterInput) to specify the Amazon S3 location of the image to be inserted into the output.
void	setImageX(Integer imageX) Use Left (ImageX) to set the distance, in pixels, between the inserted image and the left edge of the frame.
void	setImageY(Integer imageY) Use Top (ImageY) to set the distance, in pixels, between the inserted image and the top edge of the video frame.
void	setLayer(Integer layer) Use Layer (Layer) to specify how overlapping inserted images appear.
void	setOpacity(Integer opacity) Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image.
void	setStartTime(String startTime) Use Start time (StartTime) to specify the video timecode when the image is inserted in the output.
void	setWidth(Integer width) Specify the Width (Width) of the inserted image.
String	toString() Returns a string representation of this object; useful for testing and debugging.
InsertableImage	withDuration(Integer duration) Use Duration (Duration) to set the time, in milliseconds, for the image to remain on the output video.
InsertableImage	withFadeIn(Integer fadeIn) Use Fade in (FadeIut) to set the length, in milliseconds, of the inserted image fade in.
InsertableImage	withFadeOut(Integer fadeOut) Use Fade out (FadeOut) to set the length, in milliseconds, of the inserted image fade out.
InsertableImage	withHeight(Integer height) Specify the Height (Height) of the inserted image.
InsertableImage	withImageInserterInput(String imageInserterInput) Use Image location (imageInserterInput) to specify the Amazon S3 location of the image to be inserted into the output.
InsertableImage	withImageX(Integer imageX) Use Left (ImageX) to set the distance, in pixels, between the inserted image and the left edge of the frame.
InsertableImage	withImageY(Integer imageY) Use Top (ImageY) to set the distance, in pixels, between the inserted image and the top edge of the video frame.
InsertableImage	withLayer(Integer layer) Use Layer (Layer) to specify how overlapping inserted images appear.
InsertableImage	withOpacity(Integer opacity) Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image.
InsertableImage	withStartTime(String startTime) Use Start time (StartTime) to specify the video timecode when the image is inserted in the output.
InsertableImage	withWidth(Integer width) Specify the Width (Width) of the inserted image.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InsertableImage

public InsertableImage()

Method Detail

setDuration

public void setDuration(Integer duration)

Use Duration (Duration) to set the time, in milliseconds, for the image to remain on the output video.

Parameters:

duration - Use Duration (Duration) to set the time, in milliseconds, for the image to remain on the output video.

getDuration

public Integer getDuration()

Use Duration (Duration) to set the time, in milliseconds, for the image to remain on the output video.

Returns:

Use Duration (Duration) to set the time, in milliseconds, for the image to remain on the output video.

withDuration

public InsertableImage withDuration(Integer duration)

Use Duration (Duration) to set the time, in milliseconds, for the image to remain on the output video.

Parameters:

duration - Use Duration (Duration) to set the time, in milliseconds, for the image to remain on the output video.

Returns:

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

setFadeIn

public void setFadeIn(Integer fadeIn)

Use Fade in (FadeIut) to set the length, in milliseconds, of the inserted image fade in. If you don't specify a value for Fade in, the image will appear abruptly at the Start time.

Parameters:

fadeIn - Use Fade in (FadeIut) to set the length, in milliseconds, of the inserted image fade in. If you don't specify a value for Fade in, the image will appear abruptly at the Start time.

getFadeIn

public Integer getFadeIn()

Use Fade in (FadeIut) to set the length, in milliseconds, of the inserted image fade in. If you don't specify a value for Fade in, the image will appear abruptly at the Start time.

Returns:

Use Fade in (FadeIut) to set the length, in milliseconds, of the inserted image fade in. If you don't specify a value for Fade in, the image will appear abruptly at the Start time.

withFadeIn

public InsertableImage withFadeIn(Integer fadeIn)

Use Fade in (FadeIut) to set the length, in milliseconds, of the inserted image fade in. If you don't specify a value for Fade in, the image will appear abruptly at the Start time.

Parameters:

fadeIn - Use Fade in (FadeIut) to set the length, in milliseconds, of the inserted image fade in. If you don't specify a value for Fade in, the image will appear abruptly at the Start time.

Returns:

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

setFadeOut

public void setFadeOut(Integer fadeOut)

Use Fade out (FadeOut) to set the length, in milliseconds, of the inserted image fade out. If you don't specify a value for Fade out, the image will disappear abruptly at the end of the inserted image duration.

Parameters:

fadeOut - Use Fade out (FadeOut) to set the length, in milliseconds, of the inserted image fade out. If you don't specify a value for Fade out, the image will disappear abruptly at the end of the inserted image duration.

getFadeOut

public Integer getFadeOut()

Use Fade out (FadeOut) to set the length, in milliseconds, of the inserted image fade out. If you don't specify a value for Fade out, the image will disappear abruptly at the end of the inserted image duration.

Returns:

Use Fade out (FadeOut) to set the length, in milliseconds, of the inserted image fade out. If you don't specify a value for Fade out, the image will disappear abruptly at the end of the inserted image duration.

withFadeOut

public InsertableImage withFadeOut(Integer fadeOut)

Use Fade out (FadeOut) to set the length, in milliseconds, of the inserted image fade out. If you don't specify a value for Fade out, the image will disappear abruptly at the end of the inserted image duration.

Parameters:

fadeOut - Use Fade out (FadeOut) to set the length, in milliseconds, of the inserted image fade out. If you don't specify a value for Fade out, the image will disappear abruptly at the end of the inserted image duration.

Returns:

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

setHeight

public void setHeight(Integer height)

Specify the Height (Height) of the inserted image. Use a value that is less than or equal to the video resolution height. Leave this setting blank to use the native height of the image.

Parameters:

height - Specify the Height (Height) of the inserted image. Use a value that is less than or equal to the video resolution height. Leave this setting blank to use the native height of the image.

getHeight

public Integer getHeight()

Specify the Height (Height) of the inserted image. Use a value that is less than or equal to the video resolution height. Leave this setting blank to use the native height of the image.

Returns:

Specify the Height (Height) of the inserted image. Use a value that is less than or equal to the video resolution height. Leave this setting blank to use the native height of the image.

withHeight

public InsertableImage withHeight(Integer height)

Specify the Height (Height) of the inserted image. Use a value that is less than or equal to the video resolution height. Leave this setting blank to use the native height of the image.

Parameters:

height - Specify the Height (Height) of the inserted image. Use a value that is less than or equal to the video resolution height. Leave this setting blank to use the native height of the image.

Returns:

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

setImageInserterInput

public void setImageInserterInput(String imageInserterInput)

Use Image location (imageInserterInput) to specify the Amazon S3 location of the image to be inserted into the output. Use a 32 bit BMP, PNG, or TGA file that fits inside the video frame.

Parameters:

imageInserterInput - Use Image location (imageInserterInput) to specify the Amazon S3 location of the image to be inserted into the output. Use a 32 bit BMP, PNG, or TGA file that fits inside the video frame.

getImageInserterInput

public String getImageInserterInput()

Use Image location (imageInserterInput) to specify the Amazon S3 location of the image to be inserted into the output. Use a 32 bit BMP, PNG, or TGA file that fits inside the video frame.

Returns:

Use Image location (imageInserterInput) to specify the Amazon S3 location of the image to be inserted into the output. Use a 32 bit BMP, PNG, or TGA file that fits inside the video frame.

withImageInserterInput

public InsertableImage withImageInserterInput(String imageInserterInput)

Use Image location (imageInserterInput) to specify the Amazon S3 location of the image to be inserted into the output. Use a 32 bit BMP, PNG, or TGA file that fits inside the video frame.

Parameters:

imageInserterInput - Use Image location (imageInserterInput) to specify the Amazon S3 location of the image to be inserted into the output. Use a 32 bit BMP, PNG, or TGA file that fits inside the video frame.

Returns:

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

setImageX

public void setImageX(Integer imageX)

Use Left (ImageX) to set the distance, in pixels, between the inserted image and the left edge of the frame. Required for BMP, PNG and TGA input.

Parameters:

imageX - Use Left (ImageX) to set the distance, in pixels, between the inserted image and the left edge of the frame. Required for BMP, PNG and TGA input.

getImageX

public Integer getImageX()

Use Left (ImageX) to set the distance, in pixels, between the inserted image and the left edge of the frame. Required for BMP, PNG and TGA input.

Returns:

Use Left (ImageX) to set the distance, in pixels, between the inserted image and the left edge of the frame. Required for BMP, PNG and TGA input.

withImageX

public InsertableImage withImageX(Integer imageX)

Use Left (ImageX) to set the distance, in pixels, between the inserted image and the left edge of the frame. Required for BMP, PNG and TGA input.

Parameters:

imageX - Use Left (ImageX) to set the distance, in pixels, between the inserted image and the left edge of the frame. Required for BMP, PNG and TGA input.

Returns:

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

setImageY

public void setImageY(Integer imageY)

Use Top (ImageY) to set the distance, in pixels, between the inserted image and the top edge of the video frame. Required for BMP, PNG and TGA input.

Parameters:

imageY - Use Top (ImageY) to set the distance, in pixels, between the inserted image and the top edge of the video frame. Required for BMP, PNG and TGA input.

getImageY

public Integer getImageY()

Use Top (ImageY) to set the distance, in pixels, between the inserted image and the top edge of the video frame. Required for BMP, PNG and TGA input.

Returns:

Use Top (ImageY) to set the distance, in pixels, between the inserted image and the top edge of the video frame. Required for BMP, PNG and TGA input.

withImageY

public InsertableImage withImageY(Integer imageY)

Use Top (ImageY) to set the distance, in pixels, between the inserted image and the top edge of the video frame. Required for BMP, PNG and TGA input.

Parameters:

imageY - Use Top (ImageY) to set the distance, in pixels, between the inserted image and the top edge of the video frame. Required for BMP, PNG and TGA input.

Returns:

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

setLayer

public void setLayer(Integer layer)

Use Layer (Layer) to specify how overlapping inserted images appear. Images with higher values of layer appear on top of images with lower values of layer.

Parameters:

layer - Use Layer (Layer) to specify how overlapping inserted images appear. Images with higher values of layer appear on top of images with lower values of layer.

getLayer

public Integer getLayer()

Use Layer (Layer) to specify how overlapping inserted images appear. Images with higher values of layer appear on top of images with lower values of layer.

Returns:

Use Layer (Layer) to specify how overlapping inserted images appear. Images with higher values of layer appear on top of images with lower values of layer.

withLayer

public InsertableImage withLayer(Integer layer)

Use Layer (Layer) to specify how overlapping inserted images appear. Images with higher values of layer appear on top of images with lower values of layer.

Parameters:

layer - Use Layer (Layer) to specify how overlapping inserted images appear. Images with higher values of layer appear on top of images with lower values of layer.

Returns:

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

setOpacity

public void setOpacity(Integer opacity)

Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.

Parameters:

opacity - Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.

getOpacity

public Integer getOpacity()

Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.

Returns:

Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.

withOpacity

public InsertableImage withOpacity(Integer opacity)

Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.

Parameters:

opacity - Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.

Returns:

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

setStartTime

public void setStartTime(String startTime)

Use Start time (StartTime) to specify the video timecode when the image is inserted in the output. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format.

Parameters:

startTime - Use Start time (StartTime) to specify the video timecode when the image is inserted in the output. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format.

getStartTime

public String getStartTime()

Use Start time (StartTime) to specify the video timecode when the image is inserted in the output. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format.

Returns:

Use Start time (StartTime) to specify the video timecode when the image is inserted in the output. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format.

withStartTime

public InsertableImage withStartTime(String startTime)

Use Start time (StartTime) to specify the video timecode when the image is inserted in the output. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format.

Parameters:

startTime - Use Start time (StartTime) to specify the video timecode when the image is inserted in the output. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format.

Returns:

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

setWidth

public void setWidth(Integer width)

Specify the Width (Width) of the inserted image. Use a value that is less than or equal to the video resolution width. Leave this setting blank to use the native width of the image.

Parameters:

width - Specify the Width (Width) of the inserted image. Use a value that is less than or equal to the video resolution width. Leave this setting blank to use the native width of the image.

getWidth

public Integer getWidth()

Specify the Width (Width) of the inserted image. Use a value that is less than or equal to the video resolution width. Leave this setting blank to use the native width of the image.

Returns:

Specify the Width (Width) of the inserted image. Use a value that is less than or equal to the video resolution width. Leave this setting blank to use the native width of the image.

withWidth

public InsertableImage withWidth(Integer width)

Specify the Width (Width) of the inserted image. Use a value that is less than or equal to the video resolution width. Leave this setting blank to use the native width of the image.

Parameters:

width - Specify the Width (Width) of the inserted image. Use a value that is less than or equal to the video resolution width. Leave this setting blank to use the native width of the image.

Returns:

Returns a reference to this 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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public InsertableImage clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.