Skip to content

/AWS1/CL_MDCINSERTABLEIMAGE

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

CONSTRUCTOR

IMPORTING

Optional arguments:

IV_DURATION TYPE /AWS1/MDC__INTEGERMIN0MAX21400 /AWS1/MDC__INTEGERMIN0MAX21400

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.

IV_FADEIN TYPE /AWS1/MDC__INTEGERMIN0MAX21400 /AWS1/MDC__INTEGERMIN0MAX21400

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.

IV_FADEOUT TYPE /AWS1/MDC__INTEGERMIN0MAX21400 /AWS1/MDC__INTEGERMIN0MAX21400

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.

IV_HEIGHT TYPE /AWS1/MDC__INTEGERMIN0MAX21400 /AWS1/MDC__INTEGERMIN0MAX21400

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.

IV_IMAGEINSERTERINPUT TYPE /AWS1/MDC__STRMIN14PATS3BMPB01 /AWS1/MDC__STRMIN14PATS3BMPB01

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.

IV_IMAGEX TYPE /AWS1/MDC__INTEGERMIN0MAX21400 /AWS1/MDC__INTEGERMIN0MAX21400

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.

IV_IMAGEY TYPE /AWS1/MDC__INTEGERMIN0MAX21400 /AWS1/MDC__INTEGERMIN0MAX21400

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.

IV_LAYER TYPE /AWS1/MDC__INTEGERMIN0MAX99 /AWS1/MDC__INTEGERMIN0MAX99

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

IV_OPACITY TYPE /AWS1/MDC__INTEGERMIN0MAX100 /AWS1/MDC__INTEGERMIN0MAX100

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.

IV_STARTTIME TYPE /AWS1/MDC__STRPAT01D20305D205D /AWS1/MDC__STRPAT01D20305D205D

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.

IV_WIDTH TYPE /AWS1/MDC__INTEGERMIN0MAX21400 /AWS1/MDC__INTEGERMIN0MAX21400

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.


Queryable Attributes

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.

Accessible with the following methods

Method Description
GET_DURATION() Getter for DURATION, with configurable default
ASK_DURATION() Getter for DURATION w/ exceptions if field has no value
HAS_DURATION() Determine if DURATION has a value

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.

Accessible with the following methods

Method Description
GET_FADEIN() Getter for FADEIN, with configurable default
ASK_FADEIN() Getter for FADEIN w/ exceptions if field has no value
HAS_FADEIN() Determine if FADEIN has a value

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.

Accessible with the following methods

Method Description
GET_FADEOUT() Getter for FADEOUT, with configurable default
ASK_FADEOUT() Getter for FADEOUT w/ exceptions if field has no value
HAS_FADEOUT() Determine if FADEOUT has a value

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.

Accessible with the following methods

Method Description
GET_HEIGHT() Getter for HEIGHT, with configurable default
ASK_HEIGHT() Getter for HEIGHT w/ exceptions if field has no value
HAS_HEIGHT() Determine if HEIGHT has a value

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.

Accessible with the following methods

Method Description
GET_IMAGEINSERTERINPUT() Getter for IMAGEINSERTERINPUT, with configurable default
ASK_IMAGEINSERTERINPUT() Getter for IMAGEINSERTERINPUT w/ exceptions if field has no
HAS_IMAGEINSERTERINPUT() Determine if IMAGEINSERTERINPUT has a value

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.

Accessible with the following methods

Method Description
GET_IMAGEX() Getter for IMAGEX, with configurable default
ASK_IMAGEX() Getter for IMAGEX w/ exceptions if field has no value
HAS_IMAGEX() Determine if IMAGEX has a value

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.

Accessible with the following methods

Method Description
GET_IMAGEY() Getter for IMAGEY, with configurable default
ASK_IMAGEY() Getter for IMAGEY w/ exceptions if field has no value
HAS_IMAGEY() Determine if IMAGEY has a value

Layer

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

Accessible with the following methods

Method Description
GET_LAYER() Getter for LAYER, with configurable default
ASK_LAYER() Getter for LAYER w/ exceptions if field has no value
HAS_LAYER() Determine if LAYER has a value

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.

Accessible with the following methods

Method Description
GET_OPACITY() Getter for OPACITY, with configurable default
ASK_OPACITY() Getter for OPACITY w/ exceptions if field has no value
HAS_OPACITY() Determine if OPACITY has a value

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.

Accessible with the following methods

Method Description
GET_STARTTIME() Getter for STARTTIME, with configurable default
ASK_STARTTIME() Getter for STARTTIME w/ exceptions if field has no value
HAS_STARTTIME() Determine if STARTTIME has a value

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.

Accessible with the following methods

Method Description
GET_WIDTH() Getter for WIDTH, with configurable default
ASK_WIDTH() Getter for WIDTH w/ exceptions if field has no value
HAS_WIDTH() Determine if WIDTH has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT___LISTOFINSERTABLEIMAGE

TYPES TT___LISTOFINSERTABLEIMAGE TYPE STANDARD TABLE OF REF TO /AWS1/CL_MDCINSERTABLEIMAGE WITH DEFAULT KEY
.