Package software.amazon.awscdk.services.mediapackagev2.alpha

Interface HlsManifestConfiguration

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HlsManifestConfiguration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:36.069Z")
@Stability(Experimental)
public interface HlsManifestConfiguration
extends software.amazon.jsii.JsiiSerializable

(experimental) The HLS manifest configuration associated with the origin endpoint.

Example:

 Channel channel;
 IRole spekeRole;
 OriginEndpoint.Builder.create(this, "TsEndpoint")
         .channel(channel)
         .segment(Segment.ts(TsSegmentProps.builder()
                 .encryption(TsEncryption.speke(TsSpekeEncryptionProps.builder()
                         .method(TsEncryptionMethod.SAMPLE_AES)
                         .resourceId("my-content-id")
                         .url("https://example.com/speke")
                         .role(spekeRole)
                         .build()))
                 .build()))
         .manifests(List.of(Manifest.hls(HlsManifestConfiguration.builder().manifestName("index").build())))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HlsManifestConfiguration.Builder	builder()
default String	getChildManifestName()	(experimental) The name of the child manifest associated with the HLS manifest configuration.
default FilterConfiguration	getFilterConfiguration()	(experimental) Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.
String	getManifestName()	(experimental) The name of the manifest associated with the HLS manifest configuration.
default Duration	getManifestWindow()	(experimental) The total duration (in seconds) of the manifest's content.
default Duration	getProgramDateTimeInterval()	(experimental) Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify.
default AdMarkerHls	getScteAdMarkerHls()	(experimental) The SCTE-35 HLS configuration associated with the HLS manifest configuration of the origin endpoint.
default StartTag	getStartTag()	(experimental) Insert EXT-X-START tag in the manifest with the configured settings.
default Boolean	getUrlEncodeChildManifest()	(experimental) When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with AWS Signature Version 4 (SigV4) signature signing protocol.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getManifestName

@Stability(Experimental)
@NotNull
String getManifestName()

(experimental) The name of the manifest associated with the HLS manifest configuration.

getChildManifestName

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

(experimental) The name of the child manifest associated with the HLS manifest configuration.

Default: - No child manifest name specified

getFilterConfiguration

@Stability(Experimental)
@Nullable
default FilterConfiguration getFilterConfiguration()

(experimental) Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

https://docs.aws.amazon.com/mediapackage/latest/userguide/manifest-filter-query-parameters.html

Default: - No filter configuration

getManifestWindow

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

(experimental) The total duration (in seconds) of the manifest's content.

Default: 60

getProgramDateTimeInterval

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

(experimental) Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify.

If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.

Default: - No program date time interval

getScteAdMarkerHls

@Stability(Experimental)
@Nullable
default AdMarkerHls getScteAdMarkerHls()

(experimental) The SCTE-35 HLS configuration associated with the HLS manifest configuration of the origin endpoint.

Default: - No SCTE ad marker configuration

getStartTag

@Stability(Experimental)
@Nullable
default StartTag getStartTag()

(experimental) Insert EXT-X-START tag in the manifest with the configured settings.

Default: - No start tag

getUrlEncodeChildManifest

@Stability(Experimental)
@Nullable
default Boolean getUrlEncodeChildManifest()

(experimental) When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with AWS Signature Version 4 (SigV4) signature signing protocol.

For more information, see AWS Signature Version 4 for API requests in AWS Identity and Access Management User Guide.

Default: false

builder

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

Returns:

a HlsManifestConfiguration.Builder of HlsManifestConfiguration