interface EsamSettings 🔹

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

Settings for ESAM (Event Signaling and Management) ad avail handling.

MediaLive signals ad avail events to an external POIS (Placement Opportunity Information System) endpoint.

Example

import { StringParameter } from 'aws-cdk-lib/aws-ssm';

declare const stack: Stack;
declare const input: medialive.IInput;
declare const bucket: s3.IBucket;
declare const video: medialive.EncodeConfiguration;
declare const poisPassword: StringParameter;

new medialive.Channel(stack, 'Channel', {
  inputs: [{ input }],
  availSettings: medialive.AvailSettings.esam({
    pois: {
      url: 'https://pois.example.com/esam',
      username: 'pois-user',
      password: poisPassword,
    },
    acquisitionPointId: 'acquisition-point-1',
    adAvailOffset: Duration.millis(200),
  }),
  scte35SegmentationScope: medialive.Scte35SegmentationScope.SCTE35_ENABLED_OUTPUT_GROUPS,
  outputGroups: [
    medialive.OutputGroupConfiguration.hls({
      name: 'hls',
      destinations: [medialive.OutputDestination.toBucket(bucket, 'live/stream')],
      outputs: [{ encodes: [video], outputName: 'hls_out' }],
    }),
  ],
});

Properties

Name	Type	Description
acquisitionPointId🔹	string	The acquisition point identity sent to the POIS in MCC requests.
pois🔹	PoisEndpoint	The POIS endpoint connection details — URL and optional credentials.
adAvailOffset?🔹	Duration	Offset added to the input ad avail PTS time.
zoneIdentity?🔹	string	The ID of a zone the POIS uses to control the placement of ad avails.

---

acquisitionPointId🔹

Type: string

The acquisition point identity sent to the POIS in MCC requests.

---

pois🔹

Type: PoisEndpoint

The POIS endpoint connection details — URL and optional credentials.

---

adAvailOffset?🔹

Type: Duration (optional, default: service default)

Offset added to the input ad avail PTS time.

---

zoneIdentity?🔹

Type: string (optional, default: service default)

The ID of a zone the POIS uses to control the placement of ad avails.