Package 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(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().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();

  • Method Details

    • getAdsOnDeliveryRestrictions

      @Stability(Stable) @Nullable default String getAdsOnDeliveryRestrictions()
      The flags on SCTE-35 segmentation descriptors that have to be present for AWS Elemental MediaPackage to insert ad markers in the output manifest.

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

    • getAdTriggers

      @Stability(Stable) @Nullable default List<String> getAdTriggers()
      Specifies the SCTE-35 message types that AWS Elemental 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(Stable) @Nullable default Object getEncryption()
      Parameters for encrypting content.

    • getIncludeIframeOnlyStream

      @Stability(Stable) @Nullable default Object getIncludeIframeOnlyStream()
      This applies only to stream sets with a single video track.

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

    • getManifestLayout

      @Stability(Stable) @Nullable default String getManifestLayout()
      Determines the position of some tags in the manifest.

      Valid values:

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

    • getManifestWindowSeconds

      @Stability(Stable) @Nullable default Number getManifestWindowSeconds()
      Time window (in seconds) contained in each manifest.

    • getMinBufferTimeSeconds

      @Stability(Stable) @Nullable default Number getMinBufferTimeSeconds()
      Minimum amount of content (measured in seconds) that a player must keep available in the buffer.

    • getMinUpdatePeriodSeconds

      @Stability(Stable) @Nullable default Number getMinUpdatePeriodSeconds()
      Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

    • getPeriodTriggers

      @Stability(Stable) @Nullable default List<String> getPeriodTriggers()
      Controls whether AWS Elemental 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 - AWS Elemental MediaPackage will produce multi-period DASH manifests. Periods are created based on the SCTE-35 ad markers present in the input manifest.
      • No value - AWS Elemental MediaPackage will produce single-period DASH manifests. This is the default setting.

    • getProfile

      @Stability(Stable) @Nullable default String getProfile()
      The DASH profile for the output.

      Valid values:

      • NONE - The output doesn't use a DASH profile.
      • HBBTV_1_5 - The output is compliant with HbbTV v1.5.
      • DVB_DASH_2014 - The output is compliant with DVB-DASH 2014.

    • getSegmentDurationSeconds

      @Stability(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(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 .

      Valid values:

      • 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(Stable) @Nullable default Object getStreamSelection()
      Limitations for outputs from the endpoint, based on the video bitrate.

    • getSuggestedPresentationDelaySeconds

      @Stability(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(Stable) @Nullable default String getUtcTiming()
      Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

    • getUtcTimingUri

      @Stability(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(Stable) static CfnOriginEndpoint.DashPackageProperty.Builder builder()
      Returns:
      a CfnOriginEndpoint.DashPackageProperty.Builder of CfnOriginEndpoint.DashPackageProperty