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

Class AvailSettings

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.medialive.alpha.AvailSettings
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:40.936Z") @Stability(Experimental) public abstract class AvailSettings extends software.amazon.jsii.JsiiObject
(experimental) Avail settings — how SCTE-35 ad avail markers are handled.

Use the static factory methods to create.

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/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    AvailSettings()
     
    protected
    AvailSettings(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    AvailSettings(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static AvailSettings
    esam(EsamSettings props)
    (experimental) Use ESAM (Event Signaling and Management) mode, signaling ad avails to an external POIS.
    static AvailSettings
    spliceInsert()
    (experimental) Use SCTE-35 splice insert mode for ad avail handling.
    static AvailSettings
    spliceInsert(Scte35SpliceInsertSettings props)
    (experimental) Use SCTE-35 splice insert mode for ad avail handling.
    static AvailSettings
    timeSignalApos()
    (experimental) Use SCTE-35 time signal APOS mode for ad avail handling.
    static AvailSettings
    timeSignalApos(Scte35TimeSignalAposSettings props)
    (experimental) Use SCTE-35 time signal APOS mode for ad avail handling.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • AvailSettings

      protected AvailSettings(software.amazon.jsii.JsiiObjectRef objRef)

    • AvailSettings

      protected AvailSettings(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • AvailSettings

      @Stability(Experimental) protected AvailSettings()

  • Method Details

    • esam

      @Stability(Experimental) @NotNull public static AvailSettings esam(@NotNull EsamSettings props)
      (experimental) Use ESAM (Event Signaling and Management) mode, signaling ad avails to an external POIS.

      Parameters:
      props - This parameter is required.

    • spliceInsert

      @Stability(Experimental) @NotNull public static AvailSettings spliceInsert(@Nullable Scte35SpliceInsertSettings props)
      (experimental) Use SCTE-35 splice insert mode for ad avail handling.

      Parameters:
      props -

    • spliceInsert

      @Stability(Experimental) @NotNull public static AvailSettings spliceInsert()
      (experimental) Use SCTE-35 splice insert mode for ad avail handling.

    • timeSignalApos

      @Stability(Experimental) @NotNull public static AvailSettings timeSignalApos(@Nullable Scte35TimeSignalAposSettings props)
      (experimental) Use SCTE-35 time signal APOS mode for ad avail handling.

      Parameters:
      props -

    • timeSignalApos

      @Stability(Experimental) @NotNull public static AvailSettings timeSignalApos()
      (experimental) Use SCTE-35 time signal APOS mode for ad avail handling.