Class GetDashStreamingSessionUrlRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetDashStreamingSessionUrlRequest.Builder,
GetDashStreamingSessionUrlRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final DASHFragmentSelector
The time range of the requested fragment and the source of the timestamps.Fragments are identified in the manifest file based on their sequence number in the session.final String
Fragments are identified in the manifest file based on their sequence number in the session.Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file can be derived using attributes in the manifest itself.final String
Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file can be derived using attributes in the manifest itself.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
expires()
The time in seconds until the requested session expires.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Long
The maximum number of fragments that are returned in the MPEG-DASH manifest.final DASHPlaybackMode
Whether to retrieve live, live replay, or archived, on-demand data.final String
Whether to retrieve live, live replay, or archived, on-demand data.static Class
<? extends GetDashStreamingSessionUrlRequest.Builder> final String
The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH manifest URL.final String
The name of the stream for which to retrieve the MPEG-DASH manifest URL.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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
streamName
The name of the stream for which to retrieve the MPEG-DASH manifest URL.
You must specify either the
StreamName
or theStreamARN
.- Returns:
- The name of the stream for which to retrieve the MPEG-DASH manifest URL.
You must specify either the
StreamName
or theStreamARN
.
-
streamARN
The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH manifest URL.
You must specify either the
StreamName
or theStreamARN
.- Returns:
- The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH manifest URL.
You must specify either the
StreamName
or theStreamARN
.
-
playbackMode
Whether to retrieve live, live replay, or archived, on-demand data.
Features of the three types of sessions include the following:
-
LIVE
: For sessions of this type, the MPEG-DASH manifest is continually updated with the latest fragments as they become available. We recommend that the media player retrieve a new manifest on a one-second interval. When this type of session is played in a media player, the user interface typically displays a "live" notification, with no scrubber control for choosing the position in the playback window to display.In
LIVE
mode, the newest available fragments are included in an MPEG-DASH manifest, even if there is a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt or cause a jump in playback. In this mode, fragments are not added to the MPEG-DASH manifest if they are older than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment is added to the manifest, the older fragment is not added, and the gap is not filled. -
LIVE_REPLAY
: For sessions of this type, the MPEG-DASH manifest is updated similarly to how it is updated forLIVE
mode except that it starts by including fragments from a given start time. Instead of fragments being added as they are ingested, fragments are added as the duration of the next fragment elapses. For example, if the fragments in the session are two seconds long, then a new fragment is added to the manifest every two seconds. This mode is useful to be able to start playback from when an event is detected and continue live streaming media that has not yet been ingested as of the time of the session creation. This mode is also useful to stream previously archived media without being limited by the 1,000 fragment limit in theON_DEMAND
mode. -
ON_DEMAND
: For sessions of this type, the MPEG-DASH manifest contains all the fragments for the session, up to the number that is specified inMaxManifestFragmentResults
. The manifest must be retrieved only once for each session. When this type of session is played in a media player, the user interface typically displays a scrubber control for choosing the position in the playback window to display.
In all playback modes, if
FragmentSelectorType
isPRODUCER_TIMESTAMP
, and if there are multiple fragments with the same start timestamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the MPEG-DASH manifest. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media player.The default is
LIVE
.If the service returns an enum value that is not available in the current SDK version,
playbackMode
will returnDASHPlaybackMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplaybackModeAsString()
.- Returns:
- Whether to retrieve live, live replay, or archived, on-demand data.
Features of the three types of sessions include the following:
-
LIVE
: For sessions of this type, the MPEG-DASH manifest is continually updated with the latest fragments as they become available. We recommend that the media player retrieve a new manifest on a one-second interval. When this type of session is played in a media player, the user interface typically displays a "live" notification, with no scrubber control for choosing the position in the playback window to display.In
LIVE
mode, the newest available fragments are included in an MPEG-DASH manifest, even if there is a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt or cause a jump in playback. In this mode, fragments are not added to the MPEG-DASH manifest if they are older than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment is added to the manifest, the older fragment is not added, and the gap is not filled. -
LIVE_REPLAY
: For sessions of this type, the MPEG-DASH manifest is updated similarly to how it is updated forLIVE
mode except that it starts by including fragments from a given start time. Instead of fragments being added as they are ingested, fragments are added as the duration of the next fragment elapses. For example, if the fragments in the session are two seconds long, then a new fragment is added to the manifest every two seconds. This mode is useful to be able to start playback from when an event is detected and continue live streaming media that has not yet been ingested as of the time of the session creation. This mode is also useful to stream previously archived media without being limited by the 1,000 fragment limit in theON_DEMAND
mode. -
ON_DEMAND
: For sessions of this type, the MPEG-DASH manifest contains all the fragments for the session, up to the number that is specified inMaxManifestFragmentResults
. The manifest must be retrieved only once for each session. When this type of session is played in a media player, the user interface typically displays a scrubber control for choosing the position in the playback window to display.
In all playback modes, if
FragmentSelectorType
isPRODUCER_TIMESTAMP
, and if there are multiple fragments with the same start timestamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the MPEG-DASH manifest. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media player.The default is
LIVE
. -
- See Also:
-
-
playbackModeAsString
Whether to retrieve live, live replay, or archived, on-demand data.
Features of the three types of sessions include the following:
-
LIVE
: For sessions of this type, the MPEG-DASH manifest is continually updated with the latest fragments as they become available. We recommend that the media player retrieve a new manifest on a one-second interval. When this type of session is played in a media player, the user interface typically displays a "live" notification, with no scrubber control for choosing the position in the playback window to display.In
LIVE
mode, the newest available fragments are included in an MPEG-DASH manifest, even if there is a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt or cause a jump in playback. In this mode, fragments are not added to the MPEG-DASH manifest if they are older than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment is added to the manifest, the older fragment is not added, and the gap is not filled. -
LIVE_REPLAY
: For sessions of this type, the MPEG-DASH manifest is updated similarly to how it is updated forLIVE
mode except that it starts by including fragments from a given start time. Instead of fragments being added as they are ingested, fragments are added as the duration of the next fragment elapses. For example, if the fragments in the session are two seconds long, then a new fragment is added to the manifest every two seconds. This mode is useful to be able to start playback from when an event is detected and continue live streaming media that has not yet been ingested as of the time of the session creation. This mode is also useful to stream previously archived media without being limited by the 1,000 fragment limit in theON_DEMAND
mode. -
ON_DEMAND
: For sessions of this type, the MPEG-DASH manifest contains all the fragments for the session, up to the number that is specified inMaxManifestFragmentResults
. The manifest must be retrieved only once for each session. When this type of session is played in a media player, the user interface typically displays a scrubber control for choosing the position in the playback window to display.
In all playback modes, if
FragmentSelectorType
isPRODUCER_TIMESTAMP
, and if there are multiple fragments with the same start timestamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the MPEG-DASH manifest. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media player.The default is
LIVE
.If the service returns an enum value that is not available in the current SDK version,
playbackMode
will returnDASHPlaybackMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplaybackModeAsString()
.- Returns:
- Whether to retrieve live, live replay, or archived, on-demand data.
Features of the three types of sessions include the following:
-
LIVE
: For sessions of this type, the MPEG-DASH manifest is continually updated with the latest fragments as they become available. We recommend that the media player retrieve a new manifest on a one-second interval. When this type of session is played in a media player, the user interface typically displays a "live" notification, with no scrubber control for choosing the position in the playback window to display.In
LIVE
mode, the newest available fragments are included in an MPEG-DASH manifest, even if there is a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt or cause a jump in playback. In this mode, fragments are not added to the MPEG-DASH manifest if they are older than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment is added to the manifest, the older fragment is not added, and the gap is not filled. -
LIVE_REPLAY
: For sessions of this type, the MPEG-DASH manifest is updated similarly to how it is updated forLIVE
mode except that it starts by including fragments from a given start time. Instead of fragments being added as they are ingested, fragments are added as the duration of the next fragment elapses. For example, if the fragments in the session are two seconds long, then a new fragment is added to the manifest every two seconds. This mode is useful to be able to start playback from when an event is detected and continue live streaming media that has not yet been ingested as of the time of the session creation. This mode is also useful to stream previously archived media without being limited by the 1,000 fragment limit in theON_DEMAND
mode. -
ON_DEMAND
: For sessions of this type, the MPEG-DASH manifest contains all the fragments for the session, up to the number that is specified inMaxManifestFragmentResults
. The manifest must be retrieved only once for each session. When this type of session is played in a media player, the user interface typically displays a scrubber control for choosing the position in the playback window to display.
In all playback modes, if
FragmentSelectorType
isPRODUCER_TIMESTAMP
, and if there are multiple fragments with the same start timestamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the MPEG-DASH manifest. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media player.The default is
LIVE
. -
- See Also:
-
-
displayFragmentTimestamp
Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file can be derived using attributes in the manifest itself. However, typically, MPEG-DASH compatible media players do not properly handle gaps in the media timeline. Kinesis Video Streams adjusts the media timeline in the manifest file to enable playback of media with discontinuities. Therefore, the wall-clock time derived from the manifest file may be inaccurate. If DisplayFragmentTimestamp is set to
ALWAYS
, the accurate fragment timestamp is added to each S element in the manifest file with the attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this custom attribute.The default value is
NEVER
. When DASHFragmentSelector isSERVER_TIMESTAMP
, the timestamps will be the server start timestamps. Similarly, when DASHFragmentSelector isPRODUCER_TIMESTAMP
, the timestamps will be the producer start timestamps.If the service returns an enum value that is not available in the current SDK version,
displayFragmentTimestamp
will returnDASHDisplayFragmentTimestamp.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdisplayFragmentTimestampAsString()
.- Returns:
- Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file can be derived
using attributes in the manifest itself. However, typically, MPEG-DASH compatible media players do not
properly handle gaps in the media timeline. Kinesis Video Streams adjusts the media timeline in the
manifest file to enable playback of media with discontinuities. Therefore, the wall-clock time derived
from the manifest file may be inaccurate. If DisplayFragmentTimestamp is set to
ALWAYS
, the accurate fragment timestamp is added to each S element in the manifest file with the attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this custom attribute.The default value is
NEVER
. When DASHFragmentSelector isSERVER_TIMESTAMP
, the timestamps will be the server start timestamps. Similarly, when DASHFragmentSelector isPRODUCER_TIMESTAMP
, the timestamps will be the producer start timestamps. - See Also:
-
displayFragmentTimestampAsString
Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file can be derived using attributes in the manifest itself. However, typically, MPEG-DASH compatible media players do not properly handle gaps in the media timeline. Kinesis Video Streams adjusts the media timeline in the manifest file to enable playback of media with discontinuities. Therefore, the wall-clock time derived from the manifest file may be inaccurate. If DisplayFragmentTimestamp is set to
ALWAYS
, the accurate fragment timestamp is added to each S element in the manifest file with the attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this custom attribute.The default value is
NEVER
. When DASHFragmentSelector isSERVER_TIMESTAMP
, the timestamps will be the server start timestamps. Similarly, when DASHFragmentSelector isPRODUCER_TIMESTAMP
, the timestamps will be the producer start timestamps.If the service returns an enum value that is not available in the current SDK version,
displayFragmentTimestamp
will returnDASHDisplayFragmentTimestamp.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdisplayFragmentTimestampAsString()
.- Returns:
- Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file can be derived
using attributes in the manifest itself. However, typically, MPEG-DASH compatible media players do not
properly handle gaps in the media timeline. Kinesis Video Streams adjusts the media timeline in the
manifest file to enable playback of media with discontinuities. Therefore, the wall-clock time derived
from the manifest file may be inaccurate. If DisplayFragmentTimestamp is set to
ALWAYS
, the accurate fragment timestamp is added to each S element in the manifest file with the attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this custom attribute.The default value is
NEVER
. When DASHFragmentSelector isSERVER_TIMESTAMP
, the timestamps will be the server start timestamps. Similarly, when DASHFragmentSelector isPRODUCER_TIMESTAMP
, the timestamps will be the producer start timestamps. - See Also:
-
displayFragmentNumber
Fragments are identified in the manifest file based on their sequence number in the session. If DisplayFragmentNumber is set to
ALWAYS
, the Kinesis Video Streams fragment number is added to each S element in the manifest file with the attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with other APIs (e.g.GetMedia
andGetMediaForFragmentList
). A custom MPEG-DASH media player is necessary to leverage these this custom attribute.The default value is
NEVER
.If the service returns an enum value that is not available in the current SDK version,
displayFragmentNumber
will returnDASHDisplayFragmentNumber.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdisplayFragmentNumberAsString()
.- Returns:
- Fragments are identified in the manifest file based on their sequence number in the session. If
DisplayFragmentNumber is set to
ALWAYS
, the Kinesis Video Streams fragment number is added to each S element in the manifest file with the attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with other APIs (e.g.GetMedia
andGetMediaForFragmentList
). A custom MPEG-DASH media player is necessary to leverage these this custom attribute.The default value is
NEVER
. - See Also:
-
displayFragmentNumberAsString
Fragments are identified in the manifest file based on their sequence number in the session. If DisplayFragmentNumber is set to
ALWAYS
, the Kinesis Video Streams fragment number is added to each S element in the manifest file with the attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with other APIs (e.g.GetMedia
andGetMediaForFragmentList
). A custom MPEG-DASH media player is necessary to leverage these this custom attribute.The default value is
NEVER
.If the service returns an enum value that is not available in the current SDK version,
displayFragmentNumber
will returnDASHDisplayFragmentNumber.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdisplayFragmentNumberAsString()
.- Returns:
- Fragments are identified in the manifest file based on their sequence number in the session. If
DisplayFragmentNumber is set to
ALWAYS
, the Kinesis Video Streams fragment number is added to each S element in the manifest file with the attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with other APIs (e.g.GetMedia
andGetMediaForFragmentList
). A custom MPEG-DASH media player is necessary to leverage these this custom attribute.The default value is
NEVER
. - See Also:
-
dashFragmentSelector
The time range of the requested fragment and the source of the timestamps.
This parameter is required if
PlaybackMode
isON_DEMAND
orLIVE_REPLAY
. This parameter is optional if PlaybackMode isLIVE
. IfPlaybackMode
isLIVE
, theFragmentSelectorType
can be set, but theTimestampRange
should not be set. IfPlaybackMode
isON_DEMAND
orLIVE_REPLAY
, bothFragmentSelectorType
andTimestampRange
must be set.- Returns:
- The time range of the requested fragment and the source of the timestamps.
This parameter is required if
PlaybackMode
isON_DEMAND
orLIVE_REPLAY
. This parameter is optional if PlaybackMode isLIVE
. IfPlaybackMode
isLIVE
, theFragmentSelectorType
can be set, but theTimestampRange
should not be set. IfPlaybackMode
isON_DEMAND
orLIVE_REPLAY
, bothFragmentSelectorType
andTimestampRange
must be set.
-
expires
The time in seconds until the requested session expires. This value can be between 300 (5 minutes) and 43200 (12 hours).
When a session expires, no new calls to
GetDashManifest
,GetMP4InitFragment
, orGetMP4MediaFragment
can be made for that session.The default is 300 (5 minutes).
- Returns:
- The time in seconds until the requested session expires. This value can be between 300 (5 minutes) and
43200 (12 hours).
When a session expires, no new calls to
GetDashManifest
,GetMP4InitFragment
, orGetMP4MediaFragment
can be made for that session.The default is 300 (5 minutes).
-
maxManifestFragmentResults
The maximum number of fragments that are returned in the MPEG-DASH manifest.
When the
PlaybackMode
isLIVE
, the most recent fragments are returned up to this value. When thePlaybackMode
isON_DEMAND
, the oldest fragments are returned, up to this maximum number.When there are a higher number of fragments available in a live MPEG-DASH manifest, video players often buffer content before starting playback. Increasing the buffer size increases the playback latency, but it decreases the likelihood that rebuffering will occur during playback. We recommend that a live MPEG-DASH manifest have a minimum of 3 fragments and a maximum of 10 fragments.
The default is 5 fragments if
PlaybackMode
isLIVE
orLIVE_REPLAY
, and 1,000 ifPlaybackMode
isON_DEMAND
.The maximum value of 1,000 fragments corresponds to more than 16 minutes of video on streams with 1-second fragments, and more than 2 1/2 hours of video on streams with 10-second fragments.
- Returns:
- The maximum number of fragments that are returned in the MPEG-DASH manifest.
When the
PlaybackMode
isLIVE
, the most recent fragments are returned up to this value. When thePlaybackMode
isON_DEMAND
, the oldest fragments are returned, up to this maximum number.When there are a higher number of fragments available in a live MPEG-DASH manifest, video players often buffer content before starting playback. Increasing the buffer size increases the playback latency, but it decreases the likelihood that rebuffering will occur during playback. We recommend that a live MPEG-DASH manifest have a minimum of 3 fragments and a maximum of 10 fragments.
The default is 5 fragments if
PlaybackMode
isLIVE
orLIVE_REPLAY
, and 1,000 ifPlaybackMode
isON_DEMAND
.The maximum value of 1,000 fragments corresponds to more than 16 minutes of video on streams with 1-second fragments, and more than 2 1/2 hours of video on streams with 10-second fragments.
-
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<GetDashStreamingSessionUrlRequest.Builder,
GetDashStreamingSessionUrlRequest> - Specified by:
toBuilder
in classKinesisVideoArchivedMediaRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-