Class CreateDashManifestConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CreateDashManifestConfiguration.Builder,
CreateDashManifestConfiguration>
Create a DASH manifest configuration.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final DashDrmSignaling
Determines how the DASH manifest signals the DRM content.final String
Determines how the DASH manifest signals the DRM content.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FilterConfiguration
Returns the value of the FilterConfiguration property for this object.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the PeriodTriggers property.final String
A short string that's appended to the endpoint URL.final Integer
The total duration (in seconds) of the manifest's content.final Integer
Minimum amount of content (in seconds) that a player must keep available in the buffer.final Integer
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.final List
<DashPeriodTrigger> A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods.A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods.final ScteDash
scteDash()
The SCTE configuration.Determines the type of variable used in themedia
URL of theSegmentTemplate
tag in the manifest.final String
Determines the type of variable used in themedia
URL of theSegmentTemplate
tag in the manifest.static Class
<? extends CreateDashManifestConfiguration.Builder> final Integer
The amount of time (in seconds) that the player should be from the end of the manifest.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final DashUtcTiming
Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
manifestName
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint.
- Returns:
- A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint.
-
manifestWindowSeconds
The total duration (in seconds) of the manifest's content.
- Returns:
- The total duration (in seconds) of the manifest's content.
-
filterConfiguration
Returns the value of the FilterConfiguration property for this object.- Returns:
- The value of the FilterConfiguration property for this object.
-
minUpdatePeriodSeconds
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.
- Returns:
- Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.
-
minBufferTimeSeconds
Minimum amount of content (in seconds) that a player must keep available in the buffer.
- Returns:
- Minimum amount of content (in seconds) that a player must keep available in the buffer.
-
suggestedPresentationDelaySeconds
The amount of time (in seconds) that the player should be from the end of the manifest.
- Returns:
- The amount of time (in seconds) that the player should be from the end of the manifest.
-
segmentTemplateFormat
Determines the type of variable used in the
media
URL of theSegmentTemplate
tag in the manifest. Also specifies if segment timeline information is included inSegmentTimeline
orSegmentTemplate
.Value description:
-
NUMBER_WITH_TIMELINE
- The$Number$
variable is used in themedia
URL. The value of this variable is the sequential number of the segment. A fullSegmentTimeline
object is presented in eachSegmentTemplate
.
If the service returns an enum value that is not available in the current SDK version,
segmentTemplateFormat
will returnDashSegmentTemplateFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsegmentTemplateFormatAsString()
.- Returns:
- Determines the type of variable used in the
media
URL of theSegmentTemplate
tag in the manifest. Also specifies if segment timeline information is included inSegmentTimeline
orSegmentTemplate
.Value description:
-
NUMBER_WITH_TIMELINE
- The$Number$
variable is used in themedia
URL. The value of this variable is the sequential number of the segment. A fullSegmentTimeline
object is presented in eachSegmentTemplate
.
-
- See Also:
-
-
segmentTemplateFormatAsString
Determines the type of variable used in the
media
URL of theSegmentTemplate
tag in the manifest. Also specifies if segment timeline information is included inSegmentTimeline
orSegmentTemplate
.Value description:
-
NUMBER_WITH_TIMELINE
- The$Number$
variable is used in themedia
URL. The value of this variable is the sequential number of the segment. A fullSegmentTimeline
object is presented in eachSegmentTemplate
.
If the service returns an enum value that is not available in the current SDK version,
segmentTemplateFormat
will returnDashSegmentTemplateFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsegmentTemplateFormatAsString()
.- Returns:
- Determines the type of variable used in the
media
URL of theSegmentTemplate
tag in the manifest. Also specifies if segment timeline information is included inSegmentTimeline
orSegmentTemplate
.Value description:
-
NUMBER_WITH_TIMELINE
- The$Number$
variable is used in themedia
URL. The value of this variable is the sequential number of the segment. A fullSegmentTimeline
object is presented in eachSegmentTemplate
.
-
- See Also:
-
-
periodTriggers
A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type
ADS
to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.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 AWS Elemental MediaPackage separates the MPEG-DASH manifest into
multiple periods. Type
ADS
to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.
-
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
A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type
ADS
to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.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 AWS Elemental MediaPackage separates the MPEG-DASH manifest into
multiple periods. Type
ADS
to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.
-
scteDash
The SCTE configuration.
- Returns:
- The SCTE configuration.
-
drmSignaling
Determines how the DASH manifest signals the DRM content.
If the service returns an enum value that is not available in the current SDK version,
drmSignaling
will returnDashDrmSignaling.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdrmSignalingAsString()
.- Returns:
- Determines how the DASH manifest signals the DRM content.
- See Also:
-
drmSignalingAsString
Determines how the DASH manifest signals the DRM content.
If the service returns an enum value that is not available in the current SDK version,
drmSignaling
will returnDashDrmSignaling.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdrmSignalingAsString()
.- Returns:
- Determines how the DASH manifest signals the DRM content.
- See Also:
-
utcTiming
Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
- Returns:
- Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
-
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 interfaceToCopyableBuilder<CreateDashManifestConfiguration.Builder,
CreateDashManifestConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-