class EncodeConfiguration 🔹

Language	Type name
.NET	Amazon.CDK.AWS.MediaLive.Alpha.EncodeConfiguration
Go	github.com/aws/aws-cdk-go/awsmedialivealpha/v2#EncodeConfiguration
Java	software.amazon.awscdk.services.medialive.alpha.EncodeConfiguration
Python	aws_cdk.aws_medialive_alpha.EncodeConfiguration
TypeScript (source)	@aws-cdk/aws-medialive-alpha » EncodeConfiguration

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.

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()

Properties

Name	Type	Description
name🔹	string	The unique name for this encode, used to reference it from outputs.

---

name🔹

Type: string

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

Methods

Name	Description
static audio(props)🔹	Create an audio encode configuration.
static caption(props)🔹	Create a caption encode configuration.
static video(props)🔹	Create a video encode configuration.

---

static audio(props)🔹

public static audio(props: AudioEncodeProps): EncodeConfiguration

Parameters

• props AudioEncodeProps

Returns

• EncodeConfiguration

Create an audio encode configuration.

---

static caption(props)🔹

public static caption(props: CaptionEncodeProps): EncodeConfiguration

Parameters

• props CaptionEncodeProps

Returns

• EncodeConfiguration

Create a caption encode configuration.

---

static video(props)🔹

public static video(props: VideoEncodeProps): EncodeConfiguration

Parameters

• props VideoEncodeProps

Returns

• EncodeConfiguration

Create a video encode configuration.