com.amazonaws.services.mediaconvert.model

Class MotionImageInserter

java.lang.Object

com.amazonaws.services.mediaconvert.model.MotionImageInserter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MotionImageInserter
extends Object
implements Serializable, Cloneable, StructuredPojo

Overlay motion graphics on top of your video at the time that you specify.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
MotionImageInserter()

Method Summary

Modifier and Type	Method and Description
MotionImageInserter	clone()
boolean	equals(Object obj)
MotionImageInsertionFramerate	getFramerate() If your motion graphic asset is a .mov file, keep this setting unspecified.
String	getInput() Specify the .mov file or series of .png files that you want to overlay on your video.
String	getInsertionMode() Choose the type of motion graphic asset that you are providing for your overlay.
MotionImageInsertionOffset	getOffset() Use Offset to specify the placement of your motion graphic overlay on the video frame.
String	getPlayback() Specify whether your motion graphic overlay repeats on a loop or plays only once.
String	getStartTime() Specify when the motion overlay begins.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setFramerate(MotionImageInsertionFramerate framerate) If your motion graphic asset is a .mov file, keep this setting unspecified.
void	setInput(String input) Specify the .mov file or series of .png files that you want to overlay on your video.
void	setInsertionMode(String insertionMode) Choose the type of motion graphic asset that you are providing for your overlay.
void	setOffset(MotionImageInsertionOffset offset) Use Offset to specify the placement of your motion graphic overlay on the video frame.
void	setPlayback(String playback) Specify whether your motion graphic overlay repeats on a loop or plays only once.
void	setStartTime(String startTime) Specify when the motion overlay begins.
String	toString() Returns a string representation of this object.
MotionImageInserter	withFramerate(MotionImageInsertionFramerate framerate) If your motion graphic asset is a .mov file, keep this setting unspecified.
MotionImageInserter	withInput(String input) Specify the .mov file or series of .png files that you want to overlay on your video.
MotionImageInserter	withInsertionMode(MotionImageInsertionMode insertionMode) Choose the type of motion graphic asset that you are providing for your overlay.
MotionImageInserter	withInsertionMode(String insertionMode) Choose the type of motion graphic asset that you are providing for your overlay.
MotionImageInserter	withOffset(MotionImageInsertionOffset offset) Use Offset to specify the placement of your motion graphic overlay on the video frame.
MotionImageInserter	withPlayback(MotionImagePlayback playback) Specify whether your motion graphic overlay repeats on a loop or plays only once.
MotionImageInserter	withPlayback(String playback) Specify whether your motion graphic overlay repeats on a loop or plays only once.
MotionImageInserter	withStartTime(String startTime) Specify when the motion overlay begins.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MotionImageInserter

public MotionImageInserter()

Method Detail

setFramerate

public void setFramerate(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.

getFramerate

public MotionImageInsertionFramerate getFramerate()

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.

withFramerate

public MotionImageInserter withFramerate(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.

setInput

public void setInput(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.

getInput

public String getInput()

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.

withInput

public MotionImageInserter withInput(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.

setInsertionMode

public void setInsertionMode(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.

See Also:

MotionImageInsertionMode

getInsertionMode

public String getInsertionMode()

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:

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:

MotionImageInsertionMode

withInsertionMode

public MotionImageInserter withInsertionMode(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

withInsertionMode

public MotionImageInserter withInsertionMode(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

setOffset

public void setOffset(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.

getOffset

public MotionImageInsertionOffset getOffset()

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.

withOffset

public MotionImageInserter withOffset(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.

setPlayback

public void setPlayback(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.

See Also:

MotionImagePlayback

getPlayback

public String getPlayback()

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

Returns:

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

See Also:

MotionImagePlayback

withPlayback

public MotionImageInserter withPlayback(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

withPlayback

public MotionImageInserter withPlayback(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

setStartTime

public void setStartTime(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.

getStartTime

public String getStartTime()

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:

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.

withStartTime

public MotionImageInserter withStartTime(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.

toString

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public MotionImageInserter clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.