software.amazon.awssdk.services.mediaconvert.model

Class DvbSubDestinationSettings

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.DvbSubDestinationSettings

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<DvbSubDestinationSettings.Builder,DvbSubDestinationSettings>

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

DVB-Sub Destination Settings

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DvbSubDestinationSettings.Builder

Method Summary

Modifier and Type	Method and Description
DvbSubtitleAlignment	alignment() Returns the value of the Alignment property for this object.
String	alignmentString() Returns the value of the Alignment property for this object.
DvbSubtitleBackgroundColor	backgroundColor() Returns the value of the BackgroundColor property for this object.
String	backgroundColorString() Returns the value of the BackgroundColor property for this object.
Integer	backgroundOpacity() Specifies the opacity of the background rectangle.
static DvbSubDestinationSettings.Builder	builder()
boolean	equals(Object obj)
DvbSubtitleFontColor	fontColor() Returns the value of the FontColor property for this object.
String	fontColorString() Returns the value of the FontColor property for this object.
Integer	fontOpacity() Specifies the opacity of the burned-in captions.
Integer	fontResolution() Font resolution in DPI (dots per inch); default is 96 dpi.
Integer	fontSize() A positive integer indicates the exact font size in points.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
DvbSubtitleOutlineColor	outlineColor() Returns the value of the OutlineColor property for this object.
String	outlineColorString() Returns the value of the OutlineColor property for this object.
Integer	outlineSize() Specifies font outline size in pixels.
static Class<? extends DvbSubDestinationSettings.Builder>	serializableBuilderClass()
DvbSubtitleShadowColor	shadowColor() Returns the value of the ShadowColor property for this object.
String	shadowColorString() Returns the value of the ShadowColor property for this object.
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.
DvbSubtitleTeletextSpacing	teletextSpacing() Returns the value of the TeletextSpacing property for this object.
String	teletextSpacingString() Returns the value of the TeletextSpacing property for this object.
DvbSubDestinationSettings.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 DvbSubtitleAlignment alignment()

Returns the value of the Alignment property for this object.

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

Returns:

The value of the Alignment property for this object.

See Also:

DvbSubtitleAlignment

alignmentString

public String alignmentString()

Returns the value of the Alignment property for this object.

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

Returns:

The value of the Alignment property for this object.

See Also:

DvbSubtitleAlignment

backgroundColor

public DvbSubtitleBackgroundColor backgroundColor()

Returns the value of the BackgroundColor property for this object.

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

Returns:

The value of the BackgroundColor property for this object.

See Also:

DvbSubtitleBackgroundColor

backgroundColorString

public String backgroundColorString()

Returns the value of the BackgroundColor property for this object.

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

Returns:

The value of the BackgroundColor property for this object.

See Also:

DvbSubtitleBackgroundColor

backgroundOpacity

public Integer backgroundOpacity()

Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank 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 blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

fontColor

public DvbSubtitleFontColor fontColor()

Returns the value of the FontColor property for this object.

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

Returns:

The value of the FontColor property for this object.

See Also:

DvbSubtitleFontColor

fontColorString

public String fontColorString()

Returns the value of the FontColor property for this object.

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

Returns:

The value of the FontColor property for this object.

See Also:

DvbSubtitleFontColor

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 Integer fontSize()

A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.

Returns:

A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.

outlineColor

public DvbSubtitleOutlineColor outlineColor()

Returns the value of the OutlineColor property for this object.

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

Returns:

The value of the OutlineColor property for this object.

See Also:

DvbSubtitleOutlineColor

outlineColorString

public String outlineColorString()

Returns the value of the OutlineColor property for this object.

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

Returns:

The value of the OutlineColor property for this object.

See Also:

DvbSubtitleOutlineColor

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 DvbSubtitleShadowColor shadowColor()

Returns the value of the ShadowColor property for this object.

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

Returns:

The value of the ShadowColor property for this object.

See Also:

DvbSubtitleShadowColor

shadowColorString

public String shadowColorString()

Returns the value of the ShadowColor property for this object.

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

Returns:

The value of the ShadowColor property for this object.

See Also:

DvbSubtitleShadowColor

shadowOpacity

public Integer shadowOpacity()

Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank 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 blank 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.

teletextSpacing

public DvbSubtitleTeletextSpacing teletextSpacing()

Returns the value of the TeletextSpacing property for this object.

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

Returns:

The value of the TeletextSpacing property for this object.

See Also:

DvbSubtitleTeletextSpacing

teletextSpacingString

public String teletextSpacingString()

Returns the value of the TeletextSpacing property for this object.

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

Returns:

The value of the TeletextSpacing property for this object.

See Also:

DvbSubtitleTeletextSpacing

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 x_position is provided, the horizontal caption position will be determined by the alignment parameter. 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.

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 x_position is provided, the horizontal caption position will be determined by the alignment parameter. 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.

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 y_position is provided, the caption will be positioned towards the bottom of the output. 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.

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 y_position is provided, the caption will be positioned towards the bottom of the output. 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.

toBuilder

public DvbSubDestinationSettings.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<DvbSubDestinationSettings.Builder,DvbSubDestinationSettings>

Returns:

a builder for type T

builder

public static DvbSubDestinationSettings.Builder builder()

serializableBuilderClass

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