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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDashPackage.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AdsOnDeliveryRestrictionsadsOnDeliveryRestrictions()Returns the value of the AdsOnDeliveryRestrictions property for this object.StringadsOnDeliveryRestrictionsAsString()Returns the value of the AdsOnDeliveryRestrictions property for this object.List<AdTriggersElement>adTriggers()Returns the value of the AdTriggers property for this object.List<String>adTriggersAsStrings()Returns the value of the AdTriggers property for this object.static DashPackage.Builderbuilder()DashEncryptionencryption()Returns the value of the Encryption property for this object.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAdTriggers()For responses, this returns true if the service returned a value for the AdTriggers property.inthashCode()booleanhasPeriodTriggers()For responses, this returns true if the service returned a value for the PeriodTriggers property.BooleanincludeIframeOnlyStream()When enabled, an I-Frame only stream will be included in the output.ManifestLayoutmanifestLayout()Determines the position of some tags in the Media Presentation Description (MPD).StringmanifestLayoutAsString()Determines the position of some tags in the Media Presentation Description (MPD).IntegermanifestWindowSeconds()Time window (in seconds) contained in each manifest.IntegerminBufferTimeSeconds()Minimum duration (in seconds) that a player will buffer media before starting the presentation.IntegerminUpdatePeriodSeconds()Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).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.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.Profileprofile()The Dynamic Adaptive Streaming over HTTP (DASH) profile type.StringprofileAsString()The Dynamic Adaptive Streaming over HTTP (DASH) profile type.List<SdkField<?>>sdkFields()IntegersegmentDurationSeconds()Duration (in seconds) of each segment.SegmentTemplateFormatsegmentTemplateFormat()Determines the type of SegmentTemplate included in the Media Presentation Description (MPD).StringsegmentTemplateFormatAsString()Determines the type of SegmentTemplate included in the Media Presentation Description (MPD).static Class<? extends DashPackage.Builder>serializableBuilderClass()StreamSelectionstreamSelection()Returns the value of the StreamSelection property for this object.IntegersuggestedPresentationDelaySeconds()Duration (in seconds) to delay live content before presentation.DashPackage.BuildertoBuilder()StringtoString()Returns a string representation of this object.UtcTimingutcTiming()Determines the type of UTCTiming included in the Media Presentation Description (MPD)StringutcTimingAsString()Determines the type of UTCTiming included in the Media Presentation Description (MPD)StringutcTimingUri()Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()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,
adsOnDeliveryRestrictionswill returnAdsOnDeliveryRestrictions.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromadsOnDeliveryRestrictionsAsString().- Returns:
- The value of the AdsOnDeliveryRestrictions property for this object.
- See Also:
AdsOnDeliveryRestrictions
-
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,
adsOnDeliveryRestrictionswill returnAdsOnDeliveryRestrictions.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromadsOnDeliveryRestrictionsAsString().- Returns:
- The value of the AdsOnDeliveryRestrictions property for this object.
- See Also:
AdsOnDeliveryRestrictions
-
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,
manifestLayoutwill returnManifestLayout.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommanifestLayoutAsString().- 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:
ManifestLayout
-
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,
manifestLayoutwill returnManifestLayout.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommanifestLayoutAsString().- 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:
ManifestLayout
-
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 theisEmpty()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,
profilewill returnProfile.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromprofileAsString().- 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:
Profile
-
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,
profilewill returnProfile.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromprofileAsString().- 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:
Profile
-
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,
segmentTemplateFormatwill returnSegmentTemplateFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsegmentTemplateFormatAsString().- 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:
SegmentTemplateFormat
-
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,
segmentTemplateFormatwill returnSegmentTemplateFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsegmentTemplateFormatAsString().- 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:
SegmentTemplateFormat
-
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,
utcTimingwill returnUtcTiming.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromutcTimingAsString().- Returns:
- Determines the type of UTCTiming included in the Media Presentation Description (MPD)
- See Also:
UtcTiming
-
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,
utcTimingwill returnUtcTiming.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromutcTimingAsString().- Returns:
- Determines the type of UTCTiming included in the Media Presentation Description (MPD)
- See Also:
UtcTiming
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DashPackage.Builder,DashPackage>
-
builder
public static DashPackage.Builder builder()
-
serializableBuilderClass
public static Class<? extends DashPackage.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-