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 that specify how your still graphic overlay appears.

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() Specify the time, in milliseconds, for the image to remain on the output video.
Integer	getFadeIn() Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity.
Integer	getFadeOut() Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency.
Integer	getHeight() Specify the height of the inserted image in pixels.
String	getImageInserterInput() Specify the Amazon S3 location of the image that you want to overlay on the video.
Integer	getImageX() Specify the distance, in pixels, between the inserted image and the left edge of the video frame.
Integer	getImageY() Specify the distance, in pixels, between the overlaid image and the top edge of the video frame.
Integer	getLayer() 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() Specify the timecode of the frame that you want the overlay to first appear on.
Integer	getWidth() Specify the width of the inserted image in pixels.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setDuration(Integer duration) Specify the time, in milliseconds, for the image to remain on the output video.
void	setFadeIn(Integer fadeIn) Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity.
void	setFadeOut(Integer fadeOut) Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency.
void	setHeight(Integer height) Specify the height of the inserted image in pixels.
void	setImageInserterInput(String imageInserterInput) Specify the Amazon S3 location of the image that you want to overlay on the video.
void	setImageX(Integer imageX) Specify the distance, in pixels, between the inserted image and the left edge of the video frame.
void	setImageY(Integer imageY) Specify the distance, in pixels, between the overlaid image and the top edge of the video frame.
void	setLayer(Integer layer) 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) Specify the timecode of the frame that you want the overlay to first appear on.
void	setWidth(Integer width) Specify the width of the inserted image in pixels.
String	toString() Returns a string representation of this object.
InsertableImage	withDuration(Integer duration) Specify the time, in milliseconds, for the image to remain on the output video.
InsertableImage	withFadeIn(Integer fadeIn) Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity.
InsertableImage	withFadeOut(Integer fadeOut) Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency.
InsertableImage	withHeight(Integer height) Specify the height of the inserted image in pixels.
InsertableImage	withImageInserterInput(String imageInserterInput) Specify the Amazon S3 location of the image that you want to overlay on the video.
InsertableImage	withImageX(Integer imageX) Specify the distance, in pixels, between the inserted image and the left edge of the video frame.
InsertableImage	withImageY(Integer imageY) Specify the distance, in pixels, between the overlaid image and the top edge of the video frame.
InsertableImage	withLayer(Integer layer) 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) Specify the timecode of the frame that you want the overlay to first appear on.
InsertableImage	withWidth(Integer width) Specify the width of the inserted image in pixels.

Methods inherited from class java.lang.Object

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

Constructor Detail

InsertableImage

public InsertableImage()

Method Detail

setDuration

public void setDuration(Integer duration)

Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time.

Parameters:

duration - Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time.

getDuration

public Integer getDuration()

Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time.

Returns:

Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time.

withDuration

public InsertableImage withDuration(Integer duration)

Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time.

Parameters:

duration - Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time.

Returns:

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

setFadeIn

public void setFadeIn(Integer fadeIn)

Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If you don't specify a value for Fade-in, the image will appear abruptly at the overlay start time.

Parameters:

fadeIn - Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If you don't specify a value for Fade-in, the image will appear abruptly at the overlay start time.

getFadeIn

public Integer getFadeIn()

Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If you don't specify a value for Fade-in, the image will appear abruptly at the overlay start time.

Returns:

Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If you don't specify a value for Fade-in, the image will appear abruptly at the overlay start time.

withFadeIn

public InsertableImage withFadeIn(Integer fadeIn)

Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If you don't specify a value for Fade-in, the image will appear abruptly at the overlay start time.

Parameters:

fadeIn - Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If you don't specify a value for Fade-in, the image will appear abruptly at the overlay start time.

Returns:

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

setFadeOut

public void setFadeOut(Integer fadeOut)

Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. 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 - Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. 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()

Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. If you don't specify a value for Fade-out, the image will disappear abruptly at the end of the inserted image duration.

Returns:

Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. 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)

Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. 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 - Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. 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 of the inserted image in pixels. If you specify a value that's larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank.

Parameters:

height - Specify the height of the inserted image in pixels. If you specify a value that's larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank.

getHeight

public Integer getHeight()

Specify the height of the inserted image in pixels. If you specify a value that's larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank.

Returns:

Specify the height of the inserted image in pixels. If you specify a value that's larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank.

withHeight

public InsertableImage withHeight(Integer height)

Specify the height of the inserted image in pixels. If you specify a value that's larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank.

Parameters:

height - Specify the height of the inserted image in pixels. If you specify a value that's larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank.

Returns:

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

setImageInserterInput

public void setImageInserterInput(String imageInserterInput)

Specify the Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.

Parameters:

imageInserterInput - Specify the Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.

getImageInserterInput

public String getImageInserterInput()

Specify the Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.

Returns:

Specify the Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.

withImageInserterInput

public InsertableImage withImageInserterInput(String imageInserterInput)

Specify the Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.

Parameters:

imageInserterInput - Specify the Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.

Returns:

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

setImageX

public void setImageX(Integer imageX)

Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify.

Parameters:

imageX - Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify.

getImageX

public Integer getImageX()

Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify.

Returns:

Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify.

withImageX

public InsertableImage withImageX(Integer imageX)

Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify.

Parameters:

imageX - Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify.

Returns:

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

setImageY

public void setImageY(Integer imageY)

Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.

Parameters:

imageY - Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.

getImageY

public Integer getImageY()

Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.

Returns:

Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.

withImageY

public InsertableImage withImageY(Integer imageY)

Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.

Parameters:

imageY - Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.

Returns:

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

setLayer

public void setLayer(Integer layer)

Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer.

Parameters:

layer - Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer.

getLayer

public Integer getLayer()

Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer.

Returns:

Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer.

withLayer

public InsertableImage withLayer(Integer layer)

Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer.

Parameters:

layer - Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for 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)

Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.

Parameters:

startTime - Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.

getStartTime

public String getStartTime()

Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.

Returns:

Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.

withStartTime

public InsertableImage withStartTime(String startTime)

Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.

Parameters:

startTime - Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.

Returns:

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

setWidth

public void setWidth(Integer width)

Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank.

Parameters:

width - Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank.

getWidth

public Integer getWidth()

Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank.

Returns:

Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank.

withWidth

public InsertableImage withWidth(Integer width)

Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank.

Parameters:

width - Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank.

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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)

Specified by:

marshall in interface StructuredPojo