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

Interface CmafIngestOutputDefinition

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CmafIngestOutputDefinition.Jsii$Proxy

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

(experimental) Output definition for a CMAF Ingest output group.

CMAF Ingest requires one media track (video or audio) per output. In-band captions (burn-in, embedded) can ride alongside the primary encode.

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;
 CmafIngestOutputDefinition cmafIngestOutputDefinition = CmafIngestOutputDefinition.builder()
         .encode(encodeConfiguration)
         .outputName("outputName")
         // the properties below are optional
         .captions(List.of(encodeConfiguration))
         .nameModifier("nameModifier")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CmafIngestOutputDefinition.Builder	builder()
default List<EncodeConfiguration>	getCaptions()	(experimental) Caption encodes that ride alongside the primary encode.
EncodeConfiguration	getEncode()	(experimental) The primary encode for this output — one video or one audio track.
default String	getNameModifier()	(experimental) A string concatenated to the end of the destination file name.
String	getOutputName()	(experimental) The name of this output.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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.

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

getNameModifier

@Stability(Experimental)
@Nullable
default String getNameModifier()

(experimental) A string concatenated to the end of the destination file name.

Default: - no name modifier

builder

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

Returns:

a CmafIngestOutputDefinition.Builder of CmafIngestOutputDefinition