software.amazon.awssdk.services.mediaconvert.model

Class InsertableImage

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.InsertableImage

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InsertableImage.Builder,InsertableImage>

@Generated(value="software.amazon.awssdk:codegen")
public final class InsertableImage
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InsertableImage.Builder,InsertableImage>

Settings that specify how your overlay appears.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InsertableImage.Builder

Method Summary

Modifier and Type	Method and Description
static InsertableImage.Builder	builder()
Integer	duration() Set the time, in milliseconds, for the image to remain on the output video.
boolean	equals(Object obj)
Integer	fadeIn() Set 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	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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	height() Specify the height of the inserted image in pixels.
String	imageInserterInput() Use Image location (imageInserterInput) to specify the Amazon S3 location of the image to be inserted into the output.
Integer	imageX() Use Left (ImageX) to set the distance, in pixels, between the inserted image and the left edge of the video frame.
Integer	imageY() Use Top (ImageY) to set the distance, in pixels, between the overlaid image and the top edge of the video frame.
Integer	layer() Specify how overlapping inserted images appear.
Integer	opacity() Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image.
List<SdkField<?>>	sdkFields()
static Class<? extends InsertableImage.Builder>	serializableBuilderClass()
String	startTime() Use Start time (StartTime) to specify the video timecode when the image is inserted in the output.
InsertableImage.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Integer	width() Specify the width of the inserted image in pixels.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

duration

public Integer duration()

Set the time, in milliseconds, for the image to remain on the output video.

Returns:

Set the time, in milliseconds, for the image to remain on the output video.

fadeIn

public Integer fadeIn()

Set 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:

Set 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.

fadeOut

public 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.

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.

height

public 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.

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.

imageInserterInput

public String imageInserterInput()

Use Image location (imageInserterInput) to specify the Amazon S3 location of the image to be inserted into the output. Use a 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 PNG or TGA file that fits inside the video frame.

imageX

public Integer imageX()

Use Left (ImageX) to set 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:

Use Left (ImageX) to set the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify.

imageY

public Integer imageY()

Use Top (ImageY) to set 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:

Use Top (ImageY) to set the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.

layer

public Integer layer()

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.

opacity

public 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.

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.

startTime

public 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.

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.

width

public 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.

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.

toBuilder

public InsertableImage.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<InsertableImage.Builder,InsertableImage>

Returns:

a builder for type T

builder

public static InsertableImage.Builder builder()

serializableBuilderClass

public static Class<? extends InsertableImage.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.