AWS SDK for C++  1.9.67
AWS SDK for C++
Public Member Functions | List of all members
Aws::MediaConvert::Model::FrameCaptureSettings Class Reference

#include <FrameCaptureSettings.h>

Public Member Functions

 FrameCaptureSettings ()
 
 FrameCaptureSettings (Aws::Utils::Json::JsonView jsonValue)
 
FrameCaptureSettingsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetFramerateDenominator () const
 
bool FramerateDenominatorHasBeenSet () const
 
void SetFramerateDenominator (int value)
 
FrameCaptureSettingsWithFramerateDenominator (int value)
 
int GetFramerateNumerator () const
 
bool FramerateNumeratorHasBeenSet () const
 
void SetFramerateNumerator (int value)
 
FrameCaptureSettingsWithFramerateNumerator (int value)
 
int GetMaxCaptures () const
 
bool MaxCapturesHasBeenSet () const
 
void SetMaxCaptures (int value)
 
FrameCaptureSettingsWithMaxCaptures (int value)
 
int GetQuality () const
 
bool QualityHasBeenSet () const
 
void SetQuality (int value)
 
FrameCaptureSettingsWithQuality (int value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 30 of file FrameCaptureSettings.h.

Constructor & Destructor Documentation

◆ FrameCaptureSettings() [1/2]

Aws::MediaConvert::Model::FrameCaptureSettings::FrameCaptureSettings ( )

◆ FrameCaptureSettings() [2/2]

Aws::MediaConvert::Model::FrameCaptureSettings::FrameCaptureSettings ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ FramerateDenominatorHasBeenSet()

bool Aws::MediaConvert::Model::FrameCaptureSettings::FramerateDenominatorHasBeenSet ( ) const
inline

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.

Definition at line 55 of file FrameCaptureSettings.h.

◆ FramerateNumeratorHasBeenSet()

bool Aws::MediaConvert::Model::FrameCaptureSettings::FramerateNumeratorHasBeenSet ( ) const
inline

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.

Definition at line 94 of file FrameCaptureSettings.h.

◆ GetFramerateDenominator()

int Aws::MediaConvert::Model::FrameCaptureSettings::GetFramerateDenominator ( ) const
inline

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.

Definition at line 46 of file FrameCaptureSettings.h.

◆ GetFramerateNumerator()

int Aws::MediaConvert::Model::FrameCaptureSettings::GetFramerateNumerator ( ) const
inline

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.

Definition at line 84 of file FrameCaptureSettings.h.

◆ GetMaxCaptures()

int Aws::MediaConvert::Model::FrameCaptureSettings::GetMaxCaptures ( ) const
inline

Maximum number of captures (encoded jpg output files).

Definition at line 120 of file FrameCaptureSettings.h.

◆ GetQuality()

int Aws::MediaConvert::Model::FrameCaptureSettings::GetQuality ( ) const
inline

JPEG Quality - a higher value equals higher quality.

Definition at line 141 of file FrameCaptureSettings.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::MediaConvert::Model::FrameCaptureSettings::Jsonize ( ) const

◆ MaxCapturesHasBeenSet()

bool Aws::MediaConvert::Model::FrameCaptureSettings::MaxCapturesHasBeenSet ( ) const
inline

Maximum number of captures (encoded jpg output files).

Definition at line 125 of file FrameCaptureSettings.h.

◆ operator=()

FrameCaptureSettings& Aws::MediaConvert::Model::FrameCaptureSettings::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ QualityHasBeenSet()

bool Aws::MediaConvert::Model::FrameCaptureSettings::QualityHasBeenSet ( ) const
inline

JPEG Quality - a higher value equals higher quality.

Definition at line 146 of file FrameCaptureSettings.h.

◆ SetFramerateDenominator()

void Aws::MediaConvert::Model::FrameCaptureSettings::SetFramerateDenominator ( int  value)
inline

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.

Definition at line 64 of file FrameCaptureSettings.h.

◆ SetFramerateNumerator()

void Aws::MediaConvert::Model::FrameCaptureSettings::SetFramerateNumerator ( int  value)
inline

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.

Definition at line 104 of file FrameCaptureSettings.h.

◆ SetMaxCaptures()

void Aws::MediaConvert::Model::FrameCaptureSettings::SetMaxCaptures ( int  value)
inline

Maximum number of captures (encoded jpg output files).

Definition at line 130 of file FrameCaptureSettings.h.

◆ SetQuality()

void Aws::MediaConvert::Model::FrameCaptureSettings::SetQuality ( int  value)
inline

JPEG Quality - a higher value equals higher quality.

Definition at line 151 of file FrameCaptureSettings.h.

◆ WithFramerateDenominator()

FrameCaptureSettings& Aws::MediaConvert::Model::FrameCaptureSettings::WithFramerateDenominator ( int  value)
inline

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.

Definition at line 73 of file FrameCaptureSettings.h.

◆ WithFramerateNumerator()

FrameCaptureSettings& Aws::MediaConvert::Model::FrameCaptureSettings::WithFramerateNumerator ( int  value)
inline

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.

Definition at line 114 of file FrameCaptureSettings.h.

◆ WithMaxCaptures()

FrameCaptureSettings& Aws::MediaConvert::Model::FrameCaptureSettings::WithMaxCaptures ( int  value)
inline

Maximum number of captures (encoded jpg output files).

Definition at line 135 of file FrameCaptureSettings.h.

◆ WithQuality()

FrameCaptureSettings& Aws::MediaConvert::Model::FrameCaptureSettings::WithQuality ( int  value)
inline

JPEG Quality - a higher value equals higher quality.

Definition at line 156 of file FrameCaptureSettings.h.


The documentation for this class was generated from the following file: