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

Class CaptionAlignment

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.medialive.alpha.CaptionAlignment
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:40.944Z") @Stability(Experimental) public class CaptionAlignment extends software.amazon.jsii.JsiiObject
(experimental) Caption alignment for burn-in and DVB-Sub outputs.

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());

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final CaptionAlignment
    CENTERED
    (experimental) Center the captions.
    static final CaptionAlignment
    LEFT
    (experimental) Left-align the captions.
    static final CaptionAlignment
    SMART
    (experimental) Smart: left-justify live subtitles, center-justify pre-recorded subtitles.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    CaptionAlignment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    CaptionAlignment(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getValue()
    (experimental) The underlying string value passed to CloudFormation.
    static CaptionAlignment
    of(String value)
    (experimental) A value not yet modelled by AWS CDK.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Field Details

    • CENTERED

      @Stability(Experimental) public static final CaptionAlignment CENTERED
      (experimental) Center the captions.

    • LEFT

      @Stability(Experimental) public static final CaptionAlignment LEFT
      (experimental) Left-align the captions.

    • SMART

      @Stability(Experimental) public static final CaptionAlignment SMART
      (experimental) Smart: left-justify live subtitles, center-justify pre-recorded subtitles.

  • Constructor Details

    • CaptionAlignment

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

    • CaptionAlignment

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

  • Method Details

    • of

      @Stability(Experimental) @NotNull public static CaptionAlignment of(@NotNull String value)
      (experimental) A value not yet modelled by AWS CDK.

      Parameters:
      value - This parameter is required.

    • getValue

      @Stability(Experimental) @NotNull public String getValue()
      (experimental) The underlying string value passed to CloudFormation.