software.amazon.awssdk.services.mediaconvert.model

Class BurninDestinationSettings

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.BurninDestinationSettings

All Implemented Interfaces:

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BurninDestinationSettings.Builder

Method Summary

Modifier and Type	Method and Description
BurninSubtitleAlignment	alignment() Specify the alignment of your captions.
String	alignmentAsString() Specify the alignment of your captions.
BurninSubtitleApplyFontColor	applyFontColor() Ignore this setting unless Style passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex.
String	applyFontColorAsString() Ignore this setting unless Style passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex.
BurninSubtitleBackgroundColor	backgroundColor() Specify the color of the rectangle behind the captions.
String	backgroundColorAsString() Specify the color of the rectangle behind the captions.
Integer	backgroundOpacity() Specify the opacity of the background rectangle.
static BurninDestinationSettings.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
BurninSubtitleFallbackFont	fallbackFont() Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support.
String	fallbackFontAsString() Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support.
BurninSubtitleFontColor	fontColor() Specify the color of the burned-in captions text.
String	fontColorAsString() Specify the color of the burned-in captions text.
Integer	fontOpacity() Specify the opacity of the burned-in captions.
Integer	fontResolution() Specify the Font resolution (FontResolution) in DPI (dots per inch).
FontScript	fontScript() Set Font script (FontScript) to Automatically determined (AUTOMATIC), or leave blank, to automatically determine the font script in your input captions.
String	fontScriptAsString() Set Font script (FontScript) to Automatically determined (AUTOMATIC), or leave blank, to automatically determine the font script in your input captions.
Integer	fontSize() Specify the Font size (FontSize) in pixels.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	hexFontColor() Ignore this setting unless your Font color is set to Hex.
BurninSubtitleOutlineColor	outlineColor() Specify font outline color.
String	outlineColorAsString() Specify font outline color.
Integer	outlineSize() Specify the Outline size (OutlineSize) of the caption text, in pixels.
List<SdkField<?>>	sdkFields()
static Class<? extends BurninDestinationSettings.Builder>	serializableBuilderClass()
BurninSubtitleShadowColor	shadowColor() Specify the color of the shadow cast by the captions.
String	shadowColorAsString() Specify the color of the shadow cast by the captions.
Integer	shadowOpacity() Specify the opacity of the shadow.
Integer	shadowXOffset() Specify the horizontal offset of the shadow, relative to the captions in pixels.
Integer	shadowYOffset() Specify the vertical offset of the shadow relative to the captions in pixels.
BurnInSubtitleStylePassthrough	stylePassthrough() Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions.
String	stylePassthroughAsString() Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions.
BurninSubtitleTeletextSpacing	teletextSpacing() Specify whether the text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending on letter width.
String	teletextSpacingAsString() Specify whether the text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending on letter width.
BurninDestinationSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	xPosition() Specify the horizontal position (XPosition) of the captions, relative to the left side of the output in pixels.
Integer	yPosition() Specify the vertical position (YPosition) of the captions, relative to the top of the output in pixels.

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

alignment

public final BurninSubtitleAlignment alignment()

Specify the alignment of your captions. If no explicit x_position is provided, setting alignment to centered will placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates.

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

Returns:

Specify the alignment of your captions. If no explicit x_position is provided, setting alignment to centered will placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates.

See Also:

BurninSubtitleAlignment

alignmentAsString

public final String alignmentAsString()

Specify the alignment of your captions. If no explicit x_position is provided, setting alignment to centered will placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates.

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

Returns:

Specify the alignment of your captions. If no explicit x_position is provided, setting alignment to centered will placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates.

See Also:

BurninSubtitleAlignment

applyFontColor

public final BurninSubtitleApplyFontColor applyFontColor()

Ignore this setting unless Style passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. When you choose White text only (WHITE_TEXT_ONLY), or leave blank, your font color setting only applies to white text in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies to all of your output captions text.

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

Returns:

Ignore this setting unless Style passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. When you choose White text only (WHITE_TEXT_ONLY), or leave blank, your font color setting only applies to white text in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies to all of your output captions text.

See Also:

BurninSubtitleApplyFontColor

applyFontColorAsString

public final String applyFontColorAsString()

Ignore this setting unless Style passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. When you choose White text only (WHITE_TEXT_ONLY), or leave blank, your font color setting only applies to white text in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies to all of your output captions text.

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

Returns:

Ignore this setting unless Style passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. When you choose White text only (WHITE_TEXT_ONLY), or leave blank, your font color setting only applies to white text in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies to all of your output captions text.

See Also:

BurninSubtitleApplyFontColor

backgroundColor

public final BurninSubtitleBackgroundColor backgroundColor()

Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present.

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

Returns:

Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present.

See Also:

BurninSubtitleBackgroundColor

backgroundColorAsString

public final String backgroundColorAsString()

Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present.

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

Returns:

Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present.

See Also:

BurninSubtitleBackgroundColor

backgroundOpacity

public final Integer backgroundOpacity()

Specify the opacity of the background rectangle. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough (StylePassthrough) is set to enabled, leave blank to pass through the background style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all backgrounds from your output captions.

Returns:

Specify the opacity of the background rectangle. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough (StylePassthrough) is set to enabled, leave blank to pass through the background style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all backgrounds from your output captions.

fallbackFont

public final BurninSubtitleFallbackFont fallbackFont()

Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you set Fallback font (FallbackFont) to best match (BEST_MATCH), or leave blank, MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.

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

Returns:

Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you set Fallback font (FallbackFont) to best match (BEST_MATCH), or leave blank, MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.

See Also:

BurninSubtitleFallbackFont

fallbackFontAsString

public final String fallbackFontAsString()

Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you set Fallback font (FallbackFont) to best match (BEST_MATCH), or leave blank, MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.

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

Returns:

Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you set Fallback font (FallbackFont) to best match (BEST_MATCH), or leave blank, MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.

See Also:

BurninSubtitleFallbackFont

fontColor

public final BurninSubtitleFontColor fontColor()

Specify the color of the burned-in captions text. Leave Font color (FontColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font color data from your input captions, if present.

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

Returns:

Specify the color of the burned-in captions text. Leave Font color (FontColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font color data from your input captions, if present.

See Also:

BurninSubtitleFontColor

fontColorAsString

public final String fontColorAsString()

Specify the color of the burned-in captions text. Leave Font color (FontColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font color data from your input captions, if present.

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

Returns:

Specify the color of the burned-in captions text. Leave Font color (FontColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font color data from your input captions, if present.

See Also:

BurninSubtitleFontColor

fontOpacity

public final Integer fontOpacity()

Specify the opacity of the burned-in captions. 255 is opaque; 0 is transparent.

Returns:

Specify the opacity of the burned-in captions. 255 is opaque; 0 is transparent.

fontResolution

public final Integer fontResolution()

Specify the Font resolution (FontResolution) in DPI (dots per inch).

Returns:

Specify the Font resolution (FontResolution) in DPI (dots per inch).

fontScript

public final FontScript fontScript()

Set Font script (FontScript) to Automatically determined (AUTOMATIC), or leave blank, to automatically determine the font script in your input captions. Otherwise, set to Simplified Chinese (HANS) or Traditional Chinese (HANT) if your input font script uses Simplified or Traditional Chinese.

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

Returns:

Set Font script (FontScript) to Automatically determined (AUTOMATIC), or leave blank, to automatically determine the font script in your input captions. Otherwise, set to Simplified Chinese (HANS) or Traditional Chinese (HANT) if your input font script uses Simplified or Traditional Chinese.

See Also:

FontScript

fontScriptAsString

public final String fontScriptAsString()

Set Font script (FontScript) to Automatically determined (AUTOMATIC), or leave blank, to automatically determine the font script in your input captions. Otherwise, set to Simplified Chinese (HANS) or Traditional Chinese (HANT) if your input font script uses Simplified or Traditional Chinese.

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

Returns:

Set Font script (FontScript) to Automatically determined (AUTOMATIC), or leave blank, to automatically determine the font script in your input captions. Otherwise, set to Simplified Chinese (HANS) or Traditional Chinese (HANT) if your input font script uses Simplified or Traditional Chinese.

See Also:

FontScript

fontSize

public final Integer fontSize()

Specify the Font size (FontSize) in pixels. Must be a positive integer. Set to 0, or leave blank, for automatic font size.

Returns:

Specify the Font size (FontSize) in pixels. Must be a positive integer. Set to 0, or leave blank, for automatic font size.

hexFontColor

public final String hexFontColor()

Ignore this setting unless your Font color is set to Hex. Enter either six or eight hexidecimal digits, representing red, green, and blue, with two optional extra digits for alpha. For example a value of 1122AABB is a red value of 0x11, a green value of 0x22, a blue value of 0xAA, and an alpha value of 0xBB.

Returns:

Ignore this setting unless your Font color is set to Hex. Enter either six or eight hexidecimal digits, representing red, green, and blue, with two optional extra digits for alpha. For example a value of 1122AABB is a red value of 0x11, a green value of 0x22, a blue value of 0xAA, and an alpha value of 0xBB.

outlineColor

public final BurninSubtitleOutlineColor outlineColor()

Specify font outline color. Leave Outline color (OutlineColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font outline color data from your input captions, if present.

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

Returns:

Specify font outline color. Leave Outline color (OutlineColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font outline color data from your input captions, if present.

See Also:

BurninSubtitleOutlineColor

outlineColorAsString

public final String outlineColorAsString()

Specify font outline color. Leave Outline color (OutlineColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font outline color data from your input captions, if present.

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

Returns:

Specify font outline color. Leave Outline color (OutlineColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font outline color data from your input captions, if present.

See Also:

BurninSubtitleOutlineColor

outlineSize

public final Integer outlineSize()

Specify the Outline size (OutlineSize) of the caption text, in pixels. Leave Outline size blank and set Style passthrough (StylePassthrough) to enabled to use the outline size data from your input captions, if present.

Returns:

Specify the Outline size (OutlineSize) of the caption text, in pixels. Leave Outline size blank and set Style passthrough (StylePassthrough) to enabled to use the outline size data from your input captions, if present.

shadowColor

public final BurninSubtitleShadowColor shadowColor()

Specify the color of the shadow cast by the captions. Leave Shadow color (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow color data from your input captions, if present.

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

Returns:

Specify the color of the shadow cast by the captions. Leave Shadow color (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow color data from your input captions, if present.

See Also:

BurninSubtitleShadowColor

shadowColorAsString

public final String shadowColorAsString()

Specify the color of the shadow cast by the captions. Leave Shadow color (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow color data from your input captions, if present.

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

Returns:

Specify the color of the shadow cast by the captions. Leave Shadow color (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow color data from your input captions, if present.

See Also:

BurninSubtitleShadowColor

shadowOpacity

public final Integer shadowOpacity()

Specify the opacity of the shadow. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough (StylePassthrough) is set to Enabled, leave Shadow opacity (ShadowOpacity) blank to pass through the shadow style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all shadows from your output captions.

Returns:

Specify the opacity of the shadow. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough (StylePassthrough) is set to Enabled, leave Shadow opacity (ShadowOpacity) blank to pass through the shadow style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all shadows from your output captions.

shadowXOffset

public final Integer shadowXOffset()

Specify the horizontal offset of the shadow, relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left.

Returns:

Specify the horizontal offset of the shadow, relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left.

shadowYOffset

public final Integer shadowYOffset()

Specify the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. Leave Shadow y-offset (ShadowYOffset) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow y-offset data from your input captions, if present.

Returns:

Specify the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. Leave Shadow y-offset (ShadowYOffset) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow y-offset data from your input captions, if present.

stylePassthrough

public final BurnInSubtitleStylePassthrough stylePassthrough()

Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings.

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

Returns:

Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings.

See Also:

BurnInSubtitleStylePassthrough

stylePassthroughAsString

public final String stylePassthroughAsString()

Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings.

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

Returns:

Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings.

See Also:

BurnInSubtitleStylePassthrough

teletextSpacing

public final BurninSubtitleTeletextSpacing teletextSpacing()

Specify whether the text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions.

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

Returns:

Specify whether the text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions.

See Also:

BurninSubtitleTeletextSpacing

teletextSpacingAsString

public final String teletextSpacingAsString()

Specify whether the text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions.

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

Returns:

Specify whether the text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions.

See Also:

BurninSubtitleTeletextSpacing

xPosition

public final Integer xPosition()

Specify the horizontal position (XPosition) of the captions, relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter.

Returns:

Specify the horizontal position (XPosition) of the captions, relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter.

yPosition

public final Integer yPosition()

Specify the vertical position (YPosition) of the captions, relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output.

Returns:

Specify the vertical position (YPosition) of the captions, relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output.

toBuilder

public BurninDestinationSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BurninDestinationSettings.Builder,BurninDestinationSettings>

builder

public static BurninDestinationSettings.Builder builder()

serializableBuilderClass

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