Skip to content
v2.275.0

Experimental

@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

CmafIngestOutputDefinition Struct ​

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 ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as medialive_alpha from '@aws-cdk/aws-medialive-alpha';

declare const encodeConfiguration: medialive_alpha.EncodeConfiguration;
const cmafIngestOutputDefinition: medialive_alpha.CmafIngestOutputDefinition = {
  encode: encodeConfiguration,
  outputName: 'outputName',

  // the properties below are optional
  captions: [encodeConfiguration],
  nameModifier: 'nameModifier',
};

Properties ​

captionsoptionalEncodeConfiguration[]captionsoptionaltyping.List[EncodeConfiguration]captionsoptionalList<EncodeConfiguration>CaptionsoptionalEncodeConfiguration[]Captionsoptional*[]EncodeConfiguration#
Caption encodes that ride alongside the primary encode.

Default: no captions on this output

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

The primary encode for this output — one video or one audio track.
nameModifieroptionalstringname_modifieroptionalstrnameModifieroptionalStringNameModifieroptionalstringNameModifieroptional*string#
A string concatenated to the end of the destination file name.

Default: no name modifier

outputNamestringoutput_namestroutputNameStringOutputNamestringOutputName*stringrequired#
The name of this output.

Must be unique across all outputs in the channel.