Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.KinesisVideo.Types.ImageGenerationConfiguration

Description

Synopsis

Documentation

data ImageGenerationConfiguration Source #

The structure that contains the information required for the KVS images delivery. If null, the configuration will be deleted from the stream.

See: newImageGenerationConfiguration smart constructor.

Constructors

ImageGenerationConfiguration'

Fields

formatConfig :: Maybe (HashMap FormatConfigKey Text)
The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.
heightPixels :: Maybe Natural
The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.
widthPixels :: Maybe Natural
The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided, its original aspect ratio will be used to calculate the HeightPixels ratio. If neither parameter is provided, the original image size will be returned.
status :: ConfigurationStatus
Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.
imageSelectorType :: ImageSelectorType
The origin of the Server or Producer timestamps to use to generate the images.
destinationConfig :: ImageGenerationDestinationConfig
The structure that contains the information required to deliver images to a customer.
samplingInterval :: Natural
The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 33 ms, because a camera that generates content at 30 FPS would create a frame every 33.3 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.
format :: Format
The accepted image format.

Instances

Instances details

FromJSON ImageGenerationConfiguration Source #
Instance details Defined in Amazonka.KinesisVideo.Types.ImageGenerationConfiguration Methods parseJSON :: Value -> Parser ImageGenerationConfiguration # parseJSONList :: Value -> Parser [ImageGenerationConfiguration] #
ToJSON ImageGenerationConfiguration Source #
Instance details Defined in Amazonka.KinesisVideo.Types.ImageGenerationConfiguration Methods toJSON :: ImageGenerationConfiguration -> Value # toEncoding :: ImageGenerationConfiguration -> Encoding # toJSONList :: [ImageGenerationConfiguration] -> Value # toEncodingList :: [ImageGenerationConfiguration] -> Encoding #
Generic ImageGenerationConfiguration Source #
Instance details Defined in Amazonka.KinesisVideo.Types.ImageGenerationConfiguration Associated Types type Rep ImageGenerationConfiguration :: Type -> Type # Methods from :: ImageGenerationConfiguration -> Rep ImageGenerationConfiguration x # to :: Rep ImageGenerationConfiguration x -> ImageGenerationConfiguration #
Read ImageGenerationConfiguration Source #
Instance details Defined in Amazonka.KinesisVideo.Types.ImageGenerationConfiguration Methods readsPrec :: Int -> ReadS ImageGenerationConfiguration # readList :: ReadS [ImageGenerationConfiguration] # readPrec :: ReadPrec ImageGenerationConfiguration # readListPrec :: ReadPrec [ImageGenerationConfiguration] #
Show ImageGenerationConfiguration Source #
Instance details Defined in Amazonka.KinesisVideo.Types.ImageGenerationConfiguration Methods showsPrec :: Int -> ImageGenerationConfiguration -> ShowS # show :: ImageGenerationConfiguration -> String # showList :: [ImageGenerationConfiguration] -> ShowS #
NFData ImageGenerationConfiguration Source #
Instance details Defined in Amazonka.KinesisVideo.Types.ImageGenerationConfiguration Methods rnf :: ImageGenerationConfiguration -> () #
Eq ImageGenerationConfiguration Source #
Instance details Defined in Amazonka.KinesisVideo.Types.ImageGenerationConfiguration Methods (==) :: ImageGenerationConfiguration -> ImageGenerationConfiguration -> Bool # (/=) :: ImageGenerationConfiguration -> ImageGenerationConfiguration -> Bool #
Hashable ImageGenerationConfiguration Source #
Instance details Defined in Amazonka.KinesisVideo.Types.ImageGenerationConfiguration Methods hashWithSalt :: Int -> ImageGenerationConfiguration -> Int # hash :: ImageGenerationConfiguration -> Int #
type Rep ImageGenerationConfiguration Source #
Instance details Defined in Amazonka.KinesisVideo.Types.ImageGenerationConfiguration type Rep ImageGenerationConfiguration = D1 ('MetaData "ImageGenerationConfiguration" "Amazonka.KinesisVideo.Types.ImageGenerationConfiguration" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "ImageGenerationConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "formatConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap FormatConfigKey Text))) :: S1 ('MetaSel ('Just "heightPixels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "widthPixels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConfigurationStatus))) :: ((S1 ('MetaSel ('Just "imageSelectorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ImageSelectorType) :: S1 ('MetaSel ('Just "destinationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ImageGenerationDestinationConfig)) :: (S1 ('MetaSel ('Just "samplingInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Format)))))

newImageGenerationConfiguration Source #

Arguments

:: ConfigurationStatus	`$sel:status:ImageGenerationConfiguration'`
-> ImageSelectorType	`$sel:imageSelectorType:ImageGenerationConfiguration'`
-> ImageGenerationDestinationConfig	`$sel:destinationConfig:ImageGenerationConfiguration'`
-> Natural	`$sel:samplingInterval:ImageGenerationConfiguration'`
-> Format	`$sel:format:ImageGenerationConfiguration'`
-> ImageGenerationConfiguration

Create a value of ImageGenerationConfiguration 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:formatConfig:ImageGenerationConfiguration', imageGenerationConfiguration_formatConfig - The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

$sel:heightPixels:ImageGenerationConfiguration', imageGenerationConfiguration_heightPixels - The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

$sel:widthPixels:ImageGenerationConfiguration', imageGenerationConfiguration_widthPixels - The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided, its original aspect ratio will be used to calculate the HeightPixels ratio. If neither parameter is provided, the original image size will be returned.

$sel:status:ImageGenerationConfiguration', imageGenerationConfiguration_status - Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

$sel:imageSelectorType:ImageGenerationConfiguration', imageGenerationConfiguration_imageSelectorType - The origin of the Server or Producer timestamps to use to generate the images.

$sel:destinationConfig:ImageGenerationConfiguration', imageGenerationConfiguration_destinationConfig - The structure that contains the information required to deliver images to a customer.

$sel:samplingInterval:ImageGenerationConfiguration', imageGenerationConfiguration_samplingInterval - The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 33 ms, because a camera that generates content at 30 FPS would create a frame every 33.3 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

$sel:format:ImageGenerationConfiguration', imageGenerationConfiguration_format - The accepted image format.

imageGenerationConfiguration_formatConfig :: Lens' ImageGenerationConfiguration (Maybe (HashMap FormatConfigKey Text)) Source #

The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

imageGenerationConfiguration_heightPixels :: Lens' ImageGenerationConfiguration (Maybe Natural) Source #

The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

imageGenerationConfiguration_widthPixels :: Lens' ImageGenerationConfiguration (Maybe Natural) Source #

The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided, its original aspect ratio will be used to calculate the HeightPixels ratio. If neither parameter is provided, the original image size will be returned.

imageGenerationConfiguration_status :: Lens' ImageGenerationConfiguration ConfigurationStatus Source #

Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

imageGenerationConfiguration_imageSelectorType :: Lens' ImageGenerationConfiguration ImageSelectorType Source #

The origin of the Server or Producer timestamps to use to generate the images.

imageGenerationConfiguration_destinationConfig :: Lens' ImageGenerationConfiguration ImageGenerationDestinationConfig Source #

The structure that contains the information required to deliver images to a customer.

imageGenerationConfiguration_samplingInterval :: Lens' ImageGenerationConfiguration Natural Source #

The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 33 ms, because a camera that generates content at 30 FPS would create a frame every 33.3 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

imageGenerationConfiguration_format :: Lens' ImageGenerationConfiguration Format Source #

The accepted image format.