Class CaptionSource

java.lang.Object
software.amazon.awssdk.services.elastictranscoder.model.CaptionSource
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CaptionSource.Builder,CaptionSource>
@Generated("software.amazon.awssdk:codegen") public final class CaptionSource extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CaptionSource.Builder,CaptionSource>

A source file for the input sidecar captions used during the transcoding process.

See Also:

  • Method Details

    • key

      public final String key()

      The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

      Returns:
      The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

    • language

      public final String language()

      A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. Specify this as one of:

      • 2-character ISO 639-1 code

      • 3-character ISO 639-2 code

      For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

      Returns:
      A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. Specify this as one of:

      • 2-character ISO 639-1 code

      • 3-character ISO 639-2 code

      For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

    • timeOffset

      public final String timeOffset()

      For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

      Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

      Returns:
      For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

      Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

    • label

      public final String label()

      The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.

      Returns:
      The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.

    • encryption

      public final Encryption encryption()

      The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.

      Returns:
      The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.

    • toBuilder

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

    • builder

      public static CaptionSource.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.