CfnOriginEndpoint.DashPackageProperty

All Known Implementing Classes:: CfnOriginEndpoint.DashPackageProperty.Jsii$Proxy

Enclosing class:: CfnOriginEndpoint

public static interface CfnOriginEndpoint.DashPackageProperty

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

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

- Method Detail
  - 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()
```
    `CfnOriginEndpoint.DashPackageProperty.IncludeIframeOnlyStream`.
  - getManifestLayout
```
default java.lang.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
```
default java.lang.Number getManifestWindowSeconds()
```
    Time window (in seconds) contained in each manifest.
  - getMinBufferTimeSeconds
```
default java.lang.Number getMinBufferTimeSeconds()
```
    Minimum amount of content (measured in seconds) that a player must keep available in the buffer.
  - getMinUpdatePeriodSeconds
```
default java.lang.Number getMinUpdatePeriodSeconds()
```
    Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.
  - getPeriodTriggers
```
default java.util.List<java.lang.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
```
default java.lang.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
```
default java.lang.Number getSegmentDurationSeconds()
```
    Duration (in seconds) of each fragment.
    Actual fragments are rounded to the nearest multiple of the source fragment duration.
  - getSegmentTemplateFormat
```
default java.lang.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
```
default java.lang.Object getStreamSelection()
```
    Limitations for outputs from the endpoint, based on the video bitrate.
  - getSuggestedPresentationDelaySeconds
```
default java.lang.Number getSuggestedPresentationDelaySeconds()
```
    Amount of time (in seconds) that the player should be from the live point at the end of the manifest.
  - getUtcTiming
```
default java.lang.String getUtcTiming()
```
    Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
  - getUtcTimingUri
```
default java.lang.String getUtcTimingUri()
```
    Specifies the value attribute of the UTC timing field when utcTiming is set to HTTP-ISO or HTTP-HEAD.
  - builder
```
static CfnOriginEndpoint.DashPackageProperty.Builder builder()
```
    Returns:
    
    a CfnOriginEndpoint.DashPackageProperty.Builder of CfnOriginEndpoint.DashPackageProperty

Interface CfnOriginEndpoint.DashPackageProperty

Nested Class Summary

Method Summary

Method Detail

getAdsOnDeliveryRestrictions

getAdTriggers

getEncryption

getIncludeIframeOnlyStream

getManifestLayout

getManifestWindowSeconds

getMinBufferTimeSeconds

getMinUpdatePeriodSeconds

getPeriodTriggers

getProfile

getSegmentDurationSeconds

getSegmentTemplateFormat

getStreamSelection

getSuggestedPresentationDelaySeconds

getUtcTiming

getUtcTimingUri

builder