software.amazon.awssdk.services.mediaconvert.model

Interface InsertableImage.Builder

All Superinterfaces:

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

Enclosing class:

InsertableImage

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

Method Summary

Modifier and Type	Method and Description
InsertableImage.Builder	duration(Integer duration) Use Duration (Duration) to set the time, in milliseconds, for the image to remain on the output video.
InsertableImage.Builder	fadeIn(Integer fadeIn) Use Fade in (FadeIut) to set the length, in milliseconds, of the inserted image fade in.
InsertableImage.Builder	fadeOut(Integer fadeOut) Use Fade out (FadeOut) to set the length, in milliseconds, of the inserted image fade out.
InsertableImage.Builder	height(Integer height) Specify the Height (Height) of the inserted image.
InsertableImage.Builder	imageInserterInput(String imageInserterInput) Use Image location (imageInserterInput) to specify the Amazon S3 location of the image to be inserted into the output.
InsertableImage.Builder	imageX(Integer imageX) Use Left (ImageX) to set the distance, in pixels, between the inserted image and the left edge of the frame.
InsertableImage.Builder	imageY(Integer imageY) Use Top (ImageY) to set the distance, in pixels, between the inserted image and the top edge of the video frame.
InsertableImage.Builder	layer(Integer layer) Use Layer (Layer) to specify how overlapping inserted images appear.
InsertableImage.Builder	opacity(Integer opacity) Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image.
InsertableImage.Builder	startTime(String startTime) Use Start time (StartTime) to specify the video timecode when the image is inserted in the output.
InsertableImage.Builder	width(Integer width) Specify the Width (Width) of the inserted image.

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

copy

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

apply, build

Method Detail

duration

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

fadeIn

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

fadeOut

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

height

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

imageInserterInput

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

imageX

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

imageY

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

layer

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

opacity

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

startTime

InsertableImage.Builder startTime(String startTime)

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

Parameters:

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

Returns:

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

width

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