Package software.amazon.awssdk.services.mediapackagevod.model

Class DashPackage

java.lang.Object
software.amazon.awssdk.services.mediapackagevod.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

    • hasDashManifests

      public final boolean hasDashManifests()
      For responses, this returns true if the service returned a value for the DashManifests 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.

    • dashManifests

      public final List<DashManifest> dashManifests()
      A list of DASH manifest configurations.

      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 hasDashManifests() method.

      Returns:
      A list of DASH manifest configurations.

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

    • includeEncoderConfigurationInSegments

      public final Boolean includeEncoderConfigurationInSegments()
      When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.
      Returns:
      When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.

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

    • 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 Asset 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 Asset 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 Asset 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 Asset contains SCTE-35 ad markers.

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

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