mediaconvert/aws.sdk.kotlin.services.mediaconvert.model/InsertableImage

InsertableImage

class InsertableImage

These settings apply to a specific graphic overlay. You can include multiple overlays in your job.

Types

Builder

class Builder

Companion

object Companion

Properties

duration

val duration: Int?

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

val fadeIn: Int?

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

val fadeOut: Int?

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

val height: Int?

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

val imageInserterInput: String?

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

val imageX: Int?

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

val imageY: Int?

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

val layer: Int?

Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer.

opacity

val opacity: Int?

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

val startTime: String?

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

val width: Int?

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.

Functions

copy

inline fun copy(block: InsertableImage.Builder.() -> Unit = {}): InsertableImage

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String