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(value="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 and Description
static interface	DashPackage.Builder

Method Summary

Modifier and Type	Method and Description
AdsOnDeliveryRestrictions	adsOnDeliveryRestrictions() Returns the value of the AdsOnDeliveryRestrictions property for this object.
String	adsOnDeliveryRestrictionsAsString() 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.Builder	builder()
DashEncryption	encryption() Returns the value of the Encryption property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdTriggers() Returns true if the AdTriggers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasPeriodTriggers() Returns true if the PeriodTriggers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
ManifestLayout	manifestLayout() Determines the position of some tags in the Media Presentation Description (MPD).
String	manifestLayoutAsString() Determines the position of some tags in the Media Presentation Description (MPD).
Integer	manifestWindowSeconds() Time window (in seconds) contained in each manifest.
Integer	minBufferTimeSeconds() Minimum duration (in seconds) that a player will buffer media before starting the presentation.
Integer	minUpdatePeriodSeconds() 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.
Profile	profile() The Dynamic Adaptive Streaming over HTTP (DASH) profile type.
String	profileAsString() The Dynamic Adaptive Streaming over HTTP (DASH) profile type.
List<SdkField<?>>	sdkFields()
Integer	segmentDurationSeconds() Duration (in seconds) of each segment.
SegmentTemplateFormat	segmentTemplateFormat() Determines the type of SegmentTemplate included in the Media Presentation Description (MPD).
String	segmentTemplateFormatAsString() Determines the type of SegmentTemplate included in the Media Presentation Description (MPD).
static Class<? extends DashPackage.Builder>	serializableBuilderClass()
StreamSelection	streamSelection() Returns the value of the StreamSelection property for this object.
Integer	suggestedPresentationDelaySeconds() Duration (in seconds) to delay live content before presentation.
DashPackage.Builder	toBuilder()
String	toString() Returns a string representation of this object.
UtcTiming	utcTiming() Determines the type of UTCTiming included in the Media Presentation Description (MPD)
String	utcTimingAsString() Determines the type of UTCTiming included in the Media Presentation Description (MPD)
String	utcTimingUri() Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO or HTTP-HEAD

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.

You can use hasAdTriggers() to see if a value was sent in this field.

Returns:

The value of the AdTriggers property for this object.

hasAdTriggers

public final boolean hasAdTriggers()

Returns true if the AdTriggers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasAdTriggers() to see if a value was sent in this field.

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:

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

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.

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.

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.

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.

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.

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.

You can use hasPeriodTriggers() to see if a value was sent in this field.

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()

Returns true if the PeriodTriggers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasPeriodTriggers() to see if a value was sent in this field.

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.

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.

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.

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.

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

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

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

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

UtcTiming

utcTimingUri

public final String utcTimingUri()

Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO or HTTP-HEAD

Returns:

Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO or HTTP-HEAD

toBuilder

public DashPackage.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DashPackage.Builder,DashPackage>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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