software.amazon.awssdk.services.mediaconvert.model

Class VideoOverlayInput

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.VideoOverlayInput

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<VideoOverlayInput.Builder,VideoOverlayInput>

@Generated(value="software.amazon.awssdk:codegen")
public final class VideoOverlayInput
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<VideoOverlayInput.Builder,VideoOverlayInput>

Input settings for Video overlay. You can include one or more video overlays in sequence at different times that you specify.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VideoOverlayInput.Builder

Method Summary

Modifier and Type	Method and Description
static VideoOverlayInput.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fileInput() Specify the input file S3, HTTP, or HTTPS URI for your video overlay.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInputClippings() For responses, this returns true if the service returned a value for the InputClippings property.
List<VideoOverlayInputClipping>	inputClippings() Specify one or more clips to use from your video overlay.
List<SdkField<?>>	sdkFields()
static Class<? extends VideoOverlayInput.Builder>	serializableBuilderClass()
InputTimecodeSource	timecodeSource() Specify the starting timecode for your video overlay.
String	timecodeSourceAsString() Specify the starting timecode for your video overlay.
String	timecodeStart() Specify the starting timecode for this video overlay.
VideoOverlayInput.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

fileInput

public final String fileInput()

Specify the input file S3, HTTP, or HTTPS URI for your video overlay. For consistency in color and formatting in your output video image, we recommend that you specify a video with similar characteristics as the underlying input video.

Returns:

Specify the input file S3, HTTP, or HTTPS URI for your video overlay. For consistency in color and formatting in your output video image, we recommend that you specify a video with similar characteristics as the underlying input video.

hasInputClippings

public final boolean hasInputClippings()

For responses, this returns true if the service returned a value for the InputClippings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

inputClippings

public final List<VideoOverlayInputClipping> inputClippings()

Specify one or more clips to use from your video overlay. When you include an input clip, you must also specify its start timecode, end timecode, or both start and end timecode.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInputClippings() method.

Returns:

Specify one or more clips to use from your video overlay. When you include an input clip, you must also specify its start timecode, end timecode, or both start and end timecode.

timecodeSource

public final InputTimecodeSource timecodeSource()

Specify the starting timecode for your video overlay. To use the timecode present in your video overlay: Choose Embedded. To use a zerobased timecode: Choose Start at 0. To choose a timecode: Choose Specified start. When you do, enter the starting timecode in Start timecode. If you don't specify a value for Timecode source, MediaConvert uses Embedded by default.

If the service returns an enum value that is not available in the current SDK version, timecodeSource will return InputTimecodeSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timecodeSourceAsString().

Returns:

Specify the starting timecode for your video overlay. To use the timecode present in your video overlay: Choose Embedded. To use a zerobased timecode: Choose Start at 0. To choose a timecode: Choose Specified start. When you do, enter the starting timecode in Start timecode. If you don't specify a value for Timecode source, MediaConvert uses Embedded by default.

See Also:

InputTimecodeSource

timecodeSourceAsString

public final String timecodeSourceAsString()

Specify the starting timecode for your video overlay. To use the timecode present in your video overlay: Choose Embedded. To use a zerobased timecode: Choose Start at 0. To choose a timecode: Choose Specified start. When you do, enter the starting timecode in Start timecode. If you don't specify a value for Timecode source, MediaConvert uses Embedded by default.

If the service returns an enum value that is not available in the current SDK version, timecodeSource will return InputTimecodeSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timecodeSourceAsString().

Returns:

Specify the starting timecode for your video overlay. To use the timecode present in your video overlay: Choose Embedded. To use a zerobased timecode: Choose Start at 0. To choose a timecode: Choose Specified start. When you do, enter the starting timecode in Start timecode. If you don't specify a value for Timecode source, MediaConvert uses Embedded by default.

See Also:

InputTimecodeSource

timecodeStart

public final String timecodeStart()

Specify the starting timecode for this video overlay. To use this setting, you must set Timecode source to Specified start.

Returns:

Specify the starting timecode for this video overlay. To use this setting, you must set Timecode source to Specified start.

toBuilder

public VideoOverlayInput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VideoOverlayInput.Builder,VideoOverlayInput>

builder

public static VideoOverlayInput.Builder builder()

serializableBuilderClass

public static Class<? extends VideoOverlayInput.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo