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.KinesisVideoArchivedMedia.Types.Image

Description

Synopsis

data Image = Image' {
- error :: Maybe ImageError
- imageContent :: Maybe Text
- timeStamp :: Maybe POSIX
}
newImage :: Image
image_error :: Lens' Image (Maybe ImageError)
image_imageContent :: Lens' Image (Maybe Text)
image_timeStamp :: Lens' Image (Maybe UTCTime)

Documentation

data Image Source #

A structure that contains the Timestamp, Error, and ImageContent.

See: newImage smart constructor.

Constructors

Image'

Fields

error :: Maybe ImageError
The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:
- There is no media that exists for the specified Timestamp.
- The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.
imageContent :: Maybe Text
An attribute of the Image object that is Base64 encoded.
timeStamp :: Maybe POSIX
An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.

Instances

Instances details

FromJSON Image Source #
Instance details Defined in Amazonka.KinesisVideoArchivedMedia.Types.Image Methods parseJSON :: Value -> Parser Image # parseJSONList :: Value -> Parser [Image] #
Generic Image Source #
Instance details Defined in Amazonka.KinesisVideoArchivedMedia.Types.Image Associated Types type Rep Image :: Type -> Type # Methods from :: Image -> Rep Image x # to :: Rep Image x -> Image #
Read Image Source #
Instance details Defined in Amazonka.KinesisVideoArchivedMedia.Types.Image Methods readsPrec :: Int -> ReadS Image # readList :: ReadS [Image] # readPrec :: ReadPrec Image # readListPrec :: ReadPrec [Image] #
Show Image Source #
Instance details Defined in Amazonka.KinesisVideoArchivedMedia.Types.Image Methods showsPrec :: Int -> Image -> ShowS # show :: Image -> String # showList :: [Image] -> ShowS #
NFData Image Source #
Instance details Defined in Amazonka.KinesisVideoArchivedMedia.Types.Image Methods rnf :: Image -> () #
Eq Image Source #
Instance details Defined in Amazonka.KinesisVideoArchivedMedia.Types.Image Methods (==) :: Image -> Image -> Bool # (/=) :: Image -> Image -> Bool #
Hashable Image Source #
Instance details Defined in Amazonka.KinesisVideoArchivedMedia.Types.Image Methods hashWithSalt :: Int -> Image -> Int # hash :: Image -> Int #
type Rep Image Source #
Instance details Defined in Amazonka.KinesisVideoArchivedMedia.Types.Image type Rep Image = D1 ('MetaData "Image" "Amazonka.KinesisVideoArchivedMedia.Types.Image" "amazonka-kinesis-video-archived-media-2.0-ByMPs2ZAQOi357CZJGqXlN" 'False) (C1 ('MetaCons "Image'" 'PrefixI 'True) (S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageError)) :: (S1 ('MetaSel ('Just "imageContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "timeStamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))

newImage :: Image Source #

Create a value of Image 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:error:Image', image_error - The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

There is no media that exists for the specified Timestamp.
The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

$sel:imageContent:Image', image_imageContent - An attribute of the Image object that is Base64 encoded.

$sel:timeStamp:Image', image_timeStamp - An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.

image_error :: Lens' Image (Maybe ImageError) Source #

The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

There is no media that exists for the specified Timestamp.
The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

image_imageContent :: Lens' Image (Maybe Text) Source #

An attribute of the Image object that is Base64 encoded.

image_timeStamp :: Lens' Image (Maybe UTCTime) Source #

An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.