Package software.amazon.awscdk.services.mediapackage

Interface CfnOriginEndpoint.HlsPackageProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnOriginEndpoint.HlsPackageProperty.Jsii$Proxy
Enclosing class:
CfnOriginEndpoint
@Stability(Stable) public static interface CfnOriginEndpoint.HlsPackageProperty extends software.amazon.jsii.JsiiSerializable
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().build())
                         .build())
                 // the properties below are optional
                 .constantInitializationVector("constantInitializationVector")
                 .encryptionMethod("encryptionMethod")
                 .keyRotationIntervalSeconds(123)
                 .repeatExtXKey(false)
                 .build())
         .includeDvbSubtitles(false)
         .includeIframeOnlyStream(false)
         .playlistType("playlistType")
         .playlistWindowSeconds(123)
         .programDateTimeIntervalSeconds(123)
         .segmentDurationSeconds(123)
         .streamSelection(StreamSelectionProperty.builder()
                 .maxVideoBitsPerSecond(123)
                 .minVideoBitsPerSecond(123)
                 .streamOrder("streamOrder")
                 .build())
         .useAudioRenditionGroup(false)
         .build();

  • Method Details

    • getAdMarkers

      @Stability(Stable) @Nullable default String getAdMarkers()
      Controls how ad markers are included in the packaged endpoint.

      Valid values:

      • 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(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.

    • getIncludeDvbSubtitles

      @Stability(Stable) @Nullable default Object getIncludeDvbSubtitles()
      When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.

    • getIncludeIframeOnlyStream

      @Stability(Stable) @Nullable default 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

      @Stability(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(Stable) @Nullable default Number getPlaylistWindowSeconds()
      Time window (in seconds) contained in each parent manifest.

    • getProgramDateTimeIntervalSeconds

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

    • 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.

    • getStreamSelection

      @Stability(Stable) @Nullable default Object getStreamSelection()
      Limitations for outputs from the endpoint, based on the video bitrate.

    • getUseAudioRenditionGroup

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) static CfnOriginEndpoint.HlsPackageProperty.Builder builder()
      Returns:
      a CfnOriginEndpoint.HlsPackageProperty.Builder of CfnOriginEndpoint.HlsPackageProperty