public static interface BurnInDestinationSettings.Builder extends CopyableBuilder<BurnInDestinationSettings.Builder,BurnInDestinationSettings>
Modifier and Type | Method and Description |
---|---|
BurnInDestinationSettings.Builder |
alignment(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.
|
BurnInDestinationSettings.Builder |
alignment(String alignment)
If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at
the bottom center of the output.
|
BurnInDestinationSettings.Builder |
backgroundColor(BurnInBackgroundColor backgroundColor)
Specifies the color of the rectangle behind the captions.
|
BurnInDestinationSettings.Builder |
backgroundColor(String backgroundColor)
Specifies the color of the rectangle behind the captions.
|
BurnInDestinationSettings.Builder |
backgroundOpacity(Integer backgroundOpacity)
Specifies the opacity of the background rectangle.
|
default BurnInDestinationSettings.Builder |
font(Consumer<InputLocation.Builder> font)
External font file used for caption burn-in.
|
BurnInDestinationSettings.Builder |
font(InputLocation font)
External font file used for caption burn-in.
|
BurnInDestinationSettings.Builder |
fontColor(BurnInFontColor fontColor)
Specifies the color of the burned-in captions.
|
BurnInDestinationSettings.Builder |
fontColor(String fontColor)
Specifies the color of the burned-in captions.
|
BurnInDestinationSettings.Builder |
fontOpacity(Integer fontOpacity)
Specifies the opacity of the burned-in captions.
|
BurnInDestinationSettings.Builder |
fontResolution(Integer fontResolution)
Font resolution in DPI (dots per inch); default is 96 dpi.
|
BurnInDestinationSettings.Builder |
fontSize(String fontSize)
When set to 'auto' fontSize will scale depending on the size of the output.
|
BurnInDestinationSettings.Builder |
outlineColor(BurnInOutlineColor outlineColor)
Specifies font outline color.
|
BurnInDestinationSettings.Builder |
outlineColor(String outlineColor)
Specifies font outline color.
|
BurnInDestinationSettings.Builder |
outlineSize(Integer outlineSize)
Specifies font outline size in pixels.
|
BurnInDestinationSettings.Builder |
shadowColor(BurnInShadowColor shadowColor)
Specifies the color of the shadow cast by the captions.
|
BurnInDestinationSettings.Builder |
shadowColor(String shadowColor)
Specifies the color of the shadow cast by the captions.
|
BurnInDestinationSettings.Builder |
shadowOpacity(Integer shadowOpacity)
Specifies the opacity of the shadow.
|
BurnInDestinationSettings.Builder |
shadowXOffset(Integer shadowXOffset)
Specifies the horizontal offset of the shadow relative to the captions in pixels.
|
BurnInDestinationSettings.Builder |
shadowYOffset(Integer shadowYOffset)
Specifies the vertical offset of the shadow relative to the captions in pixels.
|
BurnInDestinationSettings.Builder |
teletextGridControl(BurnInTeletextGridControl teletextGridControl)
Controls whether a fixed grid size will be used to generate the output subtitles bitmap.
|
BurnInDestinationSettings.Builder |
teletextGridControl(String teletextGridControl)
Controls whether a fixed grid size will be used to generate the output subtitles bitmap.
|
BurnInDestinationSettings.Builder |
xPosition(Integer xPosition)
Specifies the horizontal position of the caption relative to the left side of the output in pixels.
|
BurnInDestinationSettings.Builder |
yPosition(Integer yPosition)
Specifies the vertical position of the caption relative to the top of the output in pixels.
|
copy
applyMutation, build
BurnInDestinationSettings.Builder alignment(String alignment)
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.BurnInAlignment
,
BurnInAlignment
BurnInDestinationSettings.Builder alignment(BurnInAlignment alignment)
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.BurnInAlignment
,
BurnInAlignment
BurnInDestinationSettings.Builder backgroundColor(String backgroundColor)
backgroundColor
- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must
match.BurnInBackgroundColor
,
BurnInBackgroundColor
BurnInDestinationSettings.Builder backgroundColor(BurnInBackgroundColor backgroundColor)
backgroundColor
- Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must
match.BurnInBackgroundColor
,
BurnInBackgroundColor
BurnInDestinationSettings.Builder backgroundOpacity(Integer backgroundOpacity)
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.BurnInDestinationSettings.Builder font(InputLocation font)
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.default BurnInDestinationSettings.Builder font(Consumer<InputLocation.Builder> font)
InputLocation.Builder
avoiding the need to create one manually via
InputLocation.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to font(InputLocation)
.font
- a consumer that will call methods on InputLocation.Builder
font(InputLocation)
BurnInDestinationSettings.Builder fontColor(String fontColor)
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.BurnInFontColor
,
BurnInFontColor
BurnInDestinationSettings.Builder fontColor(BurnInFontColor fontColor)
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.BurnInFontColor
,
BurnInFontColor
BurnInDestinationSettings.Builder fontOpacity(Integer fontOpacity)
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.BurnInDestinationSettings.Builder fontResolution(Integer fontResolution)
fontResolution
- Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must
match.BurnInDestinationSettings.Builder fontSize(String fontSize)
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.BurnInDestinationSettings.Builder outlineColor(String outlineColor)
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.BurnInOutlineColor
,
BurnInOutlineColor
BurnInDestinationSettings.Builder outlineColor(BurnInOutlineColor outlineColor)
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.BurnInOutlineColor
,
BurnInOutlineColor
BurnInDestinationSettings.Builder outlineSize(Integer outlineSize)
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.BurnInDestinationSettings.Builder shadowColor(String shadowColor)
shadowColor
- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must
match.BurnInShadowColor
,
BurnInShadowColor
BurnInDestinationSettings.Builder shadowColor(BurnInShadowColor shadowColor)
shadowColor
- Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must
match.BurnInShadowColor
,
BurnInShadowColor
BurnInDestinationSettings.Builder shadowOpacity(Integer shadowOpacity)
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.BurnInDestinationSettings.Builder shadowXOffset(Integer shadowXOffset)
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.BurnInDestinationSettings.Builder shadowYOffset(Integer shadowYOffset)
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.BurnInDestinationSettings.Builder teletextGridControl(String teletextGridControl)
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.BurnInTeletextGridControl
,
BurnInTeletextGridControl
BurnInDestinationSettings.Builder teletextGridControl(BurnInTeletextGridControl teletextGridControl)
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.BurnInTeletextGridControl
,
BurnInTeletextGridControl
BurnInDestinationSettings.Builder xPosition(Integer xPosition)
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.BurnInDestinationSettings.Builder yPosition(Integer yPosition)
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.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.