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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CaptionDescription.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AccessibilityType`	`accessibility()`	Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds.
`String`	`accessibilityAsString()`	Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds.
`static CaptionDescription.Builder`	`builder()`
`List<DashRoleCaption>`	`captionDashRoles()`	Identifies the DASH roles to assign to this captions output.
`List<String>`	`captionDashRolesAsStrings()`	Identifies the DASH roles to assign to this captions output.
`String`	`captionSelectorName()`	Specifies which input caption selector to use as a caption source when generating output captions.
`CaptionDestinationSettings`	`destinationSettings()`	Additional settings for captions destination that depend on the destination type.
`DvbDashAccessibility`	`dvbDashAccessibility()`	Identifies DVB DASH accessibility signaling in this captions output.
`String`	`dvbDashAccessibilityAsString()`	Identifies DVB DASH accessibility signaling in this captions output.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCaptionDashRoles()`	For responses, this returns true if the service returned a value for the CaptionDashRoles property.
`int`	`hashCode()`
`String`	`languageCode()`	ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
`String`	`languageDescription()`	Human readable information to indicate captions available for players (eg.
`String`	`name()`	Name of the caption description.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CaptionDescription.Builder>`	`serializableBuilderClass()`
`CaptionDescription.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    AccessibilityType
  - 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:
    
    AccessibilityType
  - 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:
    
    DvbDashAccessibility
  - 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:
    
    DvbDashAccessibility
  - toBuilder
```
public CaptionDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CaptionDescription.Builder,CaptionDescription>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CaptionDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

accessibility

accessibilityAsString

captionSelectorName

destinationSettings

languageCode

languageDescription

name

captionDashRoles

hasCaptionDashRoles

captionDashRolesAsStrings

dvbDashAccessibility

dvbDashAccessibilityAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField