software.amazon.awssdk.services.medialive.model

Class BurnInDestinationSettings

java.lang.Object

software.amazon.awssdk.services.medialive.model.BurnInDestinationSettings

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<BurnInDestinationSettings.Builder,BurnInDestinationSettings>

@Generated(value="software.amazon.awssdk:codegen")
public class BurnInDestinationSettings
extends Object
implements StructuredPojo, ToCopyableBuilder<BurnInDestinationSettings.Builder,BurnInDestinationSettings>

Placeholder documentation for BurnInDestinationSettings

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BurnInDestinationSettings.Builder

Method Summary

Modifier and Type	Method and Description
BurnInAlignment	alignment() If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output.
String	alignmentString() If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output.
BurnInBackgroundColor	backgroundColor() Specifies the color of the rectangle behind the captions.
String	backgroundColorString() Specifies the color of the rectangle behind the captions.
Integer	backgroundOpacity() Specifies the opacity of the background rectangle.
static BurnInDestinationSettings.Builder	builder()
boolean	equals(Object obj)
InputLocation	font() External font file used for caption burn-in.
BurnInFontColor	fontColor() Specifies the color of the burned-in captions.
String	fontColorString() Specifies the color of the burned-in captions.
Integer	fontOpacity() Specifies the opacity of the burned-in captions.
Integer	fontResolution() Font resolution in DPI (dots per inch); default is 96 dpi.
String	fontSize() When set to 'auto' fontSize will scale depending on the size of the output.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
BurnInOutlineColor	outlineColor() Specifies font outline color.
String	outlineColorString() Specifies font outline color.
Integer	outlineSize() Specifies font outline size in pixels.
static Class<? extends BurnInDestinationSettings.Builder>	serializableBuilderClass()
BurnInShadowColor	shadowColor() Specifies the color of the shadow cast by the captions.
String	shadowColorString() Specifies the color of the shadow cast by the captions.
Integer	shadowOpacity() Specifies the opacity of the shadow.
Integer	shadowXOffset() Specifies the horizontal offset of the shadow relative to the captions in pixels.
Integer	shadowYOffset() Specifies the vertical offset of the shadow relative to the captions in pixels.
BurnInTeletextGridControl	teletextGridControl() Controls whether a fixed grid size will be used to generate the output subtitles bitmap.
String	teletextGridControlString() Controls whether a fixed grid size will be used to generate the output subtitles bitmap.
BurnInDestinationSettings.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Integer	xPosition() Specifies the horizontal position of the caption relative to the left side of the output in pixels.
Integer	yPosition() Specifies the vertical position of the caption relative to the top of the output in pixels.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

alignment

public BurnInAlignment alignment()

If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align 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. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.

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

Returns:

If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align 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. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.

See Also:

BurnInAlignment

alignmentString

public String alignmentString()

If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align 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. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.

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

Returns:

If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align 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. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.

See Also:

BurnInAlignment

backgroundColor

public BurnInBackgroundColor backgroundColor()

Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.

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

Returns:

Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.

See Also:

BurnInBackgroundColor

backgroundColorString

public String backgroundColorString()

Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.

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

Returns:

Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.

See Also:

BurnInBackgroundColor

backgroundOpacity

public Integer backgroundOpacity()

Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

Returns:

Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

font

public InputLocation font()

External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.

Returns:

External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.

fontColor

public BurnInFontColor fontColor()

Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

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

Returns:

Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

See Also:

BurnInFontColor

fontColorString

public String fontColorString()

Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

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

Returns:

Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

See Also:

BurnInFontColor

fontOpacity

public Integer fontOpacity()

Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.

Returns:

Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.

fontResolution

public Integer fontResolution()

Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.

Returns:

Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.

fontSize

public String fontSize()

When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.

Returns:

When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.

outlineColor

public BurnInOutlineColor outlineColor()

Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

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

Returns:

Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

See Also:

BurnInOutlineColor

outlineColorString

public String outlineColorString()

Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

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

Returns:

Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

See Also:

BurnInOutlineColor

outlineSize

public Integer outlineSize()

Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

Returns:

Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

shadowColor

public BurnInShadowColor shadowColor()

Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.

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

Returns:

Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.

See Also:

BurnInShadowColor

shadowColorString

public String shadowColorString()

Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.

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

Returns:

Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.

See Also:

BurnInShadowColor

shadowOpacity

public Integer shadowOpacity()

Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

Returns:

Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

shadowXOffset

public Integer shadowXOffset()

Specifies 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. All burn-in and DVB-Sub font settings must match.

Returns:

Specifies 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. All burn-in and DVB-Sub font settings must match.

shadowYOffset

public Integer shadowYOffset()

Specifies 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. All burn-in and DVB-Sub font settings must match.

Returns:

Specifies 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. All burn-in and DVB-Sub font settings must match.

teletextGridControl

public BurnInTeletextGridControl teletextGridControl()

Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.

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

Returns:

Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.

See Also:

BurnInTeletextGridControl

teletextGridControlString

public String teletextGridControlString()

Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.

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

Returns:

Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.

See Also:

BurnInTeletextGridControl

xPosition

public Integer xPosition()

Specifies the horizontal position of the caption 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 xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.

Returns:

Specifies the horizontal position of the caption 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 xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.

yPosition

public Integer yPosition()

Specifies the vertical position of the caption 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 yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.

Returns:

Specifies the vertical position of the caption 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 yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.

toBuilder

public BurnInDestinationSettings.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<BurnInDestinationSettings.Builder,BurnInDestinationSettings>

Returns:

a builder for type T

builder

public static BurnInDestinationSettings.Builder builder()

serializableBuilderClass

public static Class<? extends BurnInDestinationSettings.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.