Class MotionImageInserter
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MotionImageInserter.Builder,
MotionImageInserter>
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic MotionImageInserter.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.If your motion graphic asset is a .mov file, keep this setting unspecified.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
input()
Specify the .mov file or series of .png files that you want to overlay on your video.final MotionImageInsertionMode
Choose the type of motion graphic asset that you are providing for your overlay.final String
Choose the type of motion graphic asset that you are providing for your overlay.offset()
Use Offset to specify the placement of your motion graphic overlay on the video frame.final MotionImagePlayback
playback()
Specify whether your motion graphic overlay repeats on a loop or plays only once.final String
Specify whether your motion graphic overlay repeats on a loop or plays only once.static Class
<? extends MotionImageInserter.Builder> final String
Specify when the motion overlay begins.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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:
- 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.
-
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:
- 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.
-
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.If the service returns an enum value that is not available in the current SDK version,
insertionMode
will returnMotionImageInsertionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominsertionModeAsString()
.- Returns:
- 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.
- See Also:
-
insertionModeAsString
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.If the service returns an enum value that is not available in the current SDK version,
insertionMode
will returnMotionImageInsertionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominsertionModeAsString()
.- Returns:
- 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.
- See Also:
-
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:
- 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.
-
playback
Specify whether your motion graphic overlay repeats on a loop or plays only once.If the service returns an enum value that is not available in the current SDK version,
playback
will returnMotionImagePlayback.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplaybackAsString()
.- Returns:
- Specify whether your motion graphic overlay repeats on a loop or plays only once.
- See Also:
-
playbackAsString
Specify whether your motion graphic overlay repeats on a loop or plays only once.If the service returns an enum value that is not available in the current SDK version,
playback
will returnMotionImagePlayback.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplaybackAsString()
.- Returns:
- Specify whether your motion graphic overlay repeats on a loop or plays only once.
- See Also:
-
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- Returns:
- 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
-
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 interfaceToCopyableBuilder<MotionImageInserter.Builder,
MotionImageInserter> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-