software.amazon.awscdk.services.mediapackage

Interface CfnOriginEndpoint.DashPackageProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnOriginEndpoint.DashPackageProperty.Jsii$Proxy

Enclosing class:

CfnOriginEndpoint

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

Parameters for DASH 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.*;
 DashPackageProperty dashPackageProperty = DashPackageProperty.builder()
         .adsOnDeliveryRestrictions("adsOnDeliveryRestrictions")
         .adTriggers(List.of("adTriggers"))
         .encryption(DashEncryptionProperty.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
                 .keyRotationIntervalSeconds(123)
                 .build())
         .includeIframeOnlyStream(false)
         .manifestLayout("manifestLayout")
         .manifestWindowSeconds(123)
         .minBufferTimeSeconds(123)
         .minUpdatePeriodSeconds(123)
         .periodTriggers(List.of("periodTriggers"))
         .profile("profile")
         .segmentDurationSeconds(123)
         .segmentTemplateFormat("segmentTemplateFormat")
         .streamSelection(StreamSelectionProperty.builder()
                 .maxVideoBitsPerSecond(123)
                 .minVideoBitsPerSecond(123)
                 .streamOrder("streamOrder")
                 .build())
         .suggestedPresentationDelaySeconds(123)
         .utcTiming("utcTiming")
         .utcTimingUri("utcTimingUri")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnOriginEndpoint.DashPackageProperty.Builder	builder()
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.
default Object	getEncryption() Parameters for encrypting content.
default Object	getIncludeIframeOnlyStream() `CfnOriginEndpoint.DashPackageProperty.IncludeIframeOnlyStream`.
default String	getManifestLayout() Determines the position of some tags in the manifest.
default Number	getManifestWindowSeconds() Time window (in seconds) contained in each manifest.
default Number	getMinBufferTimeSeconds() Minimum amount of content (measured in seconds) that a player must keep available in the buffer.
default Number	getMinUpdatePeriodSeconds() Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.
default List<String>	getPeriodTriggers() Controls whether MediaPackage produces single-period or multi-period DASH manifests.
default String	getProfile() DASH profile for the output, such as HbbTV.
default Number	getSegmentDurationSeconds() Duration (in seconds) of each fragment.
default String	getSegmentTemplateFormat() Determines the type of variable used in the `media` URL of the `SegmentTemplate` tag in the manifest.
default Object	getStreamSelection() Limitations for outputs from the endpoint, based on the video bitrate.
default Number	getSuggestedPresentationDelaySeconds() Amount of time (in seconds) that the player should be from the live point at the end of the manifest.
default String	getUtcTiming() Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
default String	getUtcTimingUri() Specifies the value attribute of the UTC timing field when utcTiming is set to HTTP-ISO or HTTP-HEAD.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

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 .

getEncryption

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

Parameters for encrypting content.

getIncludeIframeOnlyStream

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

`CfnOriginEndpoint.DashPackageProperty.IncludeIframeOnlyStream`.

getManifestLayout

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

Determines the position of some tags in the manifest.

Options:

• FULL - elements like SegmentTemplate and ContentProtection are included in each Representation .
• COMPACT - duplicate elements are combined and presented at the AdaptationSet level.

getManifestWindowSeconds

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

Time window (in seconds) contained in each manifest.

getMinBufferTimeSeconds

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

Minimum amount of content (measured in seconds) that a player must keep available in the buffer.

getMinUpdatePeriodSeconds

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

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

getPeriodTriggers

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

Controls whether MediaPackage produces single-period or multi-period DASH manifests.

For more information about periods, see Multi-period DASH in AWS Elemental MediaPackage .

Valid values:

• ADS - MediaPackage will produce multi-period DASH manifests. Periods are created based on the SCTE-35 ad markers present in the input manifest.
• No value - MediaPackage will produce single-period DASH manifests. This is the default setting.

getProfile

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

DASH profile for the output, such as HbbTV.

Valid values:

• NONE - the output doesn't use a DASH profile.
• HBBTV_1_5 - the output is HbbTV-compliant.

getSegmentDurationSeconds

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

Duration (in seconds) of each fragment.

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

getSegmentTemplateFormat

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

Determines the type of variable used in the `media` URL of the `SegmentTemplate` tag in the manifest.

Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate .

• NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate .
• NUMBER_WITH_DURATION - The $Number$ variable is used in the media URL and a duration attribute is added to the segment template. The SegmentTimeline object is removed from the representation.
• TIME_WITH_TIMELINE - The $Time$ variable is used in the media URL. The value of this variable is the timestamp of when the segment starts. A full SegmentTimeline object is presented in each SegmentTemplate .

getStreamSelection

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

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

getSuggestedPresentationDelaySeconds

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

Amount of time (in seconds) that the player should be from the live point at the end of the manifest.

getUtcTiming

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

Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

getUtcTimingUri

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

Specifies the value attribute of the UTC timing field when utcTiming is set to HTTP-ISO or HTTP-HEAD.

builder

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

Returns:

a CfnOriginEndpoint.DashPackageProperty.Builder of CfnOriginEndpoint.DashPackageProperty