software.amazon.awssdk.services.mediaconvert.model

Class TimecodeConfig

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.TimecodeConfig

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<TimecodeConfig.Builder,TimecodeConfig>

@Generated(value="software.amazon.awssdk:codegen")
public class TimecodeConfig
extends Object
implements StructuredPojo, ToCopyableBuilder<TimecodeConfig.Builder,TimecodeConfig>

Contains settings used to acquire and adjust timecode information from inputs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TimecodeConfig.Builder

Method Summary

Modifier and Type	Method and Description
String	anchor() If you use an editing platform that relies on an anchor timecode, use Anchor Timecode (Anchor) to specify a timecode that will match the input video frame to the output video frame.
static TimecodeConfig.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
static Class<? extends TimecodeConfig.Builder>	serializableBuilderClass()
TimecodeSource	source() Returns the value of the Source property for this object.
String	sourceAsString() Returns the value of the Source property for this object.
String	start() Only use when you set Timecode Source (TimecodeSource) to Specified Start (SPECIFIEDSTART).
String	timestampOffset() Only applies to outputs that support program-date-time stamp.
TimecodeConfig.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

anchor

public String anchor()

If you use an editing platform that relies on an anchor timecode, use Anchor Timecode (Anchor) to specify a timecode that will match the input video frame to the output video frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or (HH:MM:SS;FF). This setting ignores framerate conversion. System behavior for Anchor Timecode varies depending on your setting for Timecode source (TimecodeSource). * If Timecode source (TimecodeSource) is set to Specified Start (specifiedstart), the first input frame is the specified value in Start Timecode (Start). Anchor Timecode (Anchor) and Start Timecode (Start) are used calculate output timecode. * If Timecode source (TimecodeSource) is set to Start at 0 (zerobased) the first frame is 00:00:00:00. * If Timecode source (TimecodeSource) is set to Embedded (embedded), the first frame is the timecode value on the first input frame of the input.

Returns:

If you use an editing platform that relies on an anchor timecode, use Anchor Timecode (Anchor) to specify a timecode that will match the input video frame to the output video frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or (HH:MM:SS;FF). This setting ignores framerate conversion. System behavior for Anchor Timecode varies depending on your setting for Timecode source (TimecodeSource). * If Timecode source (TimecodeSource) is set to Specified Start (specifiedstart), the first input frame is the specified value in Start Timecode (Start). Anchor Timecode (Anchor) and Start Timecode (Start) are used calculate output timecode. * If Timecode source (TimecodeSource) is set to Start at 0 (zerobased) the first frame is 00:00:00:00. * If Timecode source (TimecodeSource) is set to Embedded (embedded), the first frame is the timecode value on the first input frame of the input.

source

public TimecodeSource source()

Returns the value of the Source property for this object.

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

Returns:

The value of the Source property for this object.

See Also:

TimecodeSource

sourceAsString

public String sourceAsString()

Returns the value of the Source property for this object.

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

Returns:

The value of the Source property for this object.

See Also:

TimecodeSource

start

public String start()

Only use when you set Timecode Source (TimecodeSource) to Specified Start (SPECIFIEDSTART). Use Start timecode (Start) to specify the timecode for the initial frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or (HH:MM:SS;FF).

Returns:

Only use when you set Timecode Source (TimecodeSource) to Specified Start (SPECIFIEDSTART). Use Start timecode (Start) to specify the timecode for the initial frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or (HH:MM:SS;FF).

timestampOffset

public String timestampOffset()

Only applies to outputs that support program-date-time stamp. Use Time stamp offset (TimestampOffset) to overwrite the timecode date without affecting the time and frame number. Provide the new date as a string in the format "yyyy-mm-dd". To use Time stamp offset, you must also enable Insert program-date-time (InsertProgramDateTime) in the output settings.

Returns:

Only applies to outputs that support program-date-time stamp. Use Time stamp offset (TimestampOffset) to overwrite the timecode date without affecting the time and frame number. Provide the new date as a string in the format "yyyy-mm-dd". To use Time stamp offset, you must also enable Insert program-date-time (InsertProgramDateTime) in the output settings.

toBuilder

public TimecodeConfig.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<TimecodeConfig.Builder,TimecodeConfig>

Returns:

a builder for type T

builder

public static TimecodeConfig.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.