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

Class DashPackage

java.lang.Object
software.amazon.awssdk.services.mediapackage.model.DashPackage
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DashPackage.Builder,DashPackage>
@Generated("software.amazon.awssdk:codegen") public final class DashPackage extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DashPackage.Builder,DashPackage>
A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
See Also:

  • Method Details

    • adTriggers

      public final List<AdTriggersElement> adTriggers()
      Returns the value of the AdTriggers property for this object.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdTriggers() method.

      Returns:
      The value of the AdTriggers property for this object.

    • hasAdTriggers

      public final boolean hasAdTriggers()
      For responses, this returns true if the service returned a value for the AdTriggers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • adTriggersAsStrings

      public final List<String> adTriggersAsStrings()
      Returns the value of the AdTriggers property for this object.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdTriggers() method.

      Returns:
      The value of the AdTriggers property for this object.

    • adsOnDeliveryRestrictions

      public final AdsOnDeliveryRestrictions adsOnDeliveryRestrictions()
      Returns the value of the AdsOnDeliveryRestrictions property for this object.

      If the service returns an enum value that is not available in the current SDK version, adsOnDeliveryRestrictions will return AdsOnDeliveryRestrictions.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from adsOnDeliveryRestrictionsAsString().

      Returns:
      The value of the AdsOnDeliveryRestrictions property for this object.
      See Also:

    • adsOnDeliveryRestrictionsAsString

      public final String adsOnDeliveryRestrictionsAsString()
      Returns the value of the AdsOnDeliveryRestrictions property for this object.

      If the service returns an enum value that is not available in the current SDK version, adsOnDeliveryRestrictions will return AdsOnDeliveryRestrictions.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from adsOnDeliveryRestrictionsAsString().

      Returns:
      The value of the AdsOnDeliveryRestrictions property for this object.
      See Also:

    • encryption

      public final DashEncryption encryption()
      Returns the value of the Encryption property for this object.
      Returns:
      The value of the Encryption property for this object.

    • includeIframeOnlyStream

      public final Boolean includeIframeOnlyStream()
      When enabled, an I-Frame only stream will be included in the output.
      Returns:
      When enabled, an I-Frame only stream will be included in the output.

    • manifestLayout

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, manifestLayout will return ManifestLayout.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from manifestLayoutAsString().

      Returns:
      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.
      See Also:

    • manifestLayoutAsString

      public final String manifestLayoutAsString()
      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.

      If the service returns an enum value that is not available in the current SDK version, manifestLayout will return ManifestLayout.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from manifestLayoutAsString().

      Returns:
      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.
      See Also:

    • manifestWindowSeconds

      public final Integer manifestWindowSeconds()
      Time window (in seconds) contained in each manifest.
      Returns:
      Time window (in seconds) contained in each manifest.

    • minBufferTimeSeconds

      public final Integer minBufferTimeSeconds()
      Minimum duration (in seconds) that a player will buffer media before starting the presentation.
      Returns:
      Minimum duration (in seconds) that a player will buffer media before starting the presentation.

    • minUpdatePeriodSeconds

      public final Integer minUpdatePeriodSeconds()
      Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).
      Returns:
      Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).

    • periodTriggers

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPeriodTriggers() method.

      Returns:
      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.

    • hasPeriodTriggers

      public final boolean hasPeriodTriggers()
      For responses, this returns true if the service returned a value for the PeriodTriggers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • periodTriggersAsStrings

      public final List<String> periodTriggersAsStrings()
      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPeriodTriggers() method.

      Returns:
      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.

    • profile

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, profile will return Profile.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from profileAsString().

      Returns:
      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.
      See Also:

    • profileAsString

      public final String profileAsString()
      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.

      If the service returns an enum value that is not available in the current SDK version, profile will return Profile.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from profileAsString().

      Returns:
      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.
      See Also:

    • segmentDurationSeconds

      public final Integer segmentDurationSeconds()
      Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
      Returns:
      Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.

    • segmentTemplateFormat

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, segmentTemplateFormat will return SegmentTemplateFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from segmentTemplateFormatAsString().

      Returns:
      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.
      See Also:

    • segmentTemplateFormatAsString

      public final String segmentTemplateFormatAsString()
      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.

      If the service returns an enum value that is not available in the current SDK version, segmentTemplateFormat will return SegmentTemplateFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from segmentTemplateFormatAsString().

      Returns:
      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.
      See Also:

    • streamSelection

      public final StreamSelection streamSelection()
      Returns the value of the StreamSelection property for this object.
      Returns:
      The value of the StreamSelection property for this object.

    • suggestedPresentationDelaySeconds

      public final Integer suggestedPresentationDelaySeconds()
      Duration (in seconds) to delay live content before presentation.
      Returns:
      Duration (in seconds) to delay live content before presentation.

    • utcTiming

      public final UtcTiming utcTiming()
      Determines the type of UTCTiming included in the Media Presentation Description (MPD)

      If the service returns an enum value that is not available in the current SDK version, utcTiming will return UtcTiming.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from utcTimingAsString().

      Returns:
      Determines the type of UTCTiming included in the Media Presentation Description (MPD)
      See Also:

    • utcTimingAsString

      public final String utcTimingAsString()
      Determines the type of UTCTiming included in the Media Presentation Description (MPD)

      If the service returns an enum value that is not available in the current SDK version, utcTiming will return UtcTiming.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from utcTimingAsString().

      Returns:
      Determines the type of UTCTiming included in the Media Presentation Description (MPD)
      See Also:

    • utcTimingUri

      public final String utcTimingUri()
      Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE
      Returns:
      Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE

    • toBuilder

      public DashPackage.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DashPackage.Builder,DashPackage>
      Returns:
      a builder for type T

    • builder

      public static DashPackage.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DashPackage.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.