Package software.amazon.awssdk.services.mediaconvert.model

Class WebvttHlsSourceSettings

java.lang.Object
software.amazon.awssdk.services.mediaconvert.model.WebvttHlsSourceSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WebvttHlsSourceSettings.Builder,WebvttHlsSourceSettings>
@Generated("software.amazon.awssdk:codegen") public final class WebvttHlsSourceSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WebvttHlsSourceSettings.Builder,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.
See Also:

  • Method Details

    • renditionGroupId

      public final String renditionGroupId()
      Optional. Specify alternative group ID
      Returns:
      Optional. Specify alternative group ID

    • renditionLanguageCode

      public final LanguageCode renditionLanguageCode()
      Optional. Specify ISO 639-2 or ISO 639-3 code in the language property

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

      Returns:
      Optional. Specify ISO 639-2 or ISO 639-3 code in the language property
      See Also:

    • renditionLanguageCodeAsString

      public final String renditionLanguageCodeAsString()
      Optional. Specify ISO 639-2 or ISO 639-3 code in the language property

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

      Returns:
      Optional. Specify ISO 639-2 or ISO 639-3 code in the language property
      See Also:

    • renditionName

      public final String renditionName()
      Optional. Specify media name
      Returns:
      Optional. Specify media name

    • toBuilder

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

    • builder

      public static WebvttHlsSourceSettings.Builder builder()

    • serializableBuilderClass

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