| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.MediaLive.Types.CaptionRectangle
Description
Synopsis
- data CaptionRectangle = CaptionRectangle' {}
- newCaptionRectangle :: Double -> Double -> Double -> Double -> CaptionRectangle
- captionRectangle_topOffset :: Lens' CaptionRectangle Double
- captionRectangle_height :: Lens' CaptionRectangle Double
- captionRectangle_width :: Lens' CaptionRectangle Double
- captionRectangle_leftOffset :: Lens' CaptionRectangle Double
Documentation
data CaptionRectangle Source #
Caption Rectangle
See: newCaptionRectangle smart constructor.
Constructors
| CaptionRectangle' | |
Fields
| |
Instances
Arguments
| :: Double | |
| -> Double | |
| -> Double | |
| -> Double | |
| -> CaptionRectangle |
Create a value of CaptionRectangle with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:topOffset:CaptionRectangle', captionRectangle_topOffset - See the description in leftOffset. For topOffset, specify the position
of the top edge of the rectangle, as a percentage of the underlying
frame height, and relative to the top edge of the frame. For example,
\"10\" means the measurement is 10% of the underlying frame height.
The rectangle top edge starts at that position from the top edge of the
frame. This field corresponds to tts:origin - Y in the TTML standard.
$sel:height:CaptionRectangle', captionRectangle_height - See the description in leftOffset. For height, specify the entire height
of the rectangle as a percentage of the underlying frame height. For
example, \"80\" means the rectangle height is 80% of the underlying
frame height. The topOffset and rectangleHeight must add up to 100% or
less. This field corresponds to tts:extent - Y in the TTML standard.
$sel:width:CaptionRectangle', captionRectangle_width - See the description in leftOffset. For width, specify the entire width
of the rectangle as a percentage of the underlying frame width. For
example, \"80\" means the rectangle width is 80% of the underlying
frame width. The leftOffset and rectangleWidth must add up to 100% or
less. This field corresponds to tts:extent - X in the TTML standard.
$sel:leftOffset:CaptionRectangle', captionRectangle_leftOffset - Applies only if you plan to convert these source captions to EBU-TT-D or
TTML in an output. (Make sure to leave the default if you don't have
either of these formats in the output.) You can define a display
rectangle for the captions that is smaller than the underlying video
frame. You define the rectangle by specifying the position of the left
edge, top edge, bottom edge, and right edge of the rectangle, all within
the underlying video frame. The units for the measurements are
percentages. If you specify a value for one of these fields, you must
specify a value for all of them. For leftOffset, specify the position of
the left edge of the rectangle, as a percentage of the underlying frame
width, and relative to the left edge of the frame. For example,
\"10\" means the measurement is 10% of the underlying frame width.
The rectangle left edge starts at that position from the left edge of
the frame. This field corresponds to tts:origin - X in the TTML
standard.
captionRectangle_topOffset :: Lens' CaptionRectangle Double Source #
See the description in leftOffset. For topOffset, specify the position of the top edge of the rectangle, as a percentage of the underlying frame height, and relative to the top edge of the frame. For example, \"10\" means the measurement is 10% of the underlying frame height. The rectangle top edge starts at that position from the top edge of the frame. This field corresponds to tts:origin - Y in the TTML standard.
captionRectangle_height :: Lens' CaptionRectangle Double Source #
See the description in leftOffset. For height, specify the entire height of the rectangle as a percentage of the underlying frame height. For example, \"80\" means the rectangle height is 80% of the underlying frame height. The topOffset and rectangleHeight must add up to 100% or less. This field corresponds to tts:extent - Y in the TTML standard.
captionRectangle_width :: Lens' CaptionRectangle Double Source #
See the description in leftOffset. For width, specify the entire width of the rectangle as a percentage of the underlying frame width. For example, \"80\" means the rectangle width is 80% of the underlying frame width. The leftOffset and rectangleWidth must add up to 100% or less. This field corresponds to tts:extent - X in the TTML standard.
captionRectangle_leftOffset :: Lens' CaptionRectangle Double Source #
Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. (Make sure to leave the default if you don't have either of these formats in the output.) You can define a display rectangle for the captions that is smaller than the underlying video frame. You define the rectangle by specifying the position of the left edge, top edge, bottom edge, and right edge of the rectangle, all within the underlying video frame. The units for the measurements are percentages. If you specify a value for one of these fields, you must specify a value for all of them. For leftOffset, specify the position of the left edge of the rectangle, as a percentage of the underlying frame width, and relative to the left edge of the frame. For example, \"10\" means the measurement is 10% of the underlying frame width. The rectangle left edge starts at that position from the left edge of the frame. This field corresponds to tts:origin - X in the TTML standard.