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

Experimental

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

EncodeConfiguration Class

Base interface for an encode configuration (video, audio, or caption).

The same EncodeConfiguration instance can be shared across multiple output groups within a channel. The channel automatically deduplicates encode descriptions by name at synth time.

Stability

Experimental

Source

lib/encode-configuration.ts

Example

// Define a caption selector on the input attachment (see Input Attachment Settings below)
const captionSelector = medialive.CaptionSelector.embedded('captions');

// WebVTT captions — packaged alongside the video encode in the same output
const webvtt = medialive.EncodeConfiguration.caption({
  name: 'eng_webvtt',
  captionSelectorName: captionSelector.name,
  languageCode: 'eng',
  languageDescription: 'English',
  destination: medialive.CaptionDestination.webvtt(),
});

// Burned-in captions — rendered into the video, styled via the burn-in options
const burnIn = medialive.EncodeConfiguration.caption({
  name: 'eng_burnin',
  captionSelectorName: captionSelector.name,
  destination: medialive.CaptionDestination.burnIn({
    alignment: medialive.CaptionAlignment.CENTERED,
    fontColor: medialive.CaptionFontColor.WHITE,
    outlineColor: medialive.CaptionOutlineColor.BLACK,
    fontSize: medialive.CaptionFontSize.AUTO,
  }),
});

Initializer

new EncodeConfiguration()

EncodeConfiguration()

new EncodeConfiguration()

new EncodeConfiguration()

NewEncodeConfiguration()

Properties

namestringnamestrnameStringNamestringName*stringrequired#

The unique name for this encode, used to reference it from outputs.

Methods

audio(props: AudioEncodeProps): EncodeConfiguration // chainable@staticmethod def audio(props: AudioEncodeProps) -> EncodeConfigurationpublic static EncodeConfiguration audio(AudioEncodeProps props)public static EncodeConfiguration Audio(AudioEncodeProps props)func Audio(Props AudioEncodeProps) EncodeConfigurationstatic#

Create an audio encode configuration.

caption(props: CaptionEncodeProps): EncodeConfiguration // chainable@staticmethod def caption(props: CaptionEncodeProps) -> EncodeConfigurationpublic static EncodeConfiguration caption(CaptionEncodeProps props)public static EncodeConfiguration Caption(CaptionEncodeProps props)func Caption(Props CaptionEncodeProps) EncodeConfigurationstatic#

Create a caption encode configuration.

video(props: VideoEncodeProps): EncodeConfiguration // chainable@staticmethod def video(props: VideoEncodeProps) -> EncodeConfigurationpublic static EncodeConfiguration video(VideoEncodeProps props)public static EncodeConfiguration Video(VideoEncodeProps props)func Video(Props VideoEncodeProps) EncodeConfigurationstatic#

Create a video encode configuration.