Class DvbSubDestinationSettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DvbSubDestinationSettings.Builder,
DvbSubDestinationSettings>
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionIf no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output.final String
If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output.Specifies the color of the rectangle behind the captions.final String
Specifies the color of the rectangle behind the captions.final Integer
Specifies the opacity of the background rectangle.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final InputLocation
font()
External font file used for caption burn-in.Specifies the color of the burned-in captions.final String
Specifies the color of the burned-in captions.final Integer
Specifies the opacity of the burned-in captions.final Integer
Font resolution in DPI (dots per inch); default is 96 dpi.final String
fontSize()
When set to auto fontSize will scale depending on the size of the output.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
Specifies font outline color.final String
Specifies font outline color.final Integer
Specifies font outline size in pixels.static Class
<? extends DvbSubDestinationSettings.Builder> Specifies the color of the shadow cast by the captions.final String
Specifies the color of the shadow cast by the captions.final Integer
Specifies the opacity of the shadow.final Integer
Specifies the horizontal offset of the shadow relative to the captions in pixels.final Integer
Specifies the vertical offset of the shadow relative to the captions in pixels.Controls whether a fixed grid size will be used to generate the output subtitles bitmap.final String
Controls whether a fixed grid size will be used to generate the output subtitles bitmap.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
Specifies the horizontal position of the caption relative to the left side of the output in pixels.final Integer
Specifies the vertical position of the caption relative to the top of the output in pixels.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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. This option is not valid for source captions that are STL or 608/embedded. 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,
alignment
will returnDvbSubDestinationAlignment.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromalignmentAsString()
.- 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. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
- See Also:
-
alignmentAsString
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. This option is not valid for source captions that are STL or 608/embedded. 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,
alignment
will returnDvbSubDestinationAlignment.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromalignmentAsString()
.- 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. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
- See Also:
-
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 returnDvbSubDestinationBackgroundColor.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombackgroundColorAsString()
.- Returns:
- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
- See Also:
-
backgroundColorAsString
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 returnDvbSubDestinationBackgroundColor.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombackgroundColorAsString()
.- Returns:
- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
- See Also:
-
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.
-
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
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 returnDvbSubDestinationFontColor.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfontColorAsString()
.- 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:
-
fontColorAsString
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 returnDvbSubDestinationFontColor.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfontColorAsString()
.- 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:
-
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
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
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
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 returnDvbSubDestinationOutlineColor.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutlineColorAsString()
.- 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:
-
outlineColorAsString
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 returnDvbSubDestinationOutlineColor.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutlineColorAsString()
.- 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:
-
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
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 returnDvbSubDestinationShadowColor.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromshadowColorAsString()
.- Returns:
- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
- See Also:
-
shadowColorAsString
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 returnDvbSubDestinationShadowColor.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromshadowColorAsString()
.- Returns:
- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
- See Also:
-
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
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
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
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 returnDvbSubDestinationTeletextGridControl.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromteletextGridControlAsString()
.- 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:
-
teletextGridControlAsString
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 returnDvbSubDestinationTeletextGridControl.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromteletextGridControlAsString()
.- 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:
-
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. 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 xPosition 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
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. 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 yPosition 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
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 interfaceToCopyableBuilder<DvbSubDestinationSettings.Builder,
DvbSubDestinationSettings> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-