Package software.amazon.awssdk.services.medialive.model

Class FrameCaptureSettings

java.lang.Object

software.amazon.awssdk.services.medialive.model.FrameCaptureSettings

All Implemented Interfaces:

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

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

Frame Capture Settings

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FrameCaptureSettings.Builder

Method Summary

Modifier and Type	Method	Description
static FrameCaptureSettings.Builder	builder()
Integer	captureInterval()	The frequency at which to capture frames for inclusion in the output.
FrameCaptureIntervalUnit	captureIntervalUnits()	Unit for the frame capture interval.
String	captureIntervalUnitsAsString()	Unit for the frame capture interval.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends FrameCaptureSettings.Builder>	serializableBuilderClass()
TimecodeBurninSettings	timecodeBurninSettings()	Timecode burn-in settings
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

captureInterval

public final Integer captureInterval()

The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits.

Returns:

The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits.

captureIntervalUnits

public final FrameCaptureIntervalUnit captureIntervalUnits()

Unit for the frame capture interval.

If the service returns an enum value that is not available in the current SDK version, captureIntervalUnits will return FrameCaptureIntervalUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from captureIntervalUnitsAsString().

Returns:

Unit for the frame capture interval.

See Also:

FrameCaptureIntervalUnit

captureIntervalUnitsAsString

public final String captureIntervalUnitsAsString()

Unit for the frame capture interval.

If the service returns an enum value that is not available in the current SDK version, captureIntervalUnits will return FrameCaptureIntervalUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from captureIntervalUnitsAsString().

Returns:

Unit for the frame capture interval.

See Also:

FrameCaptureIntervalUnit

timecodeBurninSettings

public final TimecodeBurninSettings timecodeBurninSettings()

Timecode burn-in settings

Returns:

Timecode burn-in settings

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