Class AncillarySourceSettings

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

@Generated("software.amazon.awssdk:codegen") public final class AncillarySourceSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AncillarySourceSettings.Builder,AncillarySourceSettings>
Settings for ancillary captions source.
See Also:
  • Method Details

    • convert608To708

      public final AncillaryConvert608To708 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 AncillaryConvert608To708.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 AncillaryConvert608To708.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:
    • sourceAncillaryChannelNumber

      public final Integer sourceAncillaryChannelNumber()
      Specifies the 608 channel number in the ancillary data track from which to extract captions. Unused for passthrough.
      Returns:
      Specifies the 608 channel number in the ancillary data track from which to extract captions. Unused for passthrough.
    • terminateCaptions

      public final AncillaryTerminateCaptions terminateCaptions()
      By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting.

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

      Returns:
      By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting.
      See Also:
    • terminateCaptionsAsString

      public final String terminateCaptionsAsString()
      By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting.

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

      Returns:
      By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting.
      See Also:
    • toBuilder

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

      public static AncillarySourceSettings.Builder builder()
    • serializableBuilderClass

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