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

Class CaptionDestination

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.medialive.alpha.CaptionDestination
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:40.946Z") @Stability(Experimental) public abstract class CaptionDestination extends software.amazon.jsii.JsiiObject
(experimental) The output caption format for a caption encode.

Use the static factory methods to select one of the supported destination types.

Example: 

 // Define a caption selector on the input attachment (see Input Attachment Settings below)
 CaptionSelector captionSelector = CaptionSelector.embedded("captions");
 // WebVTT captions — packaged alongside the video encode in the same output
 EncodeConfiguration webvtt = EncodeConfiguration.caption(CaptionEncodeProps.builder()
         .name("eng_webvtt")
         .captionSelectorName(captionSelector.getName())
         .languageCode("eng")
         .languageDescription("English")
         .destination(CaptionDestination.webvtt())
         .build());
 // Burned-in captions — rendered into the video, styled via the burn-in options
 EncodeConfiguration burnIn = EncodeConfiguration.caption(CaptionEncodeProps.builder()
         .name("eng_burnin")
         .captionSelectorName(captionSelector.getName())
         .destination(CaptionDestination.burnIn(BurnInDestinationProps.builder()
                 .alignment(CaptionAlignment.CENTERED)
                 .fontColor(CaptionFontColor.WHITE)
                 .outlineColor(CaptionOutlineColor.BLACK)
                 .fontSize(CaptionFontSize.AUTO)
                 .build()))
         .build());

  • Constructor Details

    • CaptionDestination

      protected CaptionDestination(software.amazon.jsii.JsiiObjectRef objRef)

    • CaptionDestination

      protected CaptionDestination(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CaptionDestination

      @Stability(Experimental) protected CaptionDestination()

  • Method Details

    • arib

      @Stability(Experimental) @NotNull public static CaptionDestination arib()
      (experimental) ARIB captions.

    • burnIn

      @Stability(Experimental) @NotNull public static CaptionDestination burnIn(@Nullable BurnInDestinationProps props)
      (experimental) Burned-in captions rendered into the video.

      Parameters:
      props -

    • burnIn

      @Stability(Experimental) @NotNull public static CaptionDestination burnIn()
      (experimental) Burned-in captions rendered into the video.

    • dvbSub

      @Stability(Experimental) @NotNull public static CaptionDestination dvbSub(@Nullable DvbSubDestinationProps props)
      (experimental) DVB-Sub bitmap captions.

      Parameters:
      props -

    • dvbSub

      @Stability(Experimental) @NotNull public static CaptionDestination dvbSub()
      (experimental) DVB-Sub bitmap captions.

    • ebuTtD

      @Stability(Experimental) @NotNull public static CaptionDestination ebuTtD(@Nullable EbuTtDDestinationProps props)
      (experimental) EBU-TT-D sidecar captions.

      Parameters:
      props -

    • ebuTtD

      @Stability(Experimental) @NotNull public static CaptionDestination ebuTtD()
      (experimental) EBU-TT-D sidecar captions.

    • embedded

      @Stability(Experimental) @NotNull public static CaptionDestination embedded()
      (experimental) Embedded (CEA-608/708) captions.

    • embeddedPlusScte20

      @Stability(Experimental) @NotNull public static CaptionDestination embeddedPlusScte20()
      (experimental) Embedded plus SCTE-20 captions.

    • rtmpCaptionInfo

      @Stability(Experimental) @NotNull public static CaptionDestination rtmpCaptionInfo()
      (experimental) RTMP CaptionInfo captions.

    • scte20PlusEmbedded

      @Stability(Experimental) @NotNull public static CaptionDestination scte20PlusEmbedded()
      (experimental) SCTE-20 plus embedded captions.

    • smpteTt

      @Stability(Experimental) @NotNull public static CaptionDestination smpteTt()
      (experimental) SMPTE-TT sidecar captions.

    • teletext

      @Stability(Experimental) @NotNull public static CaptionDestination teletext()
      (experimental) Teletext captions.

    • ttml

      @Stability(Experimental) @NotNull public static CaptionDestination ttml(@Nullable TtmlDestinationProps props)
      (experimental) TTML sidecar captions.

      Parameters:
      props -

    • ttml

      @Stability(Experimental) @NotNull public static CaptionDestination ttml()
      (experimental) TTML sidecar captions.

    • webvtt

      @Stability(Experimental) @NotNull public static CaptionDestination webvtt(@Nullable WebvttDestinationProps props)
      (experimental) WebVTT sidecar captions.

      Parameters:
      props -

    • webvtt

      @Stability(Experimental) @NotNull public static CaptionDestination webvtt()
      (experimental) WebVTT sidecar captions.