Package software.amazon.awssdk.services.mediapackage.model

Interface HlsPackage.Builder

All Superinterfaces:
Buildable, CopyableBuilder<HlsPackage.Builder,HlsPackage>, SdkBuilder<HlsPackage.Builder,HlsPackage>, SdkPojo
Enclosing class:
HlsPackage
public static interface HlsPackage.Builder extends SdkPojo, CopyableBuilder<HlsPackage.Builder,HlsPackage>

  • Method Details

    • adMarkers

      HlsPackage.Builder adMarkers(String adMarkers)
      This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.
      Parameters:
      adMarkers - This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • adMarkers

      HlsPackage.Builder adMarkers(AdMarkers adMarkers)
      This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.
      Parameters:
      adMarkers - This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • adTriggersWithStrings

      HlsPackage.Builder adTriggersWithStrings(Collection<String> adTriggers)
      Sets the value of the AdTriggers property for this object.
      Parameters:
      adTriggers - The new value for the AdTriggers property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • adTriggersWithStrings

      HlsPackage.Builder adTriggersWithStrings(String... adTriggers)
      Sets the value of the AdTriggers property for this object.
      Parameters:
      adTriggers - The new value for the AdTriggers property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • adTriggers

      HlsPackage.Builder adTriggers(Collection<AdTriggersElement> adTriggers)
      Sets the value of the AdTriggers property for this object.
      Parameters:
      adTriggers - The new value for the AdTriggers property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • adTriggers

      HlsPackage.Builder adTriggers(AdTriggersElement... adTriggers)
      Sets the value of the AdTriggers property for this object.
      Parameters:
      adTriggers - The new value for the AdTriggers property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • adsOnDeliveryRestrictions

      HlsPackage.Builder adsOnDeliveryRestrictions(String adsOnDeliveryRestrictions)
      Sets the value of the AdsOnDeliveryRestrictions property for this object.
      Parameters:
      adsOnDeliveryRestrictions - The new value for the AdsOnDeliveryRestrictions property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • adsOnDeliveryRestrictions

      HlsPackage.Builder adsOnDeliveryRestrictions(AdsOnDeliveryRestrictions adsOnDeliveryRestrictions)
      Sets the value of the AdsOnDeliveryRestrictions property for this object.
      Parameters:
      adsOnDeliveryRestrictions - The new value for the AdsOnDeliveryRestrictions property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • encryption

      HlsPackage.Builder encryption(HlsEncryption encryption)
      Sets the value of the Encryption property for this object.
      Parameters:
      encryption - The new value for the Encryption property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryption

      default HlsPackage.Builder encryption(Consumer<HlsEncryption.Builder> encryption)
      Sets the value of the Encryption property for this object. This is a convenience method that creates an instance of the HlsEncryption.Builder avoiding the need to create one manually via HlsEncryption.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryption(HlsEncryption).

      Parameters:
      encryption - a consumer that will call methods on HlsEncryption.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • includeDvbSubtitles

      HlsPackage.Builder includeDvbSubtitles(Boolean includeDvbSubtitles)
      When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.
      Parameters:
      includeDvbSubtitles - When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeIframeOnlyStream

      HlsPackage.Builder includeIframeOnlyStream(Boolean includeIframeOnlyStream)
      When enabled, an I-Frame only stream will be included in the output.
      Parameters:
      includeIframeOnlyStream - When enabled, an I-Frame only stream will be included in the output.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • playlistType

      HlsPackage.Builder playlistType(String playlistType)
      The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.
      Parameters:
      playlistType - The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • playlistType

      HlsPackage.Builder playlistType(PlaylistType playlistType)
      The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.
      Parameters:
      playlistType - The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • playlistWindowSeconds

      HlsPackage.Builder playlistWindowSeconds(Integer playlistWindowSeconds)
      Time window (in seconds) contained in each parent manifest.
      Parameters:
      playlistWindowSeconds - Time window (in seconds) contained in each parent manifest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • programDateTimeIntervalSeconds

      HlsPackage.Builder programDateTimeIntervalSeconds(Integer programDateTimeIntervalSeconds)
      The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
      Parameters:
      programDateTimeIntervalSeconds - The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segmentDurationSeconds

      HlsPackage.Builder segmentDurationSeconds(Integer segmentDurationSeconds)
      Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
      Parameters:
      segmentDurationSeconds - Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamSelection

      HlsPackage.Builder streamSelection(StreamSelection streamSelection)
      Sets the value of the StreamSelection property for this object.
      Parameters:
      streamSelection - The new value for the StreamSelection property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamSelection

      default HlsPackage.Builder streamSelection(Consumer<StreamSelection.Builder> streamSelection)
      Sets the value of the StreamSelection property for this object. This is a convenience method that creates an instance of the StreamSelection.Builder avoiding the need to create one manually via StreamSelection.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to streamSelection(StreamSelection).

      Parameters:
      streamSelection - a consumer that will call methods on StreamSelection.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • useAudioRenditionGroup

      HlsPackage.Builder useAudioRenditionGroup(Boolean useAudioRenditionGroup)
      When enabled, audio streams will be placed in rendition groups in the output.
      Parameters:
      useAudioRenditionGroup - When enabled, audio streams will be placed in rendition groups in the output.
      Returns:
      Returns a reference to this object so that method calls can be chained together.