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
additionalDestinationsoptionalMediaPackageV2Destination[]additional_destinationsoptionaltyping.List[MediaPackageV2Destination]additionalDestinationsoptionalList<MediaPackageV2Destination>AdditionalDestinationsoptionalMediaPackageV2Destination[]AdditionalDestinationsoptional*[]MediaPackageV2Destination#Configure additional destinations to fan out the output to extra MediaPackage V2 channels, for example for cross-region delivery or backup packaging.
Default: no additional destinations
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.
captionLanguageMappingsoptionalCaptionLanguageMapping[]caption_language_mappingsoptionaltyping.List[CaptionLanguageMapping]captionLanguageMappingsoptionalList<CaptionLanguageMapping>CaptionLanguageMappingsoptionalCaptionLanguageMapping[]CaptionLanguageMappingsoptional*[]CaptionLanguageMapping#Caption language mappings for the MediaPackage V2 output.
Default: no caption language mappings
id3BehavioroptionalId3Behaviorid3_behavioroptionalId3Behaviorid3BehavioroptionalId3BehaviorId3BehavioroptionalId3BehaviorId3BehavioroptionalId3Behavior= Id3Behavior.DISABLED#The ID3 behavior.
klvBehavioroptionalKlvBehaviorklv_behavioroptionalKlvBehaviorklvBehavioroptionalKlvBehaviorKlvBehavioroptionalKlvBehaviorKlvBehavioroptionalKlvBehavior= KlvBehavior.NO_PASSTHROUGH#The KLV behavior.
The name of this output group.
Used as the destination reference ID. Underscores are normalised to hyphens internally.
nielsenId3BehavioroptionalNielsenId3Behaviornielsen_id3_behavioroptionalNielsenId3BehaviornielsenId3BehavioroptionalNielsenId3BehaviorNielsenId3BehavioroptionalNielsenId3BehaviorNielsenId3BehavioroptionalNielsenId3Behavior#The Nielsen ID3 behavior.
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.
scte35TypeoptionalScte35Typescte35_typeoptionalScte35Typescte35TypeoptionalScte35TypeScte35TypeoptionalScte35TypeScte35TypeoptionalScte35Type#The SCTE-35 type.
Default: Scte35Type.SCTE_35_WITHOUT_SEGMENTATION
segmentoptionalSegmentsegmentoptionalSegmentsegmentoptionalSegmentSegmentoptionalSegmentSegmentoptionalSegment= Segment.seconds(1)#The length of each media segment.
timedMetadataId3FrameoptionalTimedMetadataId3Frametimed_metadata_id3_frameoptionalTimedMetadataId3FrametimedMetadataId3FrameoptionalTimedMetadataId3FrameTimedMetadataId3FrameoptionalTimedMetadataId3FrameTimedMetadataId3FrameoptionalTimedMetadataId3Frame= TimedMetadataId3Frame.NONE#The timed metadata ID3 frame.
timedMetadataId3PeriodoptionalDurationtimed_metadata_id3_periodoptionalDurationtimedMetadataId3PeriodoptionalDurationTimedMetadataId3PeriodoptionalDurationTimedMetadataId3PeriodoptionalDuration= Duration.seconds(10)#The timed metadata interval.
timedMetadataPassthroughoptionalTimedMetadataPassthroughtimed_metadata_passthroughoptionalTimedMetadataPassthroughtimedMetadataPassthroughoptionalTimedMetadataPassthroughTimedMetadataPassthroughoptionalTimedMetadataPassthroughTimedMetadataPassthroughoptionalTimedMetadataPassthrough#Whether timed metadata is passed through.
Default: TimedMetadataPassthrough.DISABLED