software.amazon.awssdk.services.mediaconvert.model

Interface CaptionDestinationSettings.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CaptionDestinationSettings.Builder,CaptionDestinationSettings>, SdkBuilder<CaptionDestinationSettings.Builder,CaptionDestinationSettings>, SdkPojo

Enclosing class:

CaptionDestinationSettings

public static interface CaptionDestinationSettings.Builder
extends SdkPojo, CopyableBuilder<CaptionDestinationSettings.Builder,CaptionDestinationSettings>

Method Summary

Modifier and Type	Method and Description
CaptionDestinationSettings.Builder	burninDestinationSettings(BurninDestinationSettings burninDestinationSettings) Burn-in is a captions delivery method, rather than a captions format.
default CaptionDestinationSettings.Builder	burninDestinationSettings(Consumer<BurninDestinationSettings.Builder> burninDestinationSettings) Burn-in is a captions delivery method, rather than a captions format.
CaptionDestinationSettings.Builder	destinationType(CaptionDestinationType destinationType) Specify the format for this set of captions on this output.
CaptionDestinationSettings.Builder	destinationType(String destinationType) Specify the format for this set of captions on this output.
default CaptionDestinationSettings.Builder	dvbSubDestinationSettings(Consumer<DvbSubDestinationSettings.Builder> dvbSubDestinationSettings) Settings related to DVB-Sub captions.
CaptionDestinationSettings.Builder	dvbSubDestinationSettings(DvbSubDestinationSettings dvbSubDestinationSettings) Settings related to DVB-Sub captions.
default CaptionDestinationSettings.Builder	embeddedDestinationSettings(Consumer<EmbeddedDestinationSettings.Builder> embeddedDestinationSettings) Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions.
CaptionDestinationSettings.Builder	embeddedDestinationSettings(EmbeddedDestinationSettings embeddedDestinationSettings) Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions.
default CaptionDestinationSettings.Builder	imscDestinationSettings(Consumer<ImscDestinationSettings.Builder> imscDestinationSettings) Settings related to IMSC captions.
CaptionDestinationSettings.Builder	imscDestinationSettings(ImscDestinationSettings imscDestinationSettings) Settings related to IMSC captions.
default CaptionDestinationSettings.Builder	sccDestinationSettings(Consumer<SccDestinationSettings.Builder> sccDestinationSettings) Settings related to SCC captions.
CaptionDestinationSettings.Builder	sccDestinationSettings(SccDestinationSettings sccDestinationSettings) Settings related to SCC captions.
default CaptionDestinationSettings.Builder	srtDestinationSettings(Consumer<SrtDestinationSettings.Builder> srtDestinationSettings) Settings related to SRT captions.
CaptionDestinationSettings.Builder	srtDestinationSettings(SrtDestinationSettings srtDestinationSettings) Settings related to SRT captions.
default CaptionDestinationSettings.Builder	teletextDestinationSettings(Consumer<TeletextDestinationSettings.Builder> teletextDestinationSettings) Settings related to teletext captions.
CaptionDestinationSettings.Builder	teletextDestinationSettings(TeletextDestinationSettings teletextDestinationSettings) Settings related to teletext captions.
default CaptionDestinationSettings.Builder	ttmlDestinationSettings(Consumer<TtmlDestinationSettings.Builder> ttmlDestinationSettings) Settings related to TTML captions.
CaptionDestinationSettings.Builder	ttmlDestinationSettings(TtmlDestinationSettings ttmlDestinationSettings) Settings related to TTML captions.
default CaptionDestinationSettings.Builder	webvttDestinationSettings(Consumer<WebvttDestinationSettings.Builder> webvttDestinationSettings) Settings related to WebVTT captions.
CaptionDestinationSettings.Builder	webvttDestinationSettings(WebvttDestinationSettings webvttDestinationSettings) Settings related to WebVTT captions.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

burninDestinationSettings

CaptionDestinationSettings.Builder burninDestinationSettings(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

burninDestinationSettings

default CaptionDestinationSettings.Builder burninDestinationSettings(Consumer<BurninDestinationSettings.Builder> 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. This is a convenience method that creates an instance of the BurninDestinationSettings.Builder avoiding the need to create one manually via BurninDestinationSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to burninDestinationSettings(BurninDestinationSettings).

Parameters:

burninDestinationSettings - a consumer that will call methods on BurninDestinationSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

burninDestinationSettings(BurninDestinationSettings)

destinationType

CaptionDestinationSettings.Builder destinationType(String 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).

Parameters:

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).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CaptionDestinationType, CaptionDestinationType

destinationType

CaptionDestinationSettings.Builder destinationType(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).

Parameters:

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).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CaptionDestinationType, CaptionDestinationType

dvbSubDestinationSettings

CaptionDestinationSettings.Builder dvbSubDestinationSettings(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

dvbSubDestinationSettings

default CaptionDestinationSettings.Builder dvbSubDestinationSettings(Consumer<DvbSubDestinationSettings.Builder> 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. This is a convenience method that creates an instance of the DvbSubDestinationSettings.Builder avoiding the need to create one manually via DvbSubDestinationSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dvbSubDestinationSettings(DvbSubDestinationSettings).

Parameters:

dvbSubDestinationSettings - a consumer that will call methods on DvbSubDestinationSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

dvbSubDestinationSettings(DvbSubDestinationSettings)

embeddedDestinationSettings

CaptionDestinationSettings.Builder embeddedDestinationSettings(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

embeddedDestinationSettings

default CaptionDestinationSettings.Builder embeddedDestinationSettings(Consumer<EmbeddedDestinationSettings.Builder> 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. This is a convenience method that creates an instance of the EmbeddedDestinationSettings.Builder avoiding the need to create one manually via EmbeddedDestinationSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to embeddedDestinationSettings(EmbeddedDestinationSettings).

Parameters:

embeddedDestinationSettings - a consumer that will call methods on EmbeddedDestinationSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

embeddedDestinationSettings(EmbeddedDestinationSettings)

imscDestinationSettings

CaptionDestinationSettings.Builder imscDestinationSettings(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

imscDestinationSettings

default CaptionDestinationSettings.Builder imscDestinationSettings(Consumer<ImscDestinationSettings.Builder> 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. This is a convenience method that creates an instance of the ImscDestinationSettings.Builder avoiding the need to create one manually via ImscDestinationSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to imscDestinationSettings(ImscDestinationSettings).

Parameters:

imscDestinationSettings - a consumer that will call methods on ImscDestinationSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

imscDestinationSettings(ImscDestinationSettings)

sccDestinationSettings

CaptionDestinationSettings.Builder sccDestinationSettings(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

sccDestinationSettings

default CaptionDestinationSettings.Builder sccDestinationSettings(Consumer<SccDestinationSettings.Builder> 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. This is a convenience method that creates an instance of the SccDestinationSettings.Builder avoiding the need to create one manually via SccDestinationSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sccDestinationSettings(SccDestinationSettings).

Parameters:

sccDestinationSettings - a consumer that will call methods on SccDestinationSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

sccDestinationSettings(SccDestinationSettings)

srtDestinationSettings

CaptionDestinationSettings.Builder srtDestinationSettings(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

srtDestinationSettings

default CaptionDestinationSettings.Builder srtDestinationSettings(Consumer<SrtDestinationSettings.Builder> 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. This is a convenience method that creates an instance of the SrtDestinationSettings.Builder avoiding the need to create one manually via SrtDestinationSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to srtDestinationSettings(SrtDestinationSettings).

Parameters:

srtDestinationSettings - a consumer that will call methods on SrtDestinationSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

srtDestinationSettings(SrtDestinationSettings)

teletextDestinationSettings

CaptionDestinationSettings.Builder teletextDestinationSettings(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

teletextDestinationSettings

default CaptionDestinationSettings.Builder teletextDestinationSettings(Consumer<TeletextDestinationSettings.Builder> 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. This is a convenience method that creates an instance of the TeletextDestinationSettings.Builder avoiding the need to create one manually via TeletextDestinationSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to teletextDestinationSettings(TeletextDestinationSettings).

Parameters:

teletextDestinationSettings - a consumer that will call methods on TeletextDestinationSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

teletextDestinationSettings(TeletextDestinationSettings)

ttmlDestinationSettings

CaptionDestinationSettings.Builder ttmlDestinationSettings(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

ttmlDestinationSettings

default CaptionDestinationSettings.Builder ttmlDestinationSettings(Consumer<TtmlDestinationSettings.Builder> 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. This is a convenience method that creates an instance of the TtmlDestinationSettings.Builder avoiding the need to create one manually via TtmlDestinationSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ttmlDestinationSettings(TtmlDestinationSettings).

Parameters:

ttmlDestinationSettings - a consumer that will call methods on TtmlDestinationSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ttmlDestinationSettings(TtmlDestinationSettings)

webvttDestinationSettings

CaptionDestinationSettings.Builder webvttDestinationSettings(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

webvttDestinationSettings

default CaptionDestinationSettings.Builder webvttDestinationSettings(Consumer<WebvttDestinationSettings.Builder> 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. This is a convenience method that creates an instance of the WebvttDestinationSettings.Builder avoiding the need to create one manually via WebvttDestinationSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to webvttDestinationSettings(WebvttDestinationSettings).

Parameters:

webvttDestinationSettings - a consumer that will call methods on WebvttDestinationSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

webvttDestinationSettings(WebvttDestinationSettings)