Package 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("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:

  • Method Details

    • 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, 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, 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:

    • 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, 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, 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:

    • convertPaintToPop

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

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

      Returns:
      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.
      See Also:

    • convertPaintToPopAsString

      public final String convertPaintToPopAsString()
      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.

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

      Returns:
      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.
      See Also:

    • 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. 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. 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', 'webvtt', and 'vtt'.
      Returns:
      External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl', 'srt', 'xml', 'smi', 'webvtt', and 'vtt'.

    • timeDelta

      public final 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.
      Returns:
      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.

    • timeDeltaUnits

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

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

      Returns:
      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.
      See Also:

    • timeDeltaUnitsAsString

      public final String timeDeltaUnitsAsString()
      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.

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

      Returns:
      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.
      See Also:

    • toBuilder

      public FileSourceSettings.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<FileSourceSettings.Builder,FileSourceSettings>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.