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(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
static DashPackage.Builder	builder()
List<DashManifest>	dashManifests() A list of DASH manifest configurations.
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	hasDashManifests() For responses, this returns true if the service returned a value for the DashManifests property.
int	hashCode()
boolean	hasPeriodTriggers() For responses, this returns true if the service returned a value for the PeriodTriggers property.
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.
Boolean	includeIframeOnlyStream() When enabled, an I-Frame only stream will be included in the output.
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.
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()
DashPackage.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

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:

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

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