Amazonka.MediaLive.Types.CaptionRectangle

Documentation

data CaptionRectangle

Caption Rectangle

See: newCaptionRectangle smart constructor.

Constructors

CaptionRectangle'

Fields

• topOffset :: Double

  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.

• height :: Double

  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.

• width :: Double

  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.

• leftOffset :: Double

  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.

Instances

FromJSON CaptionRectangle

Defined in Amazonka.MediaLive.Types.CaptionRectangle

Methods

parseJSON :: Value -> Parser CaptionRectangle

parseJSONList :: Value -> Parser [CaptionRectangle]

ToJSON CaptionRectangle

Defined in Amazonka.MediaLive.Types.CaptionRectangle

Methods

toJSON :: CaptionRectangle -> Value

toEncoding :: CaptionRectangle -> Encoding

toJSONList :: [CaptionRectangle] -> Value

toEncodingList :: [CaptionRectangle] -> Encoding

Generic CaptionRectangle

Defined in Amazonka.MediaLive.Types.CaptionRectangle

Associated Types

type Rep CaptionRectangle :: Type -> Type

Methods

from :: CaptionRectangle -> Rep CaptionRectangle x

to :: Rep CaptionRectangle x -> CaptionRectangle

Read CaptionRectangle

Defined in Amazonka.MediaLive.Types.CaptionRectangle

Methods

readsPrec :: Int -> ReadS CaptionRectangle

readList :: ReadS [CaptionRectangle]

readPrec :: ReadPrec CaptionRectangle

readListPrec :: ReadPrec [CaptionRectangle]

Show CaptionRectangle

Defined in Amazonka.MediaLive.Types.CaptionRectangle

Methods

showsPrec :: Int -> CaptionRectangle -> ShowS

show :: CaptionRectangle -> String

showList :: [CaptionRectangle] -> ShowS

NFData CaptionRectangle

Defined in Amazonka.MediaLive.Types.CaptionRectangle

Methods

rnf :: CaptionRectangle -> ()

Eq CaptionRectangle

Defined in Amazonka.MediaLive.Types.CaptionRectangle

Methods

(==) :: CaptionRectangle -> CaptionRectangle -> Bool

(/=) :: CaptionRectangle -> CaptionRectangle -> Bool

Hashable CaptionRectangle

Defined in Amazonka.MediaLive.Types.CaptionRectangle

Methods

hashWithSalt :: Int -> CaptionRectangle -> Int

hash :: CaptionRectangle -> Int

type Rep CaptionRectangle

Defined in Amazonka.MediaLive.Types.CaptionRectangle

type Rep CaptionRectangle = D1 ('MetaData "CaptionRectangle" "Amazonka.MediaLive.Types.CaptionRectangle" "amazonka-medialive-2.0-FK9HUAz0OmeIH2i6eRdod0" 'False) (C1 ('MetaCons "CaptionRectangle'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "topOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)) :*: (S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "leftOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double))))

newCaptionRectangle

Arguments

:: Double

$sel:topOffset:CaptionRectangle'

-> Double

$sel:height:CaptionRectangle'

-> Double

$sel:width:CaptionRectangle'

-> Double

$sel:leftOffset:CaptionRectangle'

-> 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

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

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

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

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.