class Aws::MediaLive::Types::StaticImageActivateScheduleActionSettings

Settings for the action to activate a static image.

@note When making an API call, you may pass StaticImageActivateScheduleActionSettings

data as a hash:

    {
      duration: 1,
      fade_in: 1,
      fade_out: 1,
      height: 1,
      image: { # required
        password_param: "__string",
        uri: "__string", # required
        username: "__string",
      },
      image_x: 1,
      image_y: 1,
      layer: 1,
      opacity: 1,
      width: 1,
    }

@!attribute [rw] duration

The duration in milliseconds for the image to remain on the video.
If omitted or set to 0 the duration is unlimited and the image will
remain until it is explicitly deactivated.
@return [Integer]

@!attribute [rw] fade_in

The time in milliseconds for the image to fade in. The fade-in
starts at the start time of the overlay. Default is 0 (no fade-in).
@return [Integer]

@!attribute [rw] fade_out

Applies only if a duration is specified. The time in milliseconds
for the image to fade out. The fade-out starts when the duration
time is hit, so it effectively extends the duration. Default is 0
(no fade-out).
@return [Integer]

@!attribute [rw] height

The height of the image when inserted into the video, in pixels. The
overlay will be scaled up or down to the specified height. Leave
blank to use the native height of the overlay.
@return [Integer]

@!attribute [rw] image

The location and filename of the image file to overlay on the video.
The file must be a 32-bit BMP, PNG, or TGA file, and must not be
larger (in pixels) than the input video.
@return [Types::InputLocation]

@!attribute [rw] image_x

Placement of the left edge of the overlay relative to the left edge
of the video frame, in pixels. 0 (the default) is the left edge of
the frame. If the placement causes the overlay to extend beyond the
right edge of the underlying video, then the overlay is cropped on
the right.
@return [Integer]

@!attribute [rw] image_y

Placement of the top edge of the overlay relative to the top edge of
the video frame, in pixels. 0 (the default) is the top edge of the
frame. If the placement causes the overlay to extend beyond the
bottom edge of the underlying video, then the overlay is cropped on
the bottom.
@return [Integer]

@!attribute [rw] layer

The number of the layer, 0 to 7. There are 8 layers that can be
overlaid on the video, each layer with a different image. The layers
are in Z order, which means that overlays with higher values of
layer are inserted on top of overlays with lower values of layer.
Default is 0.
@return [Integer]

@!attribute [rw] opacity

Opacity of image where 0 is transparent and 100 is fully opaque.
Default is 100.
@return [Integer]

@!attribute [rw] width

The width of the image when inserted into the video, in pixels. The
overlay will be scaled up or down to the specified width. Leave
blank to use the native width of the overlay.
@return [Integer]

@see docs.aws.amazon.com/goto/WebAPI/medialive-2017-10-14/StaticImageActivateScheduleActionSettings AWS API Documentation

Constants

SENSITIVE