software.amazon.awscdk.services.mediapackage

Interface CfnOriginEndpoint.HlsManifestProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnOriginEndpoint.HlsManifestProperty.Jsii$Proxy

Enclosing class:

CfnOriginEndpoint

@Stability(value=Stable)
public static interface CfnOriginEndpoint.HlsManifestProperty
extends software.amazon.jsii.JsiiSerializable

An HTTP Live Streaming (HLS) manifest configuration on a CMAF endpoint.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.mediapackage.*;
 HlsManifestProperty hlsManifestProperty = HlsManifestProperty.builder()
         .id("id")
         // the properties below are optional
         .adMarkers("adMarkers")
         .adsOnDeliveryRestrictions("adsOnDeliveryRestrictions")
         .adTriggers(List.of("adTriggers"))
         .includeIframeOnlyStream(false)
         .manifestName("manifestName")
         .playlistType("playlistType")
         .playlistWindowSeconds(123)
         .programDateTimeIntervalSeconds(123)
         .url("url")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnOriginEndpoint.HlsManifestProperty.Builder	builder()
default String	getAdMarkers() Controls how ad markers are included in the packaged endpoint.
default String	getAdsOnDeliveryRestrictions() The flags on SCTE-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest.
default List<String>	getAdTriggers() Specifies the SCTE-35 message types that MediaPackage treats as ad markers in the output manifest.
String	getId() The manifest ID is required and must be unique within the OriginEndpoint.
default Object	getIncludeIframeOnlyStream() Applies to stream sets with a single video track only.
default String	getManifestName() A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.
default String	getPlaylistType() When specified as either `event` or `vod` , a corresponding `EXT-X-PLAYLIST-TYPE` entry is included in the media playlist.
default Number	getPlaylistWindowSeconds() Time window (in seconds) contained in each parent manifest.
default Number	getProgramDateTimeIntervalSeconds() Inserts `EXT-X-PROGRAM-DATE-TIME` tags in the output manifest at the interval that you specify.
default String	getUrl() The URL that's used to request this manifest from this endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getId

@Stability(value=Stable)
 @NotNull
String getId()

The manifest ID is required and must be unique within the OriginEndpoint.

The ID can't be changed after the endpoint is created.

getAdMarkers

@Stability(value=Stable)
 @Nullable
default String getAdMarkers()

Controls how ad markers are included in the packaged endpoint.

Valid values are none , passthrough , or scte35_enhanced .

• NONE - omits all SCTE-35 ad markers from the output.
• PASSTHROUGH - creates a copy in the output of the SCTE-35 ad markers (comments) taken directly from the input manifest.
• SCTE35_ENHANCED - generates ad markers and blackout tags in the output based on the SCTE-35 messages from the input manifest.

getAdsOnDeliveryRestrictions

@Stability(value=Stable)
 @Nullable
default String getAdsOnDeliveryRestrictions()

The flags on SCTE-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest.

For information about SCTE-35 in MediaPackage, see SCTE-35 Message Options in AWS Elemental MediaPackage .

getAdTriggers

@Stability(value=Stable)
 @Nullable
default List<String> getAdTriggers()

Specifies the SCTE-35 message types that MediaPackage treats as ad markers in the output manifest.

Valid values:

• BREAK
• DISTRIBUTOR_ADVERTISEMENT
• DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY
• DISTRIBUTOR_PLACEMENT_OPPORTUNITY
• PROVIDER_ADVERTISEMENT
• PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY
• PROVIDER_PLACEMENT_OPPORTUNITY
• SPLICE_INSERT

getIncludeIframeOnlyStream

@Stability(value=Stable)
 @Nullable
default Object getIncludeIframeOnlyStream()

Applies to stream sets with a single video track only.

When true, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included.

getManifestName

@Stability(value=Stable)
 @Nullable
default String getManifestName()

A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.

The manifestName on the HLSManifest object overrides the manifestName that you provided on the originEndpoint object.

getPlaylistType

@Stability(value=Stable)
 @Nullable
default String getPlaylistType()

When specified as either `event` or `vod` , a corresponding `EXT-X-PLAYLIST-TYPE` entry is included in the media playlist.

Indicates if the playlist is live-to-VOD content.

getPlaylistWindowSeconds

@Stability(value=Stable)
 @Nullable
default Number getPlaylistWindowSeconds()

Time window (in seconds) contained in each parent manifest.

getProgramDateTimeIntervalSeconds

@Stability(value=Stable)
 @Nullable
default Number getProgramDateTimeIntervalSeconds()

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

Additionally, ID3Timed metadata messages are generated every 5 seconds starting when the content was ingested.

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

Omit this attribute or enter 0 to indicate that the EXT-X-PROGRAM-DATE-TIME tags are not included in the manifest.

getUrl

@Stability(value=Stable)
 @Nullable
default String getUrl()

The URL that's used to request this manifest from this endpoint.

builder

@Stability(value=Stable)
static CfnOriginEndpoint.HlsManifestProperty.Builder builder()

Returns:

a CfnOriginEndpoint.HlsManifestProperty.Builder of CfnOriginEndpoint.HlsManifestProperty