software.amazon.awssdk.services.mediaconvert.model

Class CaptionSourceSettings

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.CaptionSourceSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CaptionSourceSettings.Builder,CaptionSourceSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class CaptionSourceSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CaptionSourceSettings.Builder,CaptionSourceSettings>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CaptionSourceSettings.Builder

Method Summary

Modifier and Type	Method and Description
AncillarySourceSettings	ancillarySourceSettings() Settings for ancillary captions source.
static CaptionSourceSettings.Builder	builder()
DvbSubSourceSettings	dvbSubSourceSettings() DVB Sub Source Settings
EmbeddedSourceSettings	embeddedSourceSettings() Settings for embedded captions Source
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CaptionSourceSettings.Builder>	serializableBuilderClass()
CaptionSourceType	sourceType() Use Source (SourceType) to identify the format of your input captions.
String	sourceTypeAsString() Use Source (SourceType) to identify the format of your input captions.
TeletextSourceSettings	teletextSourceSettings() Settings specific to Teletext caption sources, including Page number.
CaptionSourceSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TrackSourceSettings	trackSourceSettings() Settings specific to caption sources that are specified by track number.

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

ancillarySourceSettings

public final AncillarySourceSettings ancillarySourceSettings()

Settings for ancillary captions source.

Returns:

Settings for ancillary captions source.

dvbSubSourceSettings

public final DvbSubSourceSettings dvbSubSourceSettings()

DVB Sub Source Settings

Returns:

DVB Sub Source Settings

embeddedSourceSettings

public final EmbeddedSourceSettings embeddedSourceSettings()

Settings for embedded captions Source

Returns:

Settings for embedded captions Source

fileSourceSettings

public final 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.

Returns:

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.

sourceType

public final CaptionSourceType sourceType()

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

If the service returns an enum value that is not available in the current SDK version, sourceType will return CaptionSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().

Returns:

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

See Also:

CaptionSourceType

sourceTypeAsString

public final String sourceTypeAsString()

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

If the service returns an enum value that is not available in the current SDK version, sourceType will return CaptionSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().

Returns:

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

See Also:

CaptionSourceType

teletextSourceSettings

public final TeletextSourceSettings teletextSourceSettings()

Settings specific to Teletext caption sources, including Page number.

Returns:

Settings specific to Teletext caption sources, including Page number.

trackSourceSettings

public final 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.

Returns:

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.

toBuilder

public CaptionSourceSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CaptionSourceSettings.Builder,CaptionSourceSettings>

builder

public static CaptionSourceSettings.Builder builder()

serializableBuilderClass

public static Class<? extends CaptionSourceSettings.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