Class CaptionSourceSettings

java.lang.Object
software.amazon.awssdk.services.mediaconvert.model.CaptionSourceSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CaptionSourceSettings.Builder,CaptionSourceSettings>

@Generated("software.amazon.awssdk:codegen") public final class CaptionSourceSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CaptionSourceSettings.Builder,CaptionSourceSettings>
If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input captions source file. If your input captions are IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.
See Also:
  • Method Details

    • ancillarySourceSettings

      public final AncillarySourceSettings ancillarySourceSettings()
      Settings for ancillary captions source.
      Returns:
      Settings for ancillary captions source.
    • dvbSubSourceSettings

      public final DvbSubSourceSettings dvbSubSourceSettings()
      DVB Sub Source Settings
      Returns:
      DVB Sub Source Settings
    • embeddedSourceSettings

      public final EmbeddedSourceSettings embeddedSourceSettings()
      Settings for embedded captions Source
      Returns:
      Settings for embedded captions Source
    • fileSourceSettings

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

      public final CaptionSourceType sourceType()
      Use Source to identify the format of your input captions. The service cannot auto-detect caption format.

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

      Returns:
      Use Source to identify the format of your input captions. The service cannot auto-detect caption format.
      See Also:
    • sourceTypeAsString

      public final String sourceTypeAsString()
      Use Source to identify the format of your input captions. The service cannot auto-detect caption format.

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

      Returns:
      Use Source to identify the format of your input captions. The service cannot auto-detect caption format.
      See Also:
    • teletextSourceSettings

      public final TeletextSourceSettings teletextSourceSettings()
      Settings specific to Teletext caption sources, including Page number.
      Returns:
      Settings specific to Teletext caption sources, including Page number.
    • trackSourceSettings

      public final TrackSourceSettings trackSourceSettings()
      Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.
      Returns:
      Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.
    • webvttHlsSourceSettings

      public final WebvttHlsSourceSettings webvttHlsSourceSettings()
      Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings.
      Returns:
      Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings.
    • toBuilder

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

      public static CaptionSourceSettings.Builder builder()
    • serializableBuilderClass

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