java.lang.Object
- software.amazon.awssdk.services.mediaconvert.model.InsertableImage

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InsertableImage.Builder,InsertableImage>
```
@Generated("software.amazon.awssdk:codegen")
public final class InsertableImage
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InsertableImage.Builder,InsertableImage>
```
These settings apply to a specific graphic overlay. You can include multiple overlays in your job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface InsertableImage.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static InsertableImage.Builder`	`builder()`
`Integer`	`duration()`	Specify the time, in milliseconds, for the image to remain on the output video.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Integer`	`fadeIn()`	Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity.
`Integer`	`fadeOut()`	Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`height()`	Specify the height of the inserted image in pixels.
`String`	`imageInserterInput()`	Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video.
`Integer`	`imageX()`	Specify the distance, in pixels, between the inserted image and the left edge of the video frame.
`Integer`	`imageY()`	Specify the distance, in pixels, between the overlaid image and the top edge of the video frame.
`Integer`	`layer()`	Specify how overlapping inserted images appear.
`Integer`	`opacity()`	Use Opacity to specify how much of the underlying video shows through the inserted image.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends InsertableImage.Builder>`	`serializableBuilderClass()`
`String`	`startTime()`	Specify the timecode of the frame that you want the overlay to first appear on.
`InsertableImage.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Integer`	`width()`	Specify the width of the inserted image in pixels.

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
  - duration
```
public final Integer duration()
```
    Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time.
    
    Returns:
    
    Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time.
  - fadeIn
```
public final Integer fadeIn()
```
    Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If you don't specify a value for Fade-in, the image will appear abruptly at the overlay start time.
    
    Returns:
    
    Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If you don't specify a value for Fade-in, the image will appear abruptly at the overlay start time.
  - fadeOut
```
public final Integer fadeOut()
```
    Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. If you don't specify a value for Fade-out, the image will disappear abruptly at the end of the inserted image duration.
    
    Returns:
    
    Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. If you don't specify a value for Fade-out, the image will disappear abruptly at the end of the inserted image duration.
  - height
```
public final Integer height()
```
    Specify the height of the inserted image in pixels. If you specify a value that's larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank.
    
    Returns:
    
    Specify the height of the inserted image in pixels. If you specify a value that's larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank.
  - imageInserterInput
```
public final String imageInserterInput()
```
    Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.
    
    Returns:
    
    Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.
  - imageX
```
public final Integer imageX()
```
    Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify.
    
    Returns:
    
    Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify.
  - imageY
```
public final Integer imageY()
```
    Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.
    
    Returns:
    
    Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.
  - layer
```
public final Integer layer()
```
    Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer.
    
    Returns:
    
    Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer.
  - opacity
```
public final Integer opacity()
```
    Use Opacity to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.
    
    Returns:
    
    Use Opacity to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.
  - startTime
```
public final String startTime()
```
    Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.
    
    Returns:
    
    Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.
  - width
```
public final Integer width()
```
    Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank.
    
    Returns:
    
    Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank.
  - toBuilder
```
public InsertableImage.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<InsertableImage.Builder,InsertableImage>
  - builder
```
public static InsertableImage.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends InsertableImage.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

Class InsertableImage

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

duration

fadeIn

fadeOut

height

imageInserterInput

imageX

imageY

layer

opacity

startTime

width

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields