AWS CDK Reference

Appearance

v2.274.0

Experimental

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

AudioEncodeProps Struct ​

Properties for an audio encode configuration.

Stability
Experimental
Source
lib/encode-configuration.ts

Example ​

ts
declare const stack: Stack;
declare const input: medialive.IInput;
declare const bucket: s3.IBucket;

const video = medialive.EncodeConfiguration.video({
  name: 'video_720p',
  codec: medialive.VideoCodecSettings.h264({
    rateControl: medialive.H264RateControl.cbr({ bitrate: Bitrate.mbps(3) }),
    framerate: medialive.Framerate.FPS_30,
  }),
  width: 1280,
  height: 720,
});

const audio = medialive.EncodeConfiguration.audio({
  name: 'audio_aac',
  codec: medialive.AudioCodecSettings.aac({ bitrate: Bitrate.kbps(192) }),
});

new medialive.Channel(stack, 'Channel', {
  inputs: [{ input }],
  outputGroups: [
    medialive.OutputGroupConfiguration.hls({
      name: 'hls',
      destinations: [medialive.OutputDestination.toBucket(bucket, 'live/stream')],
      outputs: [{ encodes: [video, audio], outputName: 'hls_out' }],
    }),
  ],
});

Properties ​

audioDashRolesoptionalAudioDashRole[]audio_dash_rolesoptionaltyping.List[AudioDashRole]audioDashRolesoptionalList<AudioDashRole>AudioDashRolesoptionalAudioDashRole[]AudioDashRolesoptional*[]AudioDashRole#
The DASH roles to assign to this audio output.

Default: no DASH roles

Applies only when the output is configured for DVB DASH accessibility signaling.

audioNormalizationoptionalAudioNormalizationSettingsaudio_normalizationoptionalAudioNormalizationSettingsaudioNormalizationoptionalAudioNormalizationSettingsAudioNormalizationoptionalAudioNormalizationSettingsAudioNormalizationoptionalAudioNormalizationSettings#
Audio normalization settings for loudness correction.

Default: no normalization

audioSelectorNameoptionalstringaudio_selector_nameoptionalstraudioSelectorNameoptionalStringAudioSelectorNameoptionalstringAudioSelectorNameoptional*string#
The name of the audio selector in the input to use as the source.

Default: the input's default audio

Must match the name of an AudioSelector on the input attachment. When omitted, MediaLive uses the input's default audio.

audioTypeoptionalAudioTypeaudio_typeoptionalAudioTypeaudioTypeoptionalAudioTypeAudioTypeoptionalAudioTypeAudioTypeoptionalAudioType#
The audio type when audioTypeControl is USE_CONFIGURED.

Default: follow input

The values are defined in ISO-IEC 13818-1.

audioTypeControloptionalAudioTypeControlaudio_type_controloptionalAudioTypeControlaudioTypeControloptionalAudioTypeControlAudioTypeControloptionalAudioTypeControlAudioTypeControloptionalAudioTypeControl#
How the audio type is signaled in the output.

Default: USE_CONFIGURED when audioType is set, otherwise FOLLOW_INPUT

audioWatermarkSettingsoptionalAudioWatermarkSettingsaudio_watermark_settingsoptionalAudioWatermarkSettingsaudioWatermarkSettingsoptionalAudioWatermarkSettingsAudioWatermarkSettingsoptionalAudioWatermarkSettingsAudioWatermarkSettingsoptionalAudioWatermarkSettings#
Audio watermarking settings (e.g. Nielsen watermarks).

Default: no watermarking

codecAudioCodecSettingscodecAudioCodecSettingscodecAudioCodecSettingsCodecAudioCodecSettingsCodecAudioCodecSettingsrequired#
The codec for the audio encode.

Choose the codec explicitly (e.g. AudioCodecSettings.aac(...))

dvbDashAccessibilityoptionalDvbDashAccessibilitydvb_dash_accessibilityoptionalDvbDashAccessibilitydvbDashAccessibilityoptionalDvbDashAccessibilityDvbDashAccessibilityoptionalDvbDashAccessibilityDvbDashAccessibilityoptionalDvbDashAccessibility#
DVB DASH accessibility signaling for this audio output.

Default: no DVB DASH accessibility signaling

languageCodeoptionalstringlanguage_codeoptionalstrlanguageCodeoptionalStringLanguageCodeoptionalstringLanguageCodeoptional*string#
The ISO 639-2 language code for the audio output track (e.g. 'eng', 'spa').

Default: follow input

languageCodeControloptionalAudioLanguageCodeControllanguage_code_controloptionalAudioLanguageCodeControllanguageCodeControloptionalAudioLanguageCodeControlLanguageCodeControloptionalAudioLanguageCodeControlLanguageCodeControloptionalAudioLanguageCodeControl#
How the audio language code is signaled in the output.

Default: USE_CONFIGURED when languageCode is set, otherwise FOLLOW_INPUT

When FOLLOW_INPUT, a configured languageCode is used only as a fallback when the input has none.

namestringnamestrnameStringNamestringName*stringrequired#
A unique name for this audio encode.
remixSettingsoptionalRemixSettingsremix_settingsoptionalRemixSettingsremixSettingsoptionalRemixSettingsRemixSettingsoptionalRemixSettingsRemixSettingsoptionalRemixSettings#
Audio remix settings for channel remapping.

Default: no remixing

streamNameoptionalstringstream_nameoptionalstrstreamNameoptionalStringStreamNameoptionalstringStreamNameoptional*string#
The display name for the audio track (e.g. 'English', 'Director Commentary'). Used for HLS and MS Smooth outputs.

Default: no stream name