You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::MediaLive::Types::StaticImageActivateScheduleActionSettings

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StaticImageActivateScheduleActionSettings as input to an Aws::Client method, you can use a vanilla 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,
}

Settings for the action to activate a static image.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#duration ⇒ Integer

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.

Returns:

  • (Integer) —

    The duration in milliseconds for the image to remain on the video.

#fade_in ⇒ Integer

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).

Returns:

  • (Integer) —

    The time in milliseconds for the image to fade in.

#fade_out ⇒ Integer

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).

Returns:

  • (Integer) —

    Applies only if a duration is specified.

#height ⇒ Integer

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.

Returns:

  • (Integer) —

    The height of the image when inserted into the video, in pixels.

#image ⇒ Types::InputLocation

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.

Returns:

#image_x ⇒ Integer

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.

Returns:

  • (Integer) —

    Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels.

#image_y ⇒ Integer

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.

Returns:

  • (Integer) —

    Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels.

#layer ⇒ Integer

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.

Returns:

  • (Integer) —

    The number of the layer, 0 to 7.

#opacity ⇒ Integer

Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.

Returns:

  • (Integer) —

    Opacity of image where 0 is transparent and 100 is fully opaque.

#width ⇒ Integer

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.

Returns:

  • (Integer) —

    The width of the image when inserted into the video, in pixels.