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()`
`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.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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.
`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.
  - 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

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

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields