Skip to content
v2.273.0

Experimental

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

MediaPackageV2OutputGroupBaseProps Struct ​

Common properties shared by the MediaPackage V2 output group variants.

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';
import * as cdk from 'aws-cdk-lib';

declare const encodeConfiguration: medialive_alpha.EncodeConfiguration;
declare const id3Behavior: medialive_alpha.Id3Behavior;
declare const klvBehavior: medialive_alpha.KlvBehavior;
declare const mediaPackageV2Destination: medialive_alpha.MediaPackageV2Destination;
declare const mediaPackageV2HlsSetting: medialive_alpha.MediaPackageV2HlsSetting;
declare const nielsenId3Behavior: medialive_alpha.NielsenId3Behavior;
declare const scte35Type: medialive_alpha.Scte35Type;
declare const segment: medialive_alpha.Segment;
declare const timedMetadataId3Frame: medialive_alpha.TimedMetadataId3Frame;
declare const timedMetadataPassthrough: medialive_alpha.TimedMetadataPassthrough;
const mediaPackageV2OutputGroupBaseProps: medialive_alpha.MediaPackageV2OutputGroupBaseProps = {
  name: 'name',
  outputs: [{
    encode: encodeConfiguration,
    outputName: 'outputName',

    // the properties below are optional
    audioGroupId: 'audioGroupId',
    audioRenditionSets: 'audioRenditionSets',
    captions: [encodeConfiguration],
    hlsAutoSelect: mediaPackageV2HlsSetting,
    hlsDefault: mediaPackageV2HlsSetting,
  }],

  // the properties below are optional
  additionalDestinations: [mediaPackageV2Destination],
  captionLanguageMappings: [{
    captionChannel: 123,
    languageCode: 'languageCode',
    languageDescription: 'languageDescription',
  }],
  id3Behavior: id3Behavior,
  klvBehavior: klvBehavior,
  nielsenId3Behavior: nielsenId3Behavior,
  scte35Type: scte35Type,
  segment: segment,
  timedMetadataId3Frame: timedMetadataId3Frame,
  timedMetadataId3Period: cdk.Duration.minutes(30),
  timedMetadataPassthrough: timedMetadataPassthrough,
};

Properties ​

additionalDestinationsMediaPackageV2Destination[]additional_destinationstyping.List[MediaPackageV2Destination]additionalDestinationsList<MediaPackageV2Destination>AdditionalDestinationsMediaPackageV2Destination[]AdditionalDestinations*[]MediaPackageV2Destination= no additional destinations#
Configure additional destinations to fan out the output to extra MediaPackage V2 channels, for example for cross-region delivery or backup packaging.

These correspond to Destination 3/4 in the AWS console. Each additional destination is a single, explicit entry (channel + endpoint), independent of the channel class.

captionLanguageMappingsCaptionLanguageMapping[]caption_language_mappingstyping.List[CaptionLanguageMapping]captionLanguageMappingsList<CaptionLanguageMapping>CaptionLanguageMappingsCaptionLanguageMapping[]CaptionLanguageMappings*[]CaptionLanguageMapping= no caption language mappings#
Caption language mappings for the MediaPackage V2 output.
id3BehaviorId3Behaviorid3_behaviorId3Behaviorid3BehaviorId3BehaviorId3BehaviorId3BehaviorId3BehaviorId3Behavior= Id3Behavior.DISABLED#
The ID3 behavior.
klvBehaviorKlvBehaviorklv_behaviorKlvBehaviorklvBehaviorKlvBehaviorKlvBehaviorKlvBehaviorKlvBehaviorKlvBehavior= KlvBehavior.NO_PASSTHROUGH#
The KLV behavior.
namestringnamestrnameStringNamestringName*stringrequired#
The name of this output group.

Used as the destination reference ID. Underscores are normalised to hyphens internally.

nielsenId3BehaviorNielsenId3Behaviornielsen_id3_behaviorNielsenId3BehaviornielsenId3BehaviorNielsenId3BehaviorNielsenId3BehaviorNielsenId3BehaviorNielsenId3BehaviorNielsenId3Behavior= NielsenId3Behavior.NO_PASSTHROUG…#
The Nielsen ID3 behavior.
default

Default: NielsenId3Behavior.NO_PASSTHROUGH

The outputs for this output group.

MediaPackage V2 uses CMAF ingest which requires one track per output. Create a separate output for each encode (e.g. one for HD video, one for SD video, one for audio). Do NOT put multiple encodes in a single output.

scte35TypeScte35Typescte35_typeScte35Typescte35TypeScte35TypeScte35TypeScte35TypeScte35TypeScte35Type= Scte35Type.SCTE_35_WITHOUT_SEGME…#
The SCTE-35 type.
default

Default: Scte35Type.SCTE_35_WITHOUT_SEGMENTATION

segmentSegmentsegmentSegmentsegmentSegmentSegmentSegmentSegmentSegment= Segment.seconds(1)#
The length of each media segment.
timedMetadataId3FrameTimedMetadataId3Frametimed_metadata_id3_frameTimedMetadataId3FrametimedMetadataId3FrameTimedMetadataId3FrameTimedMetadataId3FrameTimedMetadataId3FrameTimedMetadataId3FrameTimedMetadataId3Frame= TimedMetadataId3Frame.NONE#
The timed metadata ID3 frame.
timedMetadataId3PeriodDurationtimed_metadata_id3_periodDurationtimedMetadataId3PeriodDurationTimedMetadataId3PeriodDurationTimedMetadataId3PeriodDuration= Duration.seconds(10)#
The timed metadata interval.
timedMetadataPassthroughTimedMetadataPassthroughtimed_metadata_passthroughTimedMetadataPassthroughtimedMetadataPassthroughTimedMetadataPassthroughTimedMetadataPassthroughTimedMetadataPassthroughTimedMetadataPassthroughTimedMetadataPassthrough= TimedMetadataPassthrough.DISABLE…#
Whether timed metadata is passed through.
default

Default: TimedMetadataPassthrough.DISABLED