libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MediaConvert.Types.FrameCaptureSettings

Description

 
Synopsis

Documentation

data FrameCaptureSettings Source #

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

See: newFrameCaptureSettings smart constructor.

Constructors

FrameCaptureSettings' 

Fields

  • quality :: Maybe Natural

    JPEG Quality - a higher value equals higher quality.

  • 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.

  • maxCaptures :: Maybe Natural

    Maximum number of captures (encoded jpg output files).

  • 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.

Instances

Instances details
Eq FrameCaptureSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.FrameCaptureSettings

Read FrameCaptureSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.FrameCaptureSettings

Show FrameCaptureSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.FrameCaptureSettings

Generic FrameCaptureSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.FrameCaptureSettings

Associated Types

type Rep FrameCaptureSettings :: Type -> Type #

NFData FrameCaptureSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.FrameCaptureSettings

Methods

rnf :: FrameCaptureSettings -> () #

Hashable FrameCaptureSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.FrameCaptureSettings

ToJSON FrameCaptureSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.FrameCaptureSettings

FromJSON FrameCaptureSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.FrameCaptureSettings

type Rep FrameCaptureSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.FrameCaptureSettings

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

newFrameCaptureSettings :: FrameCaptureSettings Source #

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:quality:FrameCaptureSettings', frameCaptureSettings_quality - JPEG Quality - a higher value equals higher quality.

$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:maxCaptures:FrameCaptureSettings', frameCaptureSettings_maxCaptures - Maximum number of captures (encoded jpg output files).

$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.

frameCaptureSettings_quality :: Lens' FrameCaptureSettings (Maybe Natural) Source #

JPEG Quality - a higher value equals higher quality.

frameCaptureSettings_framerateDenominator :: Lens' FrameCaptureSettings (Maybe Natural) Source #

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_maxCaptures :: Lens' FrameCaptureSettings (Maybe Natural) Source #

Maximum number of captures (encoded jpg output files).

frameCaptureSettings_framerateNumerator :: Lens' FrameCaptureSettings (Maybe Natural) Source #

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.