Amazonka.MediaConvert.Types.FrameCaptureSettings

Documentation

data FrameCaptureSettings

Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE.

See: newFrameCaptureSettings smart constructor.

Constructors

FrameCaptureSettings'

Fields

• framerateDenominator :: Maybe Natural

  Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.

• framerateNumerator :: Maybe Natural

  Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.

• maxCaptures :: Maybe Natural

  Maximum number of captures (encoded jpg output files).

• quality :: Maybe Natural

  JPEG Quality - a higher value equals higher quality.

Instances

FromJSON FrameCaptureSettings

Defined in Amazonka.MediaConvert.Types.FrameCaptureSettings

Methods

parseJSON :: Value -> Parser FrameCaptureSettings

parseJSONList :: Value -> Parser [FrameCaptureSettings]

ToJSON FrameCaptureSettings

Defined in Amazonka.MediaConvert.Types.FrameCaptureSettings

Methods

toJSON :: FrameCaptureSettings -> Value

toEncoding :: FrameCaptureSettings -> Encoding

toJSONList :: [FrameCaptureSettings] -> Value

toEncodingList :: [FrameCaptureSettings] -> Encoding

Generic FrameCaptureSettings

Defined in Amazonka.MediaConvert.Types.FrameCaptureSettings

Associated Types

type Rep FrameCaptureSettings :: Type -> Type

Methods

from :: FrameCaptureSettings -> Rep FrameCaptureSettings x

to :: Rep FrameCaptureSettings x -> FrameCaptureSettings

Read FrameCaptureSettings

Defined in Amazonka.MediaConvert.Types.FrameCaptureSettings

Methods

readsPrec :: Int -> ReadS FrameCaptureSettings

readList :: ReadS [FrameCaptureSettings]

readPrec :: ReadPrec FrameCaptureSettings

readListPrec :: ReadPrec [FrameCaptureSettings]

Show FrameCaptureSettings

Defined in Amazonka.MediaConvert.Types.FrameCaptureSettings

Methods

showsPrec :: Int -> FrameCaptureSettings -> ShowS

show :: FrameCaptureSettings -> String

showList :: [FrameCaptureSettings] -> ShowS

NFData FrameCaptureSettings

Defined in Amazonka.MediaConvert.Types.FrameCaptureSettings

Methods

rnf :: FrameCaptureSettings -> ()

Eq FrameCaptureSettings

Defined in Amazonka.MediaConvert.Types.FrameCaptureSettings

Methods

(==) :: FrameCaptureSettings -> FrameCaptureSettings -> Bool

(/=) :: FrameCaptureSettings -> FrameCaptureSettings -> Bool

Hashable FrameCaptureSettings

Defined in Amazonka.MediaConvert.Types.FrameCaptureSettings

Methods

hashWithSalt :: Int -> FrameCaptureSettings -> Int

hash :: FrameCaptureSettings -> Int

type Rep FrameCaptureSettings

Defined in Amazonka.MediaConvert.Types.FrameCaptureSettings

type Rep FrameCaptureSettings = D1 ('MetaData "FrameCaptureSettings" "Amazonka.MediaConvert.Types.FrameCaptureSettings" "amazonka-mediaconvert-2.0-ClG8xHhlx4y6bdaCrZchqH" 'False) (C1 ('MetaCons "FrameCaptureSettings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "framerateDenominator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "framerateNumerator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "maxCaptures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "quality") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))

newFrameCaptureSettings :: FrameCaptureSettings

Create a value of FrameCaptureSettings 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:framerateDenominator:FrameCaptureSettings', frameCaptureSettings_framerateDenominator - Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.

$sel:framerateNumerator:FrameCaptureSettings', frameCaptureSettings_framerateNumerator - Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.

$sel:maxCaptures:FrameCaptureSettings', frameCaptureSettings_maxCaptures - Maximum number of captures (encoded jpg output files).

$sel:quality:FrameCaptureSettings', frameCaptureSettings_quality - JPEG Quality - a higher value equals higher quality.

frameCaptureSettings_framerateDenominator :: Lens' FrameCaptureSettings (Maybe Natural)

Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.

frameCaptureSettings_framerateNumerator :: Lens' FrameCaptureSettings (Maybe Natural)

Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.

frameCaptureSettings_maxCaptures :: Lens' FrameCaptureSettings (Maybe Natural)

Maximum number of captures (encoded jpg output files).

frameCaptureSettings_quality :: Lens' FrameCaptureSettings (Maybe Natural)

JPEG Quality - a higher value equals higher quality.