software.amazon.awssdk.services.mediaconvert.model

Class ImscDestinationSettings

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.ImscDestinationSettings

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class ImscDestinationSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImscDestinationSettings.Builder

Method Summary

Modifier and Type	Method and Description
ImscAccessibilitySubs	accessibility() If the IMSC captions track is intended to provide accessibility for people who are deaf or hard of hearing: Set Accessibility subtitles to Enabled.
String	accessibilityAsString() If the IMSC captions track is intended to provide accessibility for people who are deaf or hard of hearing: Set Accessibility subtitles to Enabled.
static ImscDestinationSettings.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ImscDestinationSettings.Builder>	serializableBuilderClass()
ImscStylePassthrough	stylePassthrough() Keep this setting enabled to have MediaConvert use the font style and position information from the captions source in the output.
String	stylePassthroughAsString() Keep this setting enabled to have MediaConvert use the font style and position information from the captions source in the output.
ImscDestinationSettings.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

accessibility

public final ImscAccessibilitySubs accessibility()

If the IMSC captions track is intended to provide accessibility for people who are deaf or hard of hearing: Set Accessibility subtitles to Enabled. When you do, MediaConvert adds accessibility attributes to your output HLS or DASH manifest. For HLS manifests, MediaConvert adds the following accessibility attributes under EXT-X-MEDIA for this track: CHARACTERISTICS="public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound" and AUTOSELECT="YES". For DASH manifests, MediaConvert adds the following in the adaptation set for this track: . If the captions track is not intended to provide such accessibility: Keep the default value, Disabled. When you do, for DASH manifests, MediaConvert instead adds the following in the adaptation set for this track: .

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

Returns:

If the IMSC captions track is intended to provide accessibility for people who are deaf or hard of hearing: Set Accessibility subtitles to Enabled. When you do, MediaConvert adds accessibility attributes to your output HLS or DASH manifest. For HLS manifests, MediaConvert adds the following accessibility attributes under EXT-X-MEDIA for this track: CHARACTERISTICS= "public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound" and AUTOSELECT="YES". For DASH manifests, MediaConvert adds the following in the adaptation set for this track: . If the captions track is not intended to provide such accessibility: Keep the default value, Disabled. When you do, for DASH manifests, MediaConvert instead adds the following in the adaptation set for this track: .

See Also:

ImscAccessibilitySubs

accessibilityAsString

public final String accessibilityAsString()

If the IMSC captions track is intended to provide accessibility for people who are deaf or hard of hearing: Set Accessibility subtitles to Enabled. When you do, MediaConvert adds accessibility attributes to your output HLS or DASH manifest. For HLS manifests, MediaConvert adds the following accessibility attributes under EXT-X-MEDIA for this track: CHARACTERISTICS="public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound" and AUTOSELECT="YES". For DASH manifests, MediaConvert adds the following in the adaptation set for this track: . If the captions track is not intended to provide such accessibility: Keep the default value, Disabled. When you do, for DASH manifests, MediaConvert instead adds the following in the adaptation set for this track: .

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

Returns:

If the IMSC captions track is intended to provide accessibility for people who are deaf or hard of hearing: Set Accessibility subtitles to Enabled. When you do, MediaConvert adds accessibility attributes to your output HLS or DASH manifest. For HLS manifests, MediaConvert adds the following accessibility attributes under EXT-X-MEDIA for this track: CHARACTERISTICS= "public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound" and AUTOSELECT="YES". For DASH manifests, MediaConvert adds the following in the adaptation set for this track: . If the captions track is not intended to provide such accessibility: Keep the default value, Disabled. When you do, for DASH manifests, MediaConvert instead adds the following in the adaptation set for this track: .

See Also:

ImscAccessibilitySubs

stylePassthrough

public final ImscStylePassthrough stylePassthrough()

Keep this setting enabled to have MediaConvert use the font style and position information from the captions source in the output. This option is available only when your input captions are IMSC, SMPTE-TT, or TTML. Disable this setting for simplified output captions.

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

Returns:

Keep this setting enabled to have MediaConvert use the font style and position information from the captions source in the output. This option is available only when your input captions are IMSC, SMPTE-TT, or TTML. Disable this setting for simplified output captions.

See Also:

ImscStylePassthrough

stylePassthroughAsString

public final String stylePassthroughAsString()

Keep this setting enabled to have MediaConvert use the font style and position information from the captions source in the output. This option is available only when your input captions are IMSC, SMPTE-TT, or TTML. Disable this setting for simplified output captions.

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

Returns:

Keep this setting enabled to have MediaConvert use the font style and position information from the captions source in the output. This option is available only when your input captions are IMSC, SMPTE-TT, or TTML. Disable this setting for simplified output captions.

See Also:

ImscStylePassthrough

toBuilder

public ImscDestinationSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImscDestinationSettings.Builder,ImscDestinationSettings>

builder

public static ImscDestinationSettings.Builder builder()

serializableBuilderClass

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