Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.MediaLive.Types.StaticImageActivateScheduleActionSettings

Description

Synopsis

Documentation

data StaticImageActivateScheduleActionSettings Source #

Settings for the action to activate a static image.

See: newStaticImageActivateScheduleActionSettings smart constructor.

Constructors

StaticImageActivateScheduleActionSettings'

Fields

imageX :: Maybe Natural
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.
height :: Maybe Natural
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.
fadeOut :: Maybe Natural
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).
width :: Maybe Natural
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.
opacity :: Maybe Natural
Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.
layer :: Maybe Natural
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.
duration :: Maybe Natural
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.
imageY :: Maybe Natural
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.
fadeIn :: Maybe Natural
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).
image :: 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.

Instances

Instances details

Eq StaticImageActivateScheduleActionSettings Source #
Instance details Defined in Amazonka.MediaLive.Types.StaticImageActivateScheduleActionSettings Methods (==) :: StaticImageActivateScheduleActionSettings -> StaticImageActivateScheduleActionSettings -> Bool # (/=) :: StaticImageActivateScheduleActionSettings -> StaticImageActivateScheduleActionSettings -> Bool #
Read StaticImageActivateScheduleActionSettings Source #
Instance details Defined in Amazonka.MediaLive.Types.StaticImageActivateScheduleActionSettings Methods readsPrec :: Int -> ReadS StaticImageActivateScheduleActionSettings # readList :: ReadS [StaticImageActivateScheduleActionSettings] # readPrec :: ReadPrec StaticImageActivateScheduleActionSettings # readListPrec :: ReadPrec [StaticImageActivateScheduleActionSettings] #
Show StaticImageActivateScheduleActionSettings Source #
Instance details Defined in Amazonka.MediaLive.Types.StaticImageActivateScheduleActionSettings Methods showsPrec :: Int -> StaticImageActivateScheduleActionSettings -> ShowS # show :: StaticImageActivateScheduleActionSettings -> String # showList :: [StaticImageActivateScheduleActionSettings] -> ShowS #
Generic StaticImageActivateScheduleActionSettings Source #
Instance details Defined in Amazonka.MediaLive.Types.StaticImageActivateScheduleActionSettings Associated Types type Rep StaticImageActivateScheduleActionSettings :: Type -> Type # Methods from :: StaticImageActivateScheduleActionSettings -> Rep StaticImageActivateScheduleActionSettings x # to :: Rep StaticImageActivateScheduleActionSettings x -> StaticImageActivateScheduleActionSettings #
NFData StaticImageActivateScheduleActionSettings Source #
Instance details Defined in Amazonka.MediaLive.Types.StaticImageActivateScheduleActionSettings Methods rnf :: StaticImageActivateScheduleActionSettings -> () #
Hashable StaticImageActivateScheduleActionSettings Source #
Instance details Defined in Amazonka.MediaLive.Types.StaticImageActivateScheduleActionSettings Methods hashWithSalt :: Int -> StaticImageActivateScheduleActionSettings -> Int # hash :: StaticImageActivateScheduleActionSettings -> Int #
ToJSON StaticImageActivateScheduleActionSettings Source #
Instance details Defined in Amazonka.MediaLive.Types.StaticImageActivateScheduleActionSettings Methods toJSON :: StaticImageActivateScheduleActionSettings -> Value # toEncoding :: StaticImageActivateScheduleActionSettings -> Encoding # toJSONList :: [StaticImageActivateScheduleActionSettings] -> Value # toEncodingList :: [StaticImageActivateScheduleActionSettings] -> Encoding #
FromJSON StaticImageActivateScheduleActionSettings Source #
Instance details Defined in Amazonka.MediaLive.Types.StaticImageActivateScheduleActionSettings Methods parseJSON :: Value -> Parser StaticImageActivateScheduleActionSettings # parseJSONList :: Value -> Parser [StaticImageActivateScheduleActionSettings] #
type Rep StaticImageActivateScheduleActionSettings Source #
Instance details Defined in Amazonka.MediaLive.Types.StaticImageActivateScheduleActionSettings type Rep StaticImageActivateScheduleActionSettings = D1 ('MetaData "StaticImageActivateScheduleActionSettings" "Amazonka.MediaLive.Types.StaticImageActivateScheduleActionSettings" "libZSservicesZSamazonka-medialiveZSamazonka-medialive" 'False) (C1 ('MetaCons "StaticImageActivateScheduleActionSettings'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "imageX") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "fadeOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "opacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :: ((S1 ('MetaSel ('Just "layer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "imageY") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "fadeIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "image") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputLocation))))))

newStaticImageActivateScheduleActionSettings Source #

Arguments

:: InputLocation	`$sel:image:StaticImageActivateScheduleActionSettings'`
-> StaticImageActivateScheduleActionSettings

Create a value of StaticImageActivateScheduleActionSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:imageX:StaticImageActivateScheduleActionSettings', staticImageActivateScheduleActionSettings_imageX - 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.

$sel:height:StaticImageActivateScheduleActionSettings', staticImageActivateScheduleActionSettings_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.

$sel:fadeOut:StaticImageActivateScheduleActionSettings', staticImageActivateScheduleActionSettings_fadeOut - 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).

$sel:width:StaticImageActivateScheduleActionSettings', staticImageActivateScheduleActionSettings_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.

$sel:opacity:StaticImageActivateScheduleActionSettings', staticImageActivateScheduleActionSettings_opacity - Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.

$sel:layer:StaticImageActivateScheduleActionSettings', staticImageActivateScheduleActionSettings_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.

$sel:duration:StaticImageActivateScheduleActionSettings', staticImageActivateScheduleActionSettings_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.

$sel:imageY:StaticImageActivateScheduleActionSettings', staticImageActivateScheduleActionSettings_imageY - 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.

$sel:fadeIn:StaticImageActivateScheduleActionSettings', staticImageActivateScheduleActionSettings_fadeIn - 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).

$sel:image:StaticImageActivateScheduleActionSettings', staticImageActivateScheduleActionSettings_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.

staticImageActivateScheduleActionSettings_imageX :: Lens' StaticImageActivateScheduleActionSettings (Maybe Natural) Source #

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.

staticImageActivateScheduleActionSettings_height :: Lens' StaticImageActivateScheduleActionSettings (Maybe Natural) Source #

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.

staticImageActivateScheduleActionSettings_fadeOut :: Lens' StaticImageActivateScheduleActionSettings (Maybe Natural) Source #

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

staticImageActivateScheduleActionSettings_width :: Lens' StaticImageActivateScheduleActionSettings (Maybe Natural) Source #

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.

staticImageActivateScheduleActionSettings_opacity :: Lens' StaticImageActivateScheduleActionSettings (Maybe Natural) Source #

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

staticImageActivateScheduleActionSettings_layer :: Lens' StaticImageActivateScheduleActionSettings (Maybe Natural) Source #

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.

staticImageActivateScheduleActionSettings_duration :: Lens' StaticImageActivateScheduleActionSettings (Maybe Natural) Source #

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.

staticImageActivateScheduleActionSettings_imageY :: Lens' StaticImageActivateScheduleActionSettings (Maybe Natural) Source #

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.

staticImageActivateScheduleActionSettings_fadeIn :: Lens' StaticImageActivateScheduleActionSettings (Maybe Natural) Source #

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

staticImageActivateScheduleActionSettings_image :: Lens' StaticImageActivateScheduleActionSettings InputLocation Source #

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.