software.amazon.awssdk.services.mediaconvert.model

Class ImageInserter

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.ImageInserter

All Implemented Interfaces:

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

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

Use the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for each input or output individually. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/graphic-overlay.html. This setting is disabled by default.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImageInserter.Builder

Method Summary

Modifier and Type	Method and Description
static ImageInserter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInsertableImages() For responses, this returns true if the service returned a value for the InsertableImages property.
List<InsertableImage>	insertableImages() Specify the images that you want to overlay on your video.
List<SdkField<?>>	sdkFields()
Integer	sdrReferenceWhiteLevel() Specify the reference white level, in nits, for all of your image inserter images.
static Class<? extends ImageInserter.Builder>	serializableBuilderClass()
ImageInserter.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

hasInsertableImages

public final boolean hasInsertableImages()

For responses, this returns true if the service returned a value for the InsertableImages 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.

insertableImages

public final List<InsertableImage> insertableImages()

Specify the images that you want to overlay on your video. The images must be PNG or TGA files.

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 hasInsertableImages() method.

Returns:

Specify the images that you want to overlay on your video. The images must be PNG or TGA files.

sdrReferenceWhiteLevel

public final Integer sdrReferenceWhiteLevel()

Specify the reference white level, in nits, for all of your image inserter images. Use to correct brightness levels within HDR10 outputs. For 1,000 nit peak brightness displays, we recommend that you set SDR reference white level to 203 (according to ITU-R BT.2408). Leave blank to use the default value of 100, or specify an integer from 100 to 1000.

Returns:

Specify the reference white level, in nits, for all of your image inserter images. Use to correct brightness levels within HDR10 outputs. For 1,000 nit peak brightness displays, we recommend that you set SDR reference white level to 203 (according to ITU-R BT.2408). Leave blank to use the default value of 100, or specify an integer from 100 to 1000.

toBuilder

public ImageInserter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImageInserter.Builder,ImageInserter>

builder

public static ImageInserter.Builder builder()

serializableBuilderClass

public static Class<? extends ImageInserter.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