Package software.amazon.awssdk.services.mediaconvert.model

Class CaptionDescriptionPreset

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.CaptionDescriptionPreset

All Implemented Interfaces:

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

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

Caption Description for preset

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CaptionDescriptionPreset.Builder

Method Summary

Modifier and Type	Method	Description
static CaptionDescriptionPreset.Builder	builder()
String	customLanguageCode()	Specify the language for this captions output track.
CaptionDestinationSettings	destinationSettings()	Settings related to one captions tab on the MediaConvert console.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LanguageCode	languageCode()	Specify the language of this captions output track.
String	languageCodeAsString()	Specify the language of this captions output track.
String	languageDescription()	Specify a label for this set of output captions.
List<SdkField<?>>	sdkFields()
static Class<? extends CaptionDescriptionPreset.Builder>	serializableBuilderClass()
CaptionDescriptionPreset.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

customLanguageCode

public final String customLanguageCode()

Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

Returns:

Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

destinationSettings

public final CaptionDestinationSettings destinationSettings()

Settings related to one captions tab on the MediaConvert 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.

Returns:

Settings related to one captions tab on the MediaConvert 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.

languageCode

public final LanguageCode languageCode()

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

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

Returns:

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

See Also:

LanguageCode

languageCodeAsString

public final String languageCodeAsString()

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

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

Returns:

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

See Also:

LanguageCode

languageDescription

public final String languageDescription()

Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

Returns:

Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

toBuilder

public CaptionDescriptionPreset.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CaptionDescriptionPreset.Builder,CaptionDescriptionPreset>

builder

public static CaptionDescriptionPreset.Builder builder()

serializableBuilderClass

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