Package software.amazon.awscdk.services.medialive.alpha

Interface CaptionRectangle

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CaptionRectangle.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:40.956Z")
@Stability(Experimental)
public interface CaptionRectangle
extends software.amazon.jsii.JsiiSerializable

(experimental) A display rectangle, expressed as percentages of the underlying video frame, for captions converted to EBU-TT-D or TTML.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.medialive.alpha.*;
 CaptionRectangle captionRectangle = CaptionRectangle.builder()
         .height(123)
         .leftOffset(123)
         .topOffset(123)
         .width(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CaptionRectangle.Builder	A builder for CaptionRectangle
static final class	CaptionRectangle.Jsii$Proxy	An implementation for CaptionRectangle

Method Summary

Modifier and Type	Method	Description
static CaptionRectangle.Builder	builder()
Number	getHeight()	(experimental) Height of the rectangle, as a percentage of the frame height (0–100).
Number	getLeftOffset()	(experimental) Left edge position, as a percentage of the frame width (0–100).
Number	getTopOffset()	(experimental) Top edge position, as a percentage of the frame height (0–100).
Number	getWidth()	(experimental) Width of the rectangle, as a percentage of the frame width (0–100).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHeight

@Stability(Experimental)
@NotNull
Number getHeight()

(experimental) Height of the rectangle, as a percentage of the frame height (0–100).

getLeftOffset

@Stability(Experimental)
@NotNull
Number getLeftOffset()

(experimental) Left edge position, as a percentage of the frame width (0–100).

getTopOffset

@Stability(Experimental)
@NotNull
Number getTopOffset()

(experimental) Top edge position, as a percentage of the frame height (0–100).

getWidth

@Stability(Experimental)
@NotNull
Number getWidth()

(experimental) Width of the rectangle, as a percentage of the frame width (0–100).

builder

@Stability(Experimental)
static CaptionRectangle.Builder builder()

Returns:

a CaptionRectangle.Builder of CaptionRectangle