software.amazon.awssdk.services.mediaconvert.model

Interface FileSourceSettings.Builder

All Superinterfaces:

Buildable, CopyableBuilder<FileSourceSettings.Builder,FileSourceSettings>, SdkBuilder<FileSourceSettings.Builder,FileSourceSettings>, SdkPojo

Enclosing class:

FileSourceSettings

public static interface FileSourceSettings.Builder
extends SdkPojo, CopyableBuilder<FileSourceSettings.Builder,FileSourceSettings>

Method Summary

Modifier and Type	Method and Description
FileSourceSettings.Builder	convert608To708(FileSourceConvert608To708 convert608To708) Specify whether this set of input captions appears in your outputs in both 608 and 708 format.
FileSourceSettings.Builder	convert608To708(String convert608To708) Specify whether this set of input captions appears in your outputs in both 608 and 708 format.
FileSourceSettings.Builder	convertPaintToPop(CaptionSourceConvertPaintOnToPopOn convertPaintToPop) Choose the presentation style of your input SCC captions.
FileSourceSettings.Builder	convertPaintToPop(String convertPaintToPop) Choose the presentation style of your input SCC captions.
FileSourceSettings.Builder	framerate(CaptionSourceFramerate framerate) Ignore this setting unless your input captions format is SCC.
default FileSourceSettings.Builder	framerate(Consumer<CaptionSourceFramerate.Builder> framerate) Ignore this setting unless your input captions format is SCC.
FileSourceSettings.Builder	sourceFile(String sourceFile) External caption file used for loading captions.
FileSourceSettings.Builder	timeDelta(Integer timeDelta) Optional.
FileSourceSettings.Builder	timeDeltaUnits(FileSourceTimeDeltaUnits timeDeltaUnits) When you use the setting Time delta to adjust the sync between your sidecar captions and your video, use this setting to specify the units for the delta that you specify.
FileSourceSettings.Builder	timeDeltaUnits(String timeDeltaUnits) When you use the setting Time delta to adjust the sync between your sidecar captions and your video, use this setting to specify the units for the delta that you specify.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

convert608To708

FileSourceSettings.Builder convert608To708(String convert608To708)

Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose 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.

Parameters:

convert608To708 - Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FileSourceConvert608To708, FileSourceConvert608To708

convert608To708

FileSourceSettings.Builder convert608To708(FileSourceConvert608To708 convert608To708)

Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose 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.

Parameters:

convert608To708 - Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FileSourceConvert608To708, FileSourceConvert608To708

convertPaintToPop

FileSourceSettings.Builder convertPaintToPop(String convertPaintToPop)

Choose the presentation style of your input SCC captions. To use the same presentation style as your input: Keep the default value, Disabled. To convert paint-on captions to pop-on: Choose Enabled. We also recommend that you choose Enabled if you notice additional repeated lines in your output captions.

Parameters:

convertPaintToPop - Choose the presentation style of your input SCC captions. To use the same presentation style as your input: Keep the default value, Disabled. To convert paint-on captions to pop-on: Choose Enabled. We also recommend that you choose Enabled if you notice additional repeated lines in your output captions.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CaptionSourceConvertPaintOnToPopOn, CaptionSourceConvertPaintOnToPopOn

convertPaintToPop

FileSourceSettings.Builder convertPaintToPop(CaptionSourceConvertPaintOnToPopOn convertPaintToPop)

Choose the presentation style of your input SCC captions. To use the same presentation style as your input: Keep the default value, Disabled. To convert paint-on captions to pop-on: Choose Enabled. We also recommend that you choose Enabled if you notice additional repeated lines in your output captions.

Parameters:

convertPaintToPop - Choose the presentation style of your input SCC captions. To use the same presentation style as your input: Keep the default value, Disabled. To convert paint-on captions to pop-on: Choose Enabled. We also recommend that you choose Enabled if you notice additional repeated lines in your output captions.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CaptionSourceConvertPaintOnToPopOn, CaptionSourceConvertPaintOnToPopOn

framerate

FileSourceSettings.Builder framerate(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. 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.

Parameters:

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. 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:

Returns a reference to this object so that method calls can be chained together.

framerate

default FileSourceSettings.Builder framerate(Consumer<CaptionSourceFramerate.Builder> 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. 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. This is a convenience method that creates an instance of the CaptionSourceFramerate.Builder avoiding the need to create one manually via CaptionSourceFramerate.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to framerate(CaptionSourceFramerate).

Parameters:

framerate - a consumer that will call methods on CaptionSourceFramerate.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

framerate(CaptionSourceFramerate)

sourceFile

FileSourceSettings.Builder sourceFile(String sourceFile)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

timeDelta

FileSourceSettings.Builder timeDelta(Integer timeDelta)

Optional. Use this setting when you need to adjust the sync between your sidecar captions and your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/time-delta-use-cases.html. Enter a positive or negative number to modify the times in the captions file. For example, type 15 to add 15 seconds to all the times in the captions file. Type -5 to subtract 5 seconds from the times in the captions file. You can optionally specify your time delta in milliseconds instead of seconds. When you do so, set the related setting, Time delta units to Milliseconds. Note that, when you specify a time delta for timecode-based caption sources, such as SCC and STL, and your time delta isn't a multiple of the input frame rate, MediaConvert snaps the captions to the nearest frame. For example, when your input video frame rate is 25 fps and you specify 1010ms for time delta, MediaConvert delays your captions by 1000 ms.

Parameters:

timeDelta - Optional. Use this setting when you need to adjust the sync between your sidecar captions and your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/time-delta-use-cases.html. Enter a positive or negative number to modify the times in the captions file. For example, type 15 to add 15 seconds to all the times in the captions file. Type -5 to subtract 5 seconds from the times in the captions file. You can optionally specify your time delta in milliseconds instead of seconds. When you do so, set the related setting, Time delta units to Milliseconds. Note that, when you specify a time delta for timecode-based caption sources, such as SCC and STL, and your time delta isn't a multiple of the input frame rate, MediaConvert snaps the captions to the nearest frame. For example, when your input video frame rate is 25 fps and you specify 1010ms for time delta, MediaConvert delays your captions by 1000 ms.

Returns:

Returns a reference to this object so that method calls can be chained together.

timeDeltaUnits

FileSourceSettings.Builder timeDeltaUnits(String timeDeltaUnits)

When you use the setting Time delta to adjust the sync between your sidecar captions and your video, use this setting to specify the units for the delta that you specify. When you don't specify a value for Time delta units, MediaConvert uses seconds by default.

Parameters:

timeDeltaUnits - When you use the setting Time delta to adjust the sync between your sidecar captions and your video, use this setting to specify the units for the delta that you specify. When you don't specify a value for Time delta units, MediaConvert uses seconds by default.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FileSourceTimeDeltaUnits, FileSourceTimeDeltaUnits

timeDeltaUnits

FileSourceSettings.Builder timeDeltaUnits(FileSourceTimeDeltaUnits timeDeltaUnits)

When you use the setting Time delta to adjust the sync between your sidecar captions and your video, use this setting to specify the units for the delta that you specify. When you don't specify a value for Time delta units, MediaConvert uses seconds by default.

Parameters:

timeDeltaUnits - When you use the setting Time delta to adjust the sync between your sidecar captions and your video, use this setting to specify the units for the delta that you specify. When you don't specify a value for Time delta units, MediaConvert uses seconds by default.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FileSourceTimeDeltaUnits, FileSourceTimeDeltaUnits