software.amazon.awssdk.services.mediaconvert.model

Interface MotionImageInserter.Builder

All Superinterfaces:

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

Enclosing class:

MotionImageInserter

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

Method Summary

Modifier and Type	Method and Description
default MotionImageInserter.Builder	framerate(Consumer<MotionImageInsertionFramerate.Builder> framerate) If your motion graphic asset is a .mov file, keep this setting unspecified.
MotionImageInserter.Builder	framerate(MotionImageInsertionFramerate framerate) If your motion graphic asset is a .mov file, keep this setting unspecified.
MotionImageInserter.Builder	input(String input) Specify the .mov file or series of .png files that you want to overlay on your video.
MotionImageInserter.Builder	insertionMode(MotionImageInsertionMode insertionMode) Choose the type of motion graphic asset that you are providing for your overlay.
MotionImageInserter.Builder	insertionMode(String insertionMode) Choose the type of motion graphic asset that you are providing for your overlay.
default MotionImageInserter.Builder	offset(Consumer<MotionImageInsertionOffset.Builder> offset) Use Offset to specify the placement of your motion graphic overlay on the video frame.
MotionImageInserter.Builder	offset(MotionImageInsertionOffset offset) Use Offset to specify the placement of your motion graphic overlay on the video frame.
MotionImageInserter.Builder	playback(MotionImagePlayback playback) Specify whether your motion graphic overlay repeats on a loop or plays only once.
MotionImageInserter.Builder	playback(String playback) Specify whether your motion graphic overlay repeats on a loop or plays only once.
MotionImageInserter.Builder	startTime(String startTime) Specify when the motion overlay begins.

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

framerate

MotionImageInserter.Builder framerate(MotionImageInsertionFramerate framerate)

If your motion graphic asset is a .mov file, keep this setting unspecified. If your motion graphic asset is a series of .png files, specify the frame rate of the overlay in frames per second, as a fraction. For example, specify 24 fps as 24/1. Make sure that the number of images in your series matches the frame rate and your intended overlay duration. For example, if you want a 30-second overlay at 30 fps, you should have 900 .png images. This overlay frame rate doesn't need to match the frame rate of the underlying video.

Parameters:

framerate - If your motion graphic asset is a .mov file, keep this setting unspecified. If your motion graphic asset is a series of .png files, specify the frame rate of the overlay in frames per second, as a fraction. For example, specify 24 fps as 24/1. Make sure that the number of images in your series matches the frame rate and your intended overlay duration. For example, if you want a 30-second overlay at 30 fps, you should have 900 .png images. This overlay frame rate doesn't need to match the frame rate of the underlying video.

Returns:

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

framerate

default MotionImageInserter.Builder framerate(Consumer<MotionImageInsertionFramerate.Builder> framerate)

If your motion graphic asset is a .mov file, keep this setting unspecified. If your motion graphic asset is a series of .png files, specify the frame rate of the overlay in frames per second, as a fraction. For example, specify 24 fps as 24/1. Make sure that the number of images in your series matches the frame rate and your intended overlay duration. For example, if you want a 30-second overlay at 30 fps, you should have 900 .png images. This overlay frame rate doesn't need to match the frame rate of the underlying video. This is a convenience method that creates an instance of the MotionImageInsertionFramerate.Builder avoiding the need to create one manually via MotionImageInsertionFramerate.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to framerate(MotionImageInsertionFramerate).

Parameters:

framerate - a consumer that will call methods on MotionImageInsertionFramerate.Builder

Returns:

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

See Also:

framerate(MotionImageInsertionFramerate)

input

MotionImageInserter.Builder input(String input)

Specify the .mov file or series of .png files that you want to overlay on your video. For .png files, provide the file name of the first file in the series. Make sure that the names of the .png files end with sequential numbers that specify the order that they are played in. For example, overlay_000.png, overlay_001.png, overlay_002.png, and so on. The sequence must start at zero, and each image file name must have the same number of digits. Pad your initial file names with enough zeros to complete the sequence. For example, if the first image is overlay_0.png, there can be only 10 images in the sequence, with the last image being overlay_9.png. But if the first image is overlay_00.png, there can be 100 images in the sequence.

Parameters:

input - Specify the .mov file or series of .png files that you want to overlay on your video. For .png files, provide the file name of the first file in the series. Make sure that the names of the .png files end with sequential numbers that specify the order that they are played in. For example, overlay_000.png, overlay_001.png, overlay_002.png, and so on. The sequence must start at zero, and each image file name must have the same number of digits. Pad your initial file names with enough zeros to complete the sequence. For example, if the first image is overlay_0.png, there can be only 10 images in the sequence, with the last image being overlay_9.png. But if the first image is overlay_00.png, there can be 100 images in the sequence.

Returns:

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

insertionMode

MotionImageInserter.Builder insertionMode(String insertionMode)

Choose the type of motion graphic asset that you are providing for your overlay. You can choose either a .mov file or a series of .png files.

Parameters:

insertionMode - Choose the type of motion graphic asset that you are providing for your overlay. You can choose either a .mov file or a series of .png files.

Returns:

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

See Also:

MotionImageInsertionMode, MotionImageInsertionMode

insertionMode

MotionImageInserter.Builder insertionMode(MotionImageInsertionMode insertionMode)

Choose the type of motion graphic asset that you are providing for your overlay. You can choose either a .mov file or a series of .png files.

Parameters:

insertionMode - Choose the type of motion graphic asset that you are providing for your overlay. You can choose either a .mov file or a series of .png files.

Returns:

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

See Also:

MotionImageInsertionMode, MotionImageInsertionMode

offset

MotionImageInserter.Builder offset(MotionImageInsertionOffset offset)

Use Offset to specify the placement of your motion graphic overlay on the video frame. Specify in pixels, from the upper-left corner of the frame. If you don't specify an offset, the service scales your overlay to the full size of the frame. Otherwise, the service inserts the overlay at its native resolution and scales the size up or down with any video scaling.

Parameters:

offset - Use Offset to specify the placement of your motion graphic overlay on the video frame. Specify in pixels, from the upper-left corner of the frame. If you don't specify an offset, the service scales your overlay to the full size of the frame. Otherwise, the service inserts the overlay at its native resolution and scales the size up or down with any video scaling.

Returns:

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

offset

default MotionImageInserter.Builder offset(Consumer<MotionImageInsertionOffset.Builder> offset)

Use Offset to specify the placement of your motion graphic overlay on the video frame. Specify in pixels, from the upper-left corner of the frame. If you don't specify an offset, the service scales your overlay to the full size of the frame. Otherwise, the service inserts the overlay at its native resolution and scales the size up or down with any video scaling. This is a convenience method that creates an instance of the MotionImageInsertionOffset.Builder avoiding the need to create one manually via MotionImageInsertionOffset.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to offset(MotionImageInsertionOffset).

Parameters:

offset - a consumer that will call methods on MotionImageInsertionOffset.Builder

Returns:

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

See Also:

offset(MotionImageInsertionOffset)

playback

MotionImageInserter.Builder playback(String playback)

Specify whether your motion graphic overlay repeats on a loop or plays only once.

Parameters:

playback - Specify whether your motion graphic overlay repeats on a loop or plays only once.

Returns:

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

See Also:

MotionImagePlayback, MotionImagePlayback

playback

MotionImageInserter.Builder playback(MotionImagePlayback playback)

Specify whether your motion graphic overlay repeats on a loop or plays only once.

Parameters:

playback - Specify whether your motion graphic overlay repeats on a loop or plays only once.

Returns:

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

See Also:

MotionImagePlayback, MotionImagePlayback

startTime

MotionImageInserter.Builder startTime(String startTime)

Specify when the motion overlay begins. Use timecode format (HH:MM:SS:FF or HH:MM:SS;FF). Make sure that the timecode you provide here takes into account how you have set up your timecode configuration under both job settings and input settings. The simplest way to do that is to set both to start at 0. If you need to set up your job to follow timecodes embedded in your source that don't start at zero, make sure that you specify a start time that is after the first embedded timecode. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/setting-up-timecode.html Find job-wide and input timecode configuration settings in your JSON job settings specification at settings>timecodeConfig>source and settings>inputs>timecodeSource.

Parameters:

startTime - Specify when the motion overlay begins. Use timecode format (HH:MM:SS:FF or HH:MM:SS;FF). Make sure that the timecode you provide here takes into account how you have set up your timecode configuration under both job settings and input settings. The simplest way to do that is to set both to start at 0. If you need to set up your job to follow timecodes embedded in your source that don't start at zero, make sure that you specify a start time that is after the first embedded timecode. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/setting-up-timecode.html Find job-wide and input timecode configuration settings in your JSON job settings specification at settings>timecodeConfig>source and settings>inputs>timecodeSource.

Returns:

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