@aws-cdk/aws-medialive-alpha.MediaPackageV2OutputGroupProps

Experimental

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

MediaPackageV2OutputGroupProps Struct

Properties for a MediaPackage V2 output group.

Reference a single MediaPackage V2 channel; MediaLive wires each channel pipeline to a MediaPackage ingest endpoint automatically (one for SINGLE_PIPELINE, both for STANDARD). For per-pipeline control — for example sending pipeline 0 to a specific endpoint of a channel in another region — use OutputGroupConfiguration.mediaPackageV2PerPipeline() instead.

MediaPackageV2OutputGroupProps

extends

• MediaPackageV2OutputGroupBaseProps

Stability

Experimental

Source

lib/output-group.ts

Example

declare const primaryChannel: mediapackagev2.IChannel;
declare const video: medialive.EncodeConfiguration;
declare const audio: medialive.EncodeConfiguration;

// Import a channel from another region — the region travels with the channel
const backupChannel = mediapackagev2.Channel.fromChannelAttributes(this, 'BackupChannel', {
  channelName: 'backup-channel',
  channelGroupName: 'backup-group',
  region: 'us-west-2',
});

medialive.OutputGroupConfiguration.mediaPackageV2({
  name: 'emp',
  channel: primaryChannel,
  additionalDestinations: [
    // Cross-region: the destination picks up us-west-2 from the imported channel
    medialive.MediaPackageV2Destination.channel(backupChannel, medialive.MediaPackageV2EndpointId.ENDPOINT_1),
  ],
  outputs: [
    { encode: video, outputName: 'video' },
    { encode: audio, outputName: 'audio' },
  ],
});

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.

channelIChannelchannelIChannelchannelIChannelChannelIChannelChannelIChannelrequired#

The MediaPackage V2 channel to deliver to.

MediaLive maps the channel pipelines to the channel's ingest endpoints automatically based on the channel class.

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

outputsMediaPackageV2OutputDefinition[]outputstyping.List[MediaPackageV2OutputDefinition]outputsList<MediaPackageV2OutputDefinition>OutputsMediaPackageV2OutputDefinition[]Outputs*[]MediaPackageV2OutputDefinitionrequired#

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