software.amazon.awssdk.services.mediaconvert.model

Interface CaptionSourceSettings.Builder

All Superinterfaces:

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

Enclosing class:

CaptionSourceSettings

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

Method Summary

Modifier and Type	Method and Description
CaptionSourceSettings.Builder	ancillarySourceSettings(AncillarySourceSettings ancillarySourceSettings) Settings for ancillary captions source.
default CaptionSourceSettings.Builder	ancillarySourceSettings(Consumer<AncillarySourceSettings.Builder> ancillarySourceSettings) Settings for ancillary captions source.
default CaptionSourceSettings.Builder	dvbSubSourceSettings(Consumer<DvbSubSourceSettings.Builder> dvbSubSourceSettings) DVB Sub Source Settings This is a convenience method that creates an instance of the DvbSubSourceSettings.Builder avoiding the need to create one manually via DvbSubSourceSettings.builder().
CaptionSourceSettings.Builder	dvbSubSourceSettings(DvbSubSourceSettings dvbSubSourceSettings) DVB Sub Source Settings
default CaptionSourceSettings.Builder	embeddedSourceSettings(Consumer<EmbeddedSourceSettings.Builder> embeddedSourceSettings) Settings for embedded captions Source This is a convenience method that creates an instance of the EmbeddedSourceSettings.Builder avoiding the need to create one manually via EmbeddedSourceSettings.builder().
CaptionSourceSettings.Builder	embeddedSourceSettings(EmbeddedSourceSettings embeddedSourceSettings) Settings for embedded captions Source
default CaptionSourceSettings.Builder	fileSourceSettings(Consumer<FileSourceSettings.Builder> fileSourceSettings) If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file.
CaptionSourceSettings.Builder	fileSourceSettings(FileSourceSettings fileSourceSettings) If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file.
CaptionSourceSettings.Builder	sourceType(CaptionSourceType sourceType) Use Source (SourceType) to identify the format of your input captions.
CaptionSourceSettings.Builder	sourceType(String sourceType) Use Source (SourceType) to identify the format of your input captions.
default CaptionSourceSettings.Builder	teletextSourceSettings(Consumer<TeletextSourceSettings.Builder> teletextSourceSettings) Settings specific to Teletext caption sources, including Page number.
CaptionSourceSettings.Builder	teletextSourceSettings(TeletextSourceSettings teletextSourceSettings) Settings specific to Teletext caption sources, including Page number.
default CaptionSourceSettings.Builder	trackSourceSettings(Consumer<TrackSourceSettings.Builder> trackSourceSettings) Settings specific to caption sources that are specified by track number.
CaptionSourceSettings.Builder	trackSourceSettings(TrackSourceSettings trackSourceSettings) Settings specific to caption sources that are specified by track number.
default CaptionSourceSettings.Builder	webvttHlsSourceSettings(Consumer<WebvttHlsSourceSettings.Builder> webvttHlsSourceSettings) Settings specific to WebVTT sources in HLS alternative rendition group.
CaptionSourceSettings.Builder	webvttHlsSourceSettings(WebvttHlsSourceSettings webvttHlsSourceSettings) Settings specific to WebVTT sources in HLS alternative rendition group.

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

ancillarySourceSettings

CaptionSourceSettings.Builder ancillarySourceSettings(AncillarySourceSettings ancillarySourceSettings)

Settings for ancillary captions source.

Parameters:

ancillarySourceSettings - Settings for ancillary captions source.

Returns:

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

ancillarySourceSettings

default CaptionSourceSettings.Builder ancillarySourceSettings(Consumer<AncillarySourceSettings.Builder> ancillarySourceSettings)

Settings for ancillary captions source. This is a convenience method that creates an instance of the AncillarySourceSettings.Builder avoiding the need to create one manually via AncillarySourceSettings.builder().

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

Parameters:

ancillarySourceSettings - a consumer that will call methods on AncillarySourceSettings.Builder

Returns:

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

See Also:

ancillarySourceSettings(AncillarySourceSettings)

dvbSubSourceSettings

CaptionSourceSettings.Builder dvbSubSourceSettings(DvbSubSourceSettings dvbSubSourceSettings)

DVB Sub Source Settings

Parameters:

dvbSubSourceSettings - DVB Sub Source Settings

Returns:

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

dvbSubSourceSettings

default CaptionSourceSettings.Builder dvbSubSourceSettings(Consumer<DvbSubSourceSettings.Builder> dvbSubSourceSettings)

DVB Sub Source Settings This is a convenience method that creates an instance of the DvbSubSourceSettings.Builder avoiding the need to create one manually via DvbSubSourceSettings.builder().

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

Parameters:

dvbSubSourceSettings - a consumer that will call methods on DvbSubSourceSettings.Builder

Returns:

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

See Also:

dvbSubSourceSettings(DvbSubSourceSettings)

embeddedSourceSettings

CaptionSourceSettings.Builder embeddedSourceSettings(EmbeddedSourceSettings embeddedSourceSettings)

Settings for embedded captions Source

Parameters:

embeddedSourceSettings - Settings for embedded captions Source

Returns:

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

embeddedSourceSettings

default CaptionSourceSettings.Builder embeddedSourceSettings(Consumer<EmbeddedSourceSettings.Builder> embeddedSourceSettings)

Settings for embedded captions Source This is a convenience method that creates an instance of the EmbeddedSourceSettings.Builder avoiding the need to create one manually via EmbeddedSourceSettings.builder().

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

Parameters:

embeddedSourceSettings - a consumer that will call methods on EmbeddedSourceSettings.Builder

Returns:

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

See Also:

embeddedSourceSettings(EmbeddedSourceSettings)

fileSourceSettings

CaptionSourceSettings.Builder fileSourceSettings(FileSourceSettings fileSourceSettings)

If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

Parameters:

fileSourceSettings - If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

Returns:

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

fileSourceSettings

default CaptionSourceSettings.Builder fileSourceSettings(Consumer<FileSourceSettings.Builder> fileSourceSettings)

If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings. This is a convenience method that creates an instance of the FileSourceSettings.Builder avoiding the need to create one manually via FileSourceSettings.builder().

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

Parameters:

fileSourceSettings - a consumer that will call methods on FileSourceSettings.Builder

Returns:

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

See Also:

fileSourceSettings(FileSourceSettings)

sourceType

CaptionSourceSettings.Builder sourceType(String sourceType)

Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.

Parameters:

sourceType - Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.

Returns:

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

See Also:

CaptionSourceType, CaptionSourceType

sourceType

CaptionSourceSettings.Builder sourceType(CaptionSourceType sourceType)

Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.

Parameters:

sourceType - Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.

Returns:

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

See Also:

CaptionSourceType, CaptionSourceType

teletextSourceSettings

CaptionSourceSettings.Builder teletextSourceSettings(TeletextSourceSettings teletextSourceSettings)

Settings specific to Teletext caption sources, including Page number.

Parameters:

teletextSourceSettings - Settings specific to Teletext caption sources, including Page number.

Returns:

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

teletextSourceSettings

default CaptionSourceSettings.Builder teletextSourceSettings(Consumer<TeletextSourceSettings.Builder> teletextSourceSettings)

Settings specific to Teletext caption sources, including Page number. This is a convenience method that creates an instance of the TeletextSourceSettings.Builder avoiding the need to create one manually via TeletextSourceSettings.builder().

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

Parameters:

teletextSourceSettings - a consumer that will call methods on TeletextSourceSettings.Builder

Returns:

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

See Also:

teletextSourceSettings(TeletextSourceSettings)

trackSourceSettings

CaptionSourceSettings.Builder trackSourceSettings(TrackSourceSettings trackSourceSettings)

Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.

Parameters:

trackSourceSettings - Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.

Returns:

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

trackSourceSettings

default CaptionSourceSettings.Builder trackSourceSettings(Consumer<TrackSourceSettings.Builder> trackSourceSettings)

Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings. This is a convenience method that creates an instance of the TrackSourceSettings.Builder avoiding the need to create one manually via TrackSourceSettings.builder().

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

Parameters:

trackSourceSettings - a consumer that will call methods on TrackSourceSettings.Builder

Returns:

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

See Also:

trackSourceSettings(TrackSourceSettings)

webvttHlsSourceSettings

CaptionSourceSettings.Builder webvttHlsSourceSettings(WebvttHlsSourceSettings webvttHlsSourceSettings)

Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings.

Parameters:

webvttHlsSourceSettings - Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings.

Returns:

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

webvttHlsSourceSettings

default CaptionSourceSettings.Builder webvttHlsSourceSettings(Consumer<WebvttHlsSourceSettings.Builder> webvttHlsSourceSettings)

Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings. This is a convenience method that creates an instance of the WebvttHlsSourceSettings.Builder avoiding the need to create one manually via WebvttHlsSourceSettings.builder().

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

Parameters:

webvttHlsSourceSettings - a consumer that will call methods on WebvttHlsSourceSettings.Builder

Returns:

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

See Also:

webvttHlsSourceSettings(WebvttHlsSourceSettings)