Class InsertableImage

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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    InsertableImage.Builder
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static InsertableImage.Builder
    builder()
     
    final Integer
    duration()
    Specify the time, in milliseconds, for the image to remain on the output video.
    final boolean
    equals(Object obj)
     
    final boolean
    equalsBySdkFields(Object obj)
    Indicates whether some other object is "equal to" this one by SDK fields.
    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.
    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.
    final <T> Optional<T>
    getValueForField(String fieldName, Class<T> clazz)
     
    final int
    hashCode()
     
    final Integer
    height()
    Specify the height of the inserted image in pixels.
    final String
    imageInserterInput()
    Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video.
    final Integer
    imageX()
    Specify the distance, in pixels, between the inserted image and the left edge of the video frame.
    final Integer
    imageY()
    Specify the distance, in pixels, between the overlaid image and the top edge of the video frame.
    final Integer
    layer()
    Specify how overlapping inserted images appear.
    final Integer
    opacity()
    Use Opacity to specify how much of the underlying video shows through the inserted image.
    final List<SdkField<?>>
    sdkFields()
     
    static Class<? extends InsertableImage.Builder>
    serializableBuilderClass()
     
    final String
    startTime()
    Specify the timecode of the frame that you want the overlay to first appear on.
    InsertableImage.Builder
    toBuilder()
    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.
    final Integer
    width()
    Specify the width of the inserted image in pixels.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

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

    copy

  • Method Details

    • 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()
      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 interface ToCopyableBuilder<InsertableImage.Builder,InsertableImage>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.