Interface DashPackage.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DashPackage.Builder,DashPackage>, SdkBuilder<DashPackage.Builder,DashPackage>, SdkPojo
Enclosing class:
DashPackage

public static interface DashPackage.Builder extends SdkPojo, CopyableBuilder<DashPackage.Builder,DashPackage>
  • Method Details

    • adTriggersWithStrings

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

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

      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

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

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

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

      DashPackage.Builder encryption(DashEncryption 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 DashPackage.Builder encryption(Consumer<DashEncryption.Builder> encryption)
      Sets the value of the Encryption property for this object. This is a convenience method that creates an instance of the DashEncryption.Builder avoiding the need to create one manually via DashEncryption.builder().

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

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

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

      DashPackage.Builder manifestLayout(String manifestLayout)
      Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level. When set to DRM_TOP_LEVEL_COMPACT, content protection elements are placed the MPD level and referenced at the AdaptationSet level.
      Parameters:
      manifestLayout - Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level. When set to DRM_TOP_LEVEL_COMPACT, content protection elements are placed the MPD level and referenced at the AdaptationSet level.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • manifestLayout

      DashPackage.Builder manifestLayout(ManifestLayout manifestLayout)
      Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level. When set to DRM_TOP_LEVEL_COMPACT, content protection elements are placed the MPD level and referenced at the AdaptationSet level.
      Parameters:
      manifestLayout - Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level. When set to DRM_TOP_LEVEL_COMPACT, content protection elements are placed the MPD level and referenced at the AdaptationSet level.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • manifestWindowSeconds

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

      DashPackage.Builder minBufferTimeSeconds(Integer minBufferTimeSeconds)
      Minimum duration (in seconds) that a player will buffer media before starting the presentation.
      Parameters:
      minBufferTimeSeconds - Minimum duration (in seconds) that a player will buffer media before starting the presentation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • minUpdatePeriodSeconds

      DashPackage.Builder minUpdatePeriodSeconds(Integer minUpdatePeriodSeconds)
      Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).
      Parameters:
      minUpdatePeriodSeconds - Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • periodTriggersWithStrings

      DashPackage.Builder periodTriggersWithStrings(Collection<String> periodTriggers)
      A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers.
      Parameters:
      periodTriggers - A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • periodTriggersWithStrings

      DashPackage.Builder periodTriggersWithStrings(String... periodTriggers)
      A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers.
      Parameters:
      periodTriggers - A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • periodTriggers

      DashPackage.Builder periodTriggers(Collection<PeriodTriggersElement> periodTriggers)
      A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers.
      Parameters:
      periodTriggers - A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • periodTriggers

      DashPackage.Builder periodTriggers(PeriodTriggersElement... periodTriggers)
      A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers.
      Parameters:
      periodTriggers - A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • profile

      DashPackage.Builder profile(String profile)
      The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. When set to "DVB-DASH_2014", DVB-DASH 2014 compliant output is enabled.
      Parameters:
      profile - The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. When set to "DVB-DASH_2014", DVB-DASH 2014 compliant output is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • profile

      DashPackage.Builder profile(Profile profile)
      The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. When set to "DVB-DASH_2014", DVB-DASH 2014 compliant output is enabled.
      Parameters:
      profile - The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. When set to "DVB-DASH_2014", DVB-DASH 2014 compliant output is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • segmentDurationSeconds

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

      DashPackage.Builder segmentTemplateFormat(String segmentTemplateFormat)
      Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.
      Parameters:
      segmentTemplateFormat - Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • segmentTemplateFormat

      DashPackage.Builder segmentTemplateFormat(SegmentTemplateFormat segmentTemplateFormat)
      Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.
      Parameters:
      segmentTemplateFormat - Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • streamSelection

      DashPackage.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 DashPackage.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:
    • suggestedPresentationDelaySeconds

      DashPackage.Builder suggestedPresentationDelaySeconds(Integer suggestedPresentationDelaySeconds)
      Duration (in seconds) to delay live content before presentation.
      Parameters:
      suggestedPresentationDelaySeconds - Duration (in seconds) to delay live content before presentation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • utcTiming

      DashPackage.Builder utcTiming(String utcTiming)
      Determines the type of UTCTiming included in the Media Presentation Description (MPD)
      Parameters:
      utcTiming - Determines the type of UTCTiming included in the Media Presentation Description (MPD)
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • utcTiming

      DashPackage.Builder utcTiming(UtcTiming utcTiming)
      Determines the type of UTCTiming included in the Media Presentation Description (MPD)
      Parameters:
      utcTiming - Determines the type of UTCTiming included in the Media Presentation Description (MPD)
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • utcTimingUri

      DashPackage.Builder utcTimingUri(String utcTimingUri)
      Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE
      Parameters:
      utcTimingUri - Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE
      Returns:
      Returns a reference to this object so that method calls can be chained together.