software.amazon.awssdk.services.mediaconvert.model

Class FrameCaptureSettings

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.FrameCaptureSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FrameCaptureSettings.Builder,FrameCaptureSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class FrameCaptureSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FrameCaptureSettings.Builder,FrameCaptureSettings>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FrameCaptureSettings.Builder

Method Summary

Modifier and Type	Method and Description
static FrameCaptureSettings.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	framerateDenominator() Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds.
Integer	framerateNumerator() Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxCaptures() Maximum number of captures (encoded jpg output files).
Integer	quality() JPEG Quality - a higher value equals higher quality.
List<SdkField<?>>	sdkFields()
static Class<? extends FrameCaptureSettings.Builder>	serializableBuilderClass()
FrameCaptureSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

framerateDenominator

public final Integer 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.

Returns:

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

public final Integer 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.

Returns:

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

public final Integer maxCaptures()

Maximum number of captures (encoded jpg output files).

Returns:

Maximum number of captures (encoded jpg output files).

quality

public final Integer quality()

JPEG Quality - a higher value equals higher quality.

Returns:

JPEG Quality - a higher value equals higher quality.

toBuilder

public FrameCaptureSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FrameCaptureSettings.Builder,FrameCaptureSettings>

builder

public static FrameCaptureSettings.Builder builder()

serializableBuilderClass

public static Class<? extends FrameCaptureSettings.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo