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

Class EncodeConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.medialive.alpha.EncodeConfiguration
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:41.047Z") @Stability(Experimental) public abstract class EncodeConfiguration extends software.amazon.jsii.JsiiObject
(experimental) Base interface for an encode configuration (video, audio, or caption).

The same EncodeConfiguration instance can be shared across multiple output groups within a channel. The channel automatically deduplicates encode descriptions by name at synth time.

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

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static EncodeConfiguration
    audio(AudioEncodeProps props)
    (experimental) Create an audio encode configuration.
    static EncodeConfiguration
    caption(CaptionEncodeProps props)
    (experimental) Create a caption encode configuration.
    abstract String
    getName()
    (experimental) The unique name for this encode, used to reference it from outputs.
    static EncodeConfiguration
    video(VideoEncodeProps props)
    (experimental) Create a video encode configuration.

    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

  • Constructor Details

    • EncodeConfiguration

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

    • EncodeConfiguration

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

    • EncodeConfiguration

      @Stability(Experimental) protected EncodeConfiguration()

  • Method Details

    • audio

      @Stability(Experimental) @NotNull public static EncodeConfiguration audio(@NotNull AudioEncodeProps props)
      (experimental) Create an audio encode configuration.

      Parameters:
      props - This parameter is required.

    • caption

      @Stability(Experimental) @NotNull public static EncodeConfiguration caption(@NotNull CaptionEncodeProps props)
      (experimental) Create a caption encode configuration.

      Parameters:
      props - This parameter is required.

    • video

      @Stability(Experimental) @NotNull public static EncodeConfiguration video(@NotNull VideoEncodeProps props)
      (experimental) Create a video encode configuration.

      Parameters:
      props - This parameter is required.

    • getName

      @Stability(Experimental) @NotNull public abstract String getName()
      (experimental) The unique name for this encode, used to reference it from outputs.