Experimental
@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
MediaPackageV2OutputDefinition Struct
Output definition for a MediaPackage V2 output group.
MediaPackage V2 uses CMAF ingest which requires one media track (video or audio) per output. In-band captions (burn-in, embedded) can ride alongside the primary encode because they do not produce a separate track.
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;
declare const mediaPackageV2HlsSetting: medialive_alpha.MediaPackageV2HlsSetting;
const mediaPackageV2OutputDefinition: medialive_alpha.MediaPackageV2OutputDefinition = {
encode: encodeConfiguration,
outputName: 'outputName',
// the properties below are optional
audioGroupId: 'audioGroupId',
audioRenditionSets: 'audioRenditionSets',
captions: [encodeConfiguration],
hlsAutoSelect: mediaPackageV2HlsSetting,
hlsDefault: mediaPackageV2HlsSetting,
};
Properties
audioGroupIdoptionalstringaudio_group_idoptionalstraudioGroupIdoptionalStringAudioGroupIdoptionalstringAudioGroupIdoptional*string#The audio group ID for audio outputs.
Default: service default
audioRenditionSetsoptionalstringaudio_rendition_setsoptionalstraudioRenditionSetsoptionalStringAudioRenditionSetsoptionalstringAudioRenditionSetsoptional*string#The audio rendition sets for video outputs.
Default: service default
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.
encodeEncodeConfigurationencodeEncodeConfigurationencodeEncodeConfigurationEncodeEncodeConfigurationEncodeEncodeConfigurationrequired#The primary encode for this output — one video or one audio track.
hlsAutoSelectoptionalMediaPackageV2HlsSettinghls_auto_selectoptionalMediaPackageV2HlsSettinghlsAutoSelectoptionalMediaPackageV2HlsSettingHlsAutoSelectoptionalMediaPackageV2HlsSettingHlsAutoSelectoptionalMediaPackageV2HlsSetting= MediaPackageV2HlsSetting.OMIT#For audio outputs, whether MediaPackage sets this rendition as the auto-select rendition in the HLS manifest.
hlsDefaultoptionalMediaPackageV2HlsSettinghls_defaultoptionalMediaPackageV2HlsSettinghlsDefaultoptionalMediaPackageV2HlsSettingHlsDefaultoptionalMediaPackageV2HlsSettingHlsDefaultoptionalMediaPackageV2HlsSetting= MediaPackageV2HlsSetting.OMIT#For audio outputs, whether MediaPackage sets this rendition as the default rendition in the HLS manifest.
The name of this output.
Must be unique across all outputs in the channel.