Experimental
@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
CmafIngestOutputGroupProps Struct
Properties for a CMAF Ingest output group.
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 nielsenId3Behavior: medialive_alpha.NielsenId3Behavior;
declare const outputDestination: medialive_alpha.OutputDestination;
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 cmafIngestOutputGroupProps: medialive_alpha.CmafIngestOutputGroupProps = {
destinations: [outputDestination],
name: 'name',
outputs: [{
encode: encodeConfiguration,
outputName: 'outputName',
// the properties below are optional
captions: [encodeConfiguration],
nameModifier: 'nameModifier',
}],
// the properties below are optional
additionalDestinations: [outputDestination],
captionLanguageMappings: [{
captionChannel: 123,
languageCode: 'languageCode',
}],
id3Behavior: id3Behavior,
id3NameModifier: 'id3NameModifier',
klvBehavior: klvBehavior,
klvNameModifier: 'klvNameModifier',
nielsenId3Behavior: nielsenId3Behavior,
nielsenId3NameModifier: 'nielsenId3NameModifier',
scte35NameModifier: 'scte35NameModifier',
scte35Type: scte35Type,
segment: segment,
sendDelayMs: 123,
timedMetadataId3Frame: timedMetadataId3Frame,
timedMetadataId3Period: cdk.Duration.minutes(30),
timedMetadataPassthrough: timedMetadataPassthrough,
};
Properties
additionalDestinationsOutputDestination[]additional_destinationstyping.List[OutputDestination]additionalDestinationsList<OutputDestination>AdditionalDestinationsOutputDestination[]AdditionalDestinations*[]OutputDestination= no additional destinations#Configure additional destinations to fan out the CMAF ingest output to extra endpoints, for example for cross-region delivery or backup packaging.
Standard channels support up to 2 additional destinations. Single pipeline channels support 1 additional destination.
captionLanguageMappingsCmafCaptionLanguageMapping[]caption_language_mappingstyping.List[CmafCaptionLanguageMapping]captionLanguageMappingsList<CmafCaptionLanguageMapping>CaptionLanguageMappingsCmafCaptionLanguageMapping[]CaptionLanguageMappings*[]CmafCaptionLanguageMapping= no caption language mappings#Maps captions channels to languages for this CMAF Ingest output group.
destinationsOutputDestination[]destinationstyping.List[OutputDestination]destinationsList<OutputDestination>DestinationsOutputDestination[]Destinations*[]OutputDestinationrequired#The primary CMAF ingest destinations — one per pipeline.
notes
Array position determines the pipeline mapping:
destinations[0]→ Pipeline 0destinations[1]→ Pipeline 1 (STANDARD channels only)
For a SINGLE_PIPELINE channel, provide exactly 1 destination. For a STANDARD channel, provide exactly 2 destinations to utilise both pipelines for redundancy.
id3BehaviorId3Behaviorid3_behaviorId3Behaviorid3BehaviorId3BehaviorId3BehaviorId3BehaviorId3BehaviorId3Behavior= Id3Behavior.DISABLED#The ID3 behavior for the CMAF ingest output.
id3NameModifierstringid3_name_modifierstrid3NameModifierStringId3NameModifierstringId3NameModifier*string= service default#The name modifier for ID3 metadata.
klvBehaviorKlvBehaviorklv_behaviorKlvBehaviorklvBehaviorKlvBehaviorKlvBehaviorKlvBehaviorKlvBehaviorKlvBehavior= KlvBehavior.NO_PASSTHROUGH#The KLV behavior for the CMAF ingest output.
klvNameModifierstringklv_name_modifierstrklvNameModifierStringKlvNameModifierstringKlvNameModifier*string= service default#The name modifier for KLV metadata.
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 for the CMAF ingest output.
default
Default: NielsenId3Behavior.NO_PASSTHROUGH
nielsenId3NameModifierstringnielsen_id3_name_modifierstrnielsenId3NameModifierStringNielsenId3NameModifierstringNielsenId3NameModifier*string= service default#The name modifier for Nielsen ID3 metadata.
outputsCmafIngestOutputDefinition[]outputstyping.List[CmafIngestOutputDefinition]outputsList<CmafIngestOutputDefinition>OutputsCmafIngestOutputDefinition[]Outputs*[]CmafIngestOutputDefinitionrequired#The outputs for this CMAF Ingest output group.
Each output should contain a single encode.
scte35NameModifierstringscte35_name_modifierstrscte35NameModifierStringScte35NameModifierstringScte35NameModifier*string= service default#The name modifier for SCTE-35 messages.
scte35TypeScte35Typescte35_typeScte35Typescte35TypeScte35TypeScte35TypeScte35TypeScte35TypeScte35Type= Scte35Type.SCTE_35_WITHOUT_SEGME…#The SCTE-35 type for the CMAF ingest output.
default
Default: Scte35Type.SCTE_35_WITHOUT_SEGMENTATION
The length of each media segment.
sendDelayMsnumbersend_delay_msint | floatsendDelayMsNumberSendDelayMsdoubleSendDelayMs*float64= service default#The number of milliseconds to delay the output from the second pipeline.
timedMetadataId3FrameTimedMetadataId3Frametimed_metadata_id3_frameTimedMetadataId3FrametimedMetadataId3FrameTimedMetadataId3FrameTimedMetadataId3FrameTimedMetadataId3FrameTimedMetadataId3FrameTimedMetadataId3Frame= TimedMetadataId3Frame.NONE#Indicates the ID3 frame that has the timecode.
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