software.amazon.awscdk.services.mediapackage

Interface CfnOriginEndpoint.HlsPackageProperty

All Known Implementing Classes:

CfnOriginEndpoint.HlsPackageProperty.Jsii$Proxy

Enclosing class:

CfnOriginEndpoint

public static interface CfnOriginEndpoint.HlsPackageProperty

Parameters for Apple HLS packaging.

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.*;
 HlsPackageProperty hlsPackageProperty = HlsPackageProperty.builder()
         .adMarkers("adMarkers")
         .adsOnDeliveryRestrictions("adsOnDeliveryRestrictions")
         .adTriggers(List.of("adTriggers"))
         .encryption(HlsEncryptionProperty.builder()
                 .spekeKeyProvider(SpekeKeyProviderProperty.builder()
                         .resourceId("resourceId")
                         .roleArn("roleArn")
                         .systemIds(List.of("systemIds"))
                         .url("url")
                         // the properties below are optional
                         .certificateArn("certificateArn")
                         .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder()
                                 .presetSpeke20Audio("presetSpeke20Audio")
                                 .presetSpeke20Video("presetSpeke20Video")
                                 .build())
                         .build())
                 // the properties below are optional
                 .constantInitializationVector("constantInitializationVector")
                 .encryptionMethod("encryptionMethod")
                 .keyRotationIntervalSeconds(123)
                 .repeatExtXKey(false)
                 .build())
         .includeIframeOnlyStream(false)
         .playlistType("playlistType")
         .playlistWindowSeconds(123)
         .programDateTimeIntervalSeconds(123)
         .segmentDurationSeconds(123)
         .streamSelection(StreamSelectionProperty.builder()
                 .maxVideoBitsPerSecond(123)
                 .minVideoBitsPerSecond(123)
                 .streamOrder("streamOrder")
                 .build())
         .useAudioRenditionGroup(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnOriginEndpoint.HlsPackageProperty.Builder	builder()
default java.lang.String	getAdMarkers() Controls how ad markers are included in the packaged endpoint.
default java.lang.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 java.util.List<java.lang.String>	getAdTriggers() Specifies the SCTE-35 message types that MediaPackage treats as ad markers in the output manifest.
default java.lang.Object	getEncryption() Parameters for encrypting content.
default java.lang.Object	getIncludeIframeOnlyStream() Only applies to stream sets with a single video track.
default java.lang.String	getPlaylistType() When specified as either `event` or `vod` , a corresponding `EXT-X-PLAYLIST-TYPE` entry is included in the media playlist.
default java.lang.Number	getPlaylistWindowSeconds() Time window (in seconds) contained in each parent manifest.
default java.lang.Number	getProgramDateTimeIntervalSeconds() Inserts `EXT-X-PROGRAM-DATE-TIME` tags in the output manifest at the interval that you specify.
default java.lang.Number	getSegmentDurationSeconds() Duration (in seconds) of each fragment.
default java.lang.Object	getStreamSelection() Limitations for outputs from the endpoint, based on the video bitrate.
default java.lang.Object	getUseAudioRenditionGroup() When true, AWS Elemental MediaPackage bundles all audio tracks in a rendition group.

Method Detail

getAdMarkers

default java.lang.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

default java.lang.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

default java.util.List<java.lang.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

getEncryption

default java.lang.Object getEncryption()

Parameters for encrypting content.

getIncludeIframeOnlyStream

default java.lang.Object getIncludeIframeOnlyStream()

Only applies to stream sets with a single video track.

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.

getPlaylistType

default java.lang.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

default java.lang.Number getPlaylistWindowSeconds()

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

getProgramDateTimeIntervalSeconds

default java.lang.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.

getSegmentDurationSeconds

default java.lang.Number getSegmentDurationSeconds()

Duration (in seconds) of each fragment.

Actual fragments are rounded to the nearest multiple of the source fragment duration.

getStreamSelection

default java.lang.Object getStreamSelection()

Limitations for outputs from the endpoint, based on the video bitrate.

getUseAudioRenditionGroup

default java.lang.Object getUseAudioRenditionGroup()

When true, AWS Elemental MediaPackage bundles all audio tracks in a rendition group.

All other tracks in the stream can be used with any audio rendition from the group.

builder

static CfnOriginEndpoint.HlsPackageProperty.Builder builder()

Returns:

a CfnOriginEndpoint.HlsPackageProperty.Builder of CfnOriginEndpoint.HlsPackageProperty