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 |
Synopsis
- data ImageGenerationConfiguration = ImageGenerationConfiguration' {}
- newImageGenerationConfiguration :: ConfigurationStatus -> ImageSelectorType -> ImageGenerationDestinationConfig -> Natural -> Format -> ImageGenerationConfiguration
- imageGenerationConfiguration_formatConfig :: Lens' ImageGenerationConfiguration (Maybe (HashMap FormatConfigKey Text))
- imageGenerationConfiguration_heightPixels :: Lens' ImageGenerationConfiguration (Maybe Natural)
- imageGenerationConfiguration_widthPixels :: Lens' ImageGenerationConfiguration (Maybe Natural)
- imageGenerationConfiguration_status :: Lens' ImageGenerationConfiguration ConfigurationStatus
- imageGenerationConfiguration_imageSelectorType :: Lens' ImageGenerationConfiguration ImageSelectorType
- imageGenerationConfiguration_destinationConfig :: Lens' ImageGenerationConfiguration ImageGenerationDestinationConfig
- imageGenerationConfiguration_samplingInterval :: Lens' ImageGenerationConfiguration Natural
- imageGenerationConfiguration_format :: Lens' ImageGenerationConfiguration Format
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.
ImageGenerationConfiguration' | |
|
Instances
newImageGenerationConfiguration Source #
:: ConfigurationStatus | |
-> ImageSelectorType | |
-> ImageGenerationDestinationConfig | |
-> Natural | |
-> Format | |
-> 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.