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

Interface MediaPackageV2OutputDefinition

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
MediaPackageV2OutputDefinition.Jsii$Proxy
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:41.240Z") @Stability(Experimental) public interface MediaPackageV2OutputDefinition extends software.amazon.jsii.JsiiSerializable
(experimental) Output definition for a MediaPackage V2 output group.

MediaPackage V2 uses CMAF ingest which requires one media track (video or audio) per output. In-band captions (burn-in, embedded) can ride alongside the primary encode because they do not produce a separate track.

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.*;
 EncodeConfiguration encodeConfiguration;
 MediaPackageV2HlsSetting mediaPackageV2HlsSetting;
 MediaPackageV2OutputDefinition mediaPackageV2OutputDefinition = MediaPackageV2OutputDefinition.builder()
         .encode(encodeConfiguration)
         .outputName("outputName")
         // the properties below are optional
         .audioGroupId("audioGroupId")
         .audioRenditionSets("audioRenditionSets")
         .captions(List.of(encodeConfiguration))
         .hlsAutoSelect(mediaPackageV2HlsSetting)
         .hlsDefault(mediaPackageV2HlsSetting)
         .build();

  • Method Details

    • getEncode

      @Stability(Experimental) @NotNull EncodeConfiguration getEncode()
      (experimental) The primary encode for this output — one video or one audio track.

    • getOutputName

      @Stability(Experimental) @NotNull String getOutputName()
      (experimental) The name of this output.

      Must be unique across all outputs in the channel.

    • getAudioGroupId

      @Stability(Experimental) @Nullable default String getAudioGroupId()
      (experimental) The audio group ID for audio outputs.

      Default: - service default

    • getAudioRenditionSets

      @Stability(Experimental) @Nullable default String getAudioRenditionSets()
      (experimental) The audio rendition sets for video outputs.

      Default: - service default

    • getCaptions

      @Stability(Experimental) @Nullable default List<EncodeConfiguration> getCaptions()
      (experimental) Caption encodes that ride alongside the primary encode.

      Only in-band caption types are allowed (burn-in, embedded) — out-of-band captions must go in their own output.

      Default: - no captions on this output

    • getHlsAutoSelect

      @Stability(Experimental) @Nullable default MediaPackageV2HlsSetting getHlsAutoSelect()
      (experimental) For audio outputs, whether MediaPackage sets this rendition as the auto-select rendition in the HLS manifest.

      Default: MediaPackageV2HlsSetting.OMIT

    • getHlsDefault

      @Stability(Experimental) @Nullable default MediaPackageV2HlsSetting getHlsDefault()
      (experimental) For audio outputs, whether MediaPackage sets this rendition as the default rendition in the HLS manifest.

      Default: MediaPackageV2HlsSetting.OMIT

    • builder

      @Stability(Experimental) static MediaPackageV2OutputDefinition.Builder builder()
      Returns:
      a MediaPackageV2OutputDefinition.Builder of MediaPackageV2OutputDefinition