You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::MediaConvert::Types::FrameCaptureSettings

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing FrameCaptureSettings as input to an Aws::Client method, you can use a vanilla Hash:

{
  framerate_denominator: 1,
  framerate_numerator: 1,
  max_captures: 1,
  quality: 1,
}

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#framerate_denominator ⇒ Integer

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.

Returns:

  • (Integer) —

    Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds.

#framerate_numerator ⇒ Integer

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.

Returns:

  • (Integer) —

    Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds.

#max_captures ⇒ Integer

Maximum number of captures (encoded jpg output files).

Returns:

  • (Integer) —

    Maximum number of captures (encoded jpg output files).

#quality ⇒ Integer

JPEG Quality - a higher value equals higher quality.

Returns:

  • (Integer) —

    JPEG Quality - a higher value equals higher quality.