software.amazon.awssdk.services.mediaconvert.model

Class FileSourceSettings

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.FileSourceSettings

All Implemented Interfaces:

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

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

If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FileSourceSettings.Builder

Method Summary

Modifier and Type	Method and Description
static FileSourceSettings.Builder	builder()
FileSourceConvert608To708	convert608To708() Specify whether this set of input captions appears in your outputs in both 608 and 708 format.
String	convert608To708AsString() Specify whether this set of input captions appears in your outputs in both 608 and 708 format.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
CaptionSourceFramerate	framerate() Ignore this setting unless your input captions format is SCC.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends FileSourceSettings.Builder>	serializableBuilderClass()
String	sourceFile() External caption file used for loading captions.
Integer	timeDelta() Specifies a time delta in seconds to offset the captions from the source file.
FileSourceSettings.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

convert608To708

public final FileSourceConvert608To708 convert608To708()

Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.

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

Returns:

Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.

See Also:

FileSourceConvert608To708

convert608To708AsString

public final String convert608To708AsString()

Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.

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

Returns:

Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.

See Also:

FileSourceConvert608To708

framerate

public final CaptionSourceFramerate framerate()

Ignore this setting unless your input captions format is SCC. To have the service compensate for differing frame rates between your input captions and input video, specify the frame rate of the captions file. Specify this value as a fraction, using the settings Framerate numerator (framerateNumerator) and Framerate denominator (framerateDenominator). For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps.

Returns:

Ignore this setting unless your input captions format is SCC. To have the service compensate for differing frame rates between your input captions and input video, specify the frame rate of the captions file. Specify this value as a fraction, using the settings Framerate numerator (framerateNumerator) and Framerate denominator (framerateDenominator). For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps.

sourceFile

public final String sourceFile()

External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl', 'srt', 'xml', 'smi', and 'vtt'.

Returns:

External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl', 'srt', 'xml', 'smi', and 'vtt'.

timeDelta

public final Integer timeDelta()

Specifies a time delta in seconds to offset the captions from the source file.

Returns:

Specifies a time delta in seconds to offset the captions from the source file.

toBuilder

public FileSourceSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FileSourceSettings.Builder,FileSourceSettings>

builder

public static FileSourceSettings.Builder builder()

serializableBuilderClass

public static Class<? extends FileSourceSettings.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