Class CaptionDescription

java.lang.Object
software.amazon.awssdk.services.medialive.model.CaptionDescription
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CaptionDescription.Builder,CaptionDescription>
@Generated("software.amazon.awssdk:codegen") public final class CaptionDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CaptionDescription.Builder,CaptionDescription>
Caption Description
See Also:

  • Method Details

    • accessibility

      public final AccessibilityType accessibility()
      Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.

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

      Returns:
      Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.
      See Also:

    • accessibilityAsString

      public final String accessibilityAsString()
      Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.

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

      Returns:
      Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.
      See Also:

    • captionSelectorName

      public final String captionSelectorName()
      Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
      Returns:
      Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.

    • destinationSettings

      public final CaptionDestinationSettings destinationSettings()
      Additional settings for captions destination that depend on the destination type.
      Returns:
      Additional settings for captions destination that depend on the destination type.

    • languageCode

      public final String languageCode()
      ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
      Returns:
      ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/

    • languageDescription

      public final String languageDescription()
      Human readable information to indicate captions available for players (eg. English, or Spanish).
      Returns:
      Human readable information to indicate captions available for players (eg. English, or Spanish).

    • name

      public final String name()
      Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
      Returns:
      Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.

    • captionDashRoles

      public final List<DashRoleCaption> captionDashRoles()
      Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCaptionDashRoles() method.

      Returns:
      Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.

    • hasCaptionDashRoles

      public final boolean hasCaptionDashRoles()
      For responses, this returns true if the service returned a value for the CaptionDashRoles property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • captionDashRolesAsStrings

      public final List<String> captionDashRolesAsStrings()
      Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCaptionDashRoles() method.

      Returns:
      Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.

    • dvbDashAccessibility

      public final DvbDashAccessibility dvbDashAccessibility()
      Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.

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

      Returns:
      Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.
      See Also:

    • dvbDashAccessibilityAsString

      public final String dvbDashAccessibilityAsString()
      Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.

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

      Returns:
      Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.
      See Also:

    • toBuilder

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

    • builder

      public static CaptionDescription.Builder builder()

    • serializableBuilderClass

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