CaptionDestinationSettings (AWS Java SDK :: Services :: AWS Elemental MediaConvert 2.19.8 API)

java.lang.Object
- software.amazon.awssdk.services.mediaconvert.model.CaptionDestinationSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CaptionDestinationSettings.Builder,CaptionDestinationSettings>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class CaptionDestinationSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CaptionDestinationSettings.Builder,CaptionDestinationSettings>
```
Settings related to one captions tab on the MediaConvert console. In your job JSON, an instance of captions DestinationSettings is equivalent to one captions tab in the console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CaptionDestinationSettings.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CaptionDestinationSettings.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CaptionDestinationSettings.Builder`	`builder()`
`BurninDestinationSettings`	`burninDestinationSettings()` Burn-in is a captions delivery method, rather than a captions format.
`CaptionDestinationType`	`destinationType()` Specify the format for this set of captions on this output.
`String`	`destinationTypeAsString()` Specify the format for this set of captions on this output.
`DvbSubDestinationSettings`	`dvbSubDestinationSettings()` Settings related to DVB-Sub captions.
`EmbeddedDestinationSettings`	`embeddedDestinationSettings()` Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`ImscDestinationSettings`	`imscDestinationSettings()` Settings related to IMSC captions.
`SccDestinationSettings`	`sccDestinationSettings()` Settings related to SCC captions.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CaptionDestinationSettings.Builder>`	`serializableBuilderClass()`
`SrtDestinationSettings`	`srtDestinationSettings()` Settings related to SRT captions.
`TeletextDestinationSettings`	`teletextDestinationSettings()` Settings related to teletext captions.
`CaptionDestinationSettings.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`TtmlDestinationSettings`	`ttmlDestinationSettings()` Settings related to TTML captions.
`WebvttDestinationSettings`	`webvttDestinationSettings()` Settings related to WebVTT captions.

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
  - burninDestinationSettings
```
public final BurninDestinationSettings burninDestinationSettings()
```
    Burn-in is a captions delivery method, rather than a captions format. Burn-in writes the captions directly on your video frames, replacing pixels of video content with the captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN.
    
    Returns:
    
    Burn-in is a captions delivery method, rather than a captions format. Burn-in writes the captions directly on your video frames, replacing pixels of video content with the captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN.
  - destinationType
```
public final CaptionDestinationType destinationType()
```
    Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container constrains your choice of output captions format. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. If you are using SCTE-20 and you want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED). To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).
    If the service returns an enum value that is not available in the current SDK version, destinationType will return CaptionDestinationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from destinationTypeAsString().
    
    Returns:
    
    Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container constrains your choice of output captions format. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. If you are using SCTE-20 and you want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED). To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).
    
    See Also:
    
    CaptionDestinationType
  - destinationTypeAsString
```
public final String destinationTypeAsString()
```
    Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container constrains your choice of output captions format. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. If you are using SCTE-20 and you want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED). To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).
    If the service returns an enum value that is not available in the current SDK version, destinationType will return CaptionDestinationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from destinationTypeAsString().
    
    Returns:
    
    Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container constrains your choice of output captions format. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. If you are using SCTE-20 and you want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED). To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).
    
    See Also:
    
    CaptionDestinationType
  - dvbSubDestinationSettings
```
public final DvbSubDestinationSettings dvbSubDestinationSettings()
```
    Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/dvb-sub-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to DVB_SUB.
    
    Returns:
    
    Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/dvb-sub-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to DVB_SUB.
  - embeddedDestinationSettings
```
public final EmbeddedDestinationSettings embeddedDestinationSettings()
```
    Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions. Set up embedded captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to EMBEDDED, EMBEDDED_PLUS_SCTE20, or SCTE20_PLUS_EMBEDDED.
    
    Returns:
    
    Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions. Set up embedded captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to EMBEDDED, EMBEDDED_PLUS_SCTE20, or SCTE20_PLUS_EMBEDDED.
  - imscDestinationSettings
```
public final ImscDestinationSettings imscDestinationSettings()
```
    Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to IMSC.
    
    Returns:
    
    Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to IMSC.
  - sccDestinationSettings
```
public final SccDestinationSettings sccDestinationSettings()
```
    Settings related to SCC captions. SCC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SCC.
    
    Returns:
    
    Settings related to SCC captions. SCC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SCC.
  - srtDestinationSettings
```
public final SrtDestinationSettings srtDestinationSettings()
```
    Settings related to SRT captions. SRT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SRT.
    
    Returns:
    
    Settings related to SRT captions. SRT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SRT.
  - teletextDestinationSettings
```
public final TeletextDestinationSettings teletextDestinationSettings()
```
    Settings related to teletext captions. Set up teletext captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/teletext-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TELETEXT.
    
    Returns:
    
    Settings related to teletext captions. Set up teletext captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/teletext-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TELETEXT.
  - ttmlDestinationSettings
```
public final TtmlDestinationSettings ttmlDestinationSettings()
```
    Settings related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TTML.
    
    Returns:
    
    Settings related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TTML.
  - webvttDestinationSettings
```
public final WebvttDestinationSettings webvttDestinationSettings()
```
    Settings related to WebVTT captions. WebVTT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to WebVTT.
    
    Returns:
    
    Settings related to WebVTT captions. WebVTT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to WebVTT.
  - toBuilder
```
public CaptionDestinationSettings.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CaptionDestinationSettings.Builder,CaptionDestinationSettings>
  - builder
```
public static CaptionDestinationSettings.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CaptionDestinationSettings.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 CaptionDestinationSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

burninDestinationSettings

destinationType

destinationTypeAsString

dvbSubDestinationSettings

embeddedDestinationSettings

imscDestinationSettings

sccDestinationSettings

srtDestinationSettings

teletextDestinationSettings

ttmlDestinationSettings

webvttDestinationSettings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields