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.IVS.Types.ThumbnailConfiguration

Description

Documentation

data ThumbnailConfiguration Source #

An object representing a configuration of thumbnails for recorded video.

See: newThumbnailConfiguration smart constructor.

Constructors

ThumbnailConfiguration'

Fields

recordingMode :: Maybe RecordingMode
Thumbnail recording mode. Default: INTERVAL.
targetIntervalSeconds :: Maybe Natural
The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.
Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

Instances

Instances details

FromJSON ThumbnailConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.ThumbnailConfiguration Methods parseJSON :: Value -> Parser ThumbnailConfiguration # parseJSONList :: Value -> Parser [ThumbnailConfiguration] #
ToJSON ThumbnailConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.ThumbnailConfiguration Methods toJSON :: ThumbnailConfiguration -> Value # toEncoding :: ThumbnailConfiguration -> Encoding # toJSONList :: [ThumbnailConfiguration] -> Value # toEncodingList :: [ThumbnailConfiguration] -> Encoding #
Generic ThumbnailConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.ThumbnailConfiguration Associated Types type Rep ThumbnailConfiguration :: Type -> Type # Methods from :: ThumbnailConfiguration -> Rep ThumbnailConfiguration x # to :: Rep ThumbnailConfiguration x -> ThumbnailConfiguration #
Read ThumbnailConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.ThumbnailConfiguration Methods readsPrec :: Int -> ReadS ThumbnailConfiguration # readList :: ReadS [ThumbnailConfiguration] # readPrec :: ReadPrec ThumbnailConfiguration # readListPrec :: ReadPrec [ThumbnailConfiguration] #
Show ThumbnailConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.ThumbnailConfiguration Methods showsPrec :: Int -> ThumbnailConfiguration -> ShowS # show :: ThumbnailConfiguration -> String # showList :: [ThumbnailConfiguration] -> ShowS #
NFData ThumbnailConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.ThumbnailConfiguration Methods rnf :: ThumbnailConfiguration -> () #
Eq ThumbnailConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.ThumbnailConfiguration Methods (==) :: ThumbnailConfiguration -> ThumbnailConfiguration -> Bool # (/=) :: ThumbnailConfiguration -> ThumbnailConfiguration -> Bool #
Hashable ThumbnailConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.ThumbnailConfiguration Methods hashWithSalt :: Int -> ThumbnailConfiguration -> Int # hash :: ThumbnailConfiguration -> Int #
type Rep ThumbnailConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.ThumbnailConfiguration type Rep ThumbnailConfiguration = D1 ('MetaData "ThumbnailConfiguration" "Amazonka.IVS.Types.ThumbnailConfiguration" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "ThumbnailConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "recordingMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecordingMode)) :*: S1 ('MetaSel ('Just "targetIntervalSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))

newThumbnailConfiguration :: ThumbnailConfiguration Source #

Create a value of ThumbnailConfiguration 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:recordingMode:ThumbnailConfiguration', thumbnailConfiguration_recordingMode - Thumbnail recording mode. Default: INTERVAL.

$sel:targetIntervalSeconds:ThumbnailConfiguration', thumbnailConfiguration_targetIntervalSeconds - The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

thumbnailConfiguration_recordingMode :: Lens' ThumbnailConfiguration (Maybe RecordingMode) Source #

Thumbnail recording mode. Default: INTERVAL.

thumbnailConfiguration_targetIntervalSeconds :: Lens' ThumbnailConfiguration (Maybe Natural) Source #

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.