software.amazon.awssdk.services.mediaconvert.model

Interface InsertableImage.Builder

All Superinterfaces:

Buildable, CopyableBuilder<InsertableImage.Builder,InsertableImage>, SdkBuilder<InsertableImage.Builder,InsertableImage>, SdkPojo

Enclosing class:

InsertableImage

public static interface InsertableImage.Builder
extends SdkPojo, CopyableBuilder<InsertableImage.Builder,InsertableImage>

Method Summary

Modifier and Type	Method and Description
InsertableImage.Builder	duration(Integer duration) Specify the time, in milliseconds, for the image to remain on the output video.
InsertableImage.Builder	fadeIn(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.Builder	fadeOut(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.Builder	height(Integer height) Specify the height of the inserted image in pixels.
InsertableImage.Builder	imageInserterInput(String imageInserterInput) Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video.
InsertableImage.Builder	imageX(Integer imageX) Specify the distance, in pixels, between the inserted image and the left edge of the video frame.
InsertableImage.Builder	imageY(Integer imageY) Specify the distance, in pixels, between the overlaid image and the top edge of the video frame.
InsertableImage.Builder	layer(Integer layer) Specify how overlapping inserted images appear.
InsertableImage.Builder	opacity(Integer opacity) Use Opacity to specify how much of the underlying video shows through the inserted image.
InsertableImage.Builder	startTime(String startTime) Specify the timecode of the frame that you want the overlay to first appear on.
InsertableImage.Builder	width(Integer width) Specify the width of the inserted image in pixels.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

duration

InsertableImage.Builder duration(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.

fadeIn

InsertableImage.Builder fadeIn(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.

fadeOut

InsertableImage.Builder fadeOut(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.

height

InsertableImage.Builder height(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.

imageInserterInput

InsertableImage.Builder imageInserterInput(String imageInserterInput)

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

Parameters:

imageInserterInput - Specify the HTTP, HTTPS, or 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.

imageX

InsertableImage.Builder imageX(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.

imageY

InsertableImage.Builder imageY(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.

layer

InsertableImage.Builder layer(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.

opacity

InsertableImage.Builder opacity(Integer opacity)

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

startTime

InsertableImage.Builder startTime(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.

width

InsertableImage.Builder width(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.