Package software.amazon.awscdk.services.medialive.alpha

Interface EsamSettings

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EsamSettings.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:41.048Z")
@Stability(Experimental)
public interface EsamSettings
extends software.amazon.jsii.JsiiSerializable

(experimental) 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 software.amazon.awscdk.services.ssm.StringParameter;
 Stack stack;
 IInput input;
 IBucket bucket;
 EncodeConfiguration video;
 StringParameter poisPassword;
 Channel.Builder.create(stack, "Channel")
         .inputs(List.of(InputAttachment.builder().input(input).build()))
         .availSettings(AvailSettings.esam(EsamSettings.builder()
                 .pois(PoisEndpoint.builder()
                         .url("https://pois.example.com/esam")
                         .username("pois-user")
                         .password(poisPassword)
                         .build())
                 .acquisitionPointId("acquisition-point-1")
                 .adAvailOffset(Duration.millis(200))
                 .build()))
         .scte35SegmentationScope(Scte35SegmentationScope.SCTE35_ENABLED_OUTPUT_GROUPS)
         .outputGroups(List.of(OutputGroupConfiguration.hls(HlsOutputGroupProps.builder()
                 .name("hls")
                 .destinations(List.of(OutputDestination.toBucket(bucket, "live/stream")))
                 .outputs(List.of(HlsOutputDefinition.builder().encodes(List.of(video)).outputName("hls_out").build()))
                 .build())))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	EsamSettings.Builder	A builder for EsamSettings
static final class	EsamSettings.Jsii$Proxy	An implementation for EsamSettings

Method Summary

Modifier and Type	Method	Description
static EsamSettings.Builder	builder()
String	getAcquisitionPointId()	(experimental) The acquisition point identity sent to the POIS in MCC requests.
default Duration	getAdAvailOffset()	(experimental) Offset added to the input ad avail PTS time.
PoisEndpoint	getPois()	(experimental) The POIS endpoint connection details — URL and optional credentials.
default String	getZoneIdentity()	(experimental) The ID of a zone the POIS uses to control the placement of ad avails.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAcquisitionPointId

@Stability(Experimental)
@NotNull
String getAcquisitionPointId()

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

getPois

@Stability(Experimental)
@NotNull
PoisEndpoint getPois()

(experimental) The POIS endpoint connection details — URL and optional credentials.

getAdAvailOffset

@Stability(Experimental)
@Nullable
default Duration getAdAvailOffset()

(experimental) Offset added to the input ad avail PTS time.

Default: - service default

getZoneIdentity

@Stability(Experimental)
@Nullable
default String getZoneIdentity()

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

Default: - service default

builder

@Stability(Experimental)
static EsamSettings.Builder builder()

Returns:

a EsamSettings.Builder of EsamSettings