public class GetHLSStreamingSessionURLRequest extends AmazonWebServiceRequest implements java.io.Serializable
Retrieves an HTTP Live Streaming (HLS) URL for the stream. The URL can then be opened in a browser or media player to view the stream contents.
You must specify either the StreamName or the
StreamARN.
An Amazon Kinesis video stream has the following requirements for providing data through HLS:
The media type must be video/h264.
Data retention must be greater than 0.
The fragments must contain codec private data in the AVC (Advanced Video Coding) for H.264 format (MPEG-4 specification ISO/IEC 14496-15). For information about adapting stream data to a given format, see NAL Adaptation Flags.
Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form (also called fMP4 or CMAF), rather than the MPEG-2 form (also called TS chunks, which the HLS specification also supports). For more information about HLS fragment types, see the HLS specification.
The following procedure shows how to use HLS with Kinesis Video Streams:
Get an endpoint using GetDataEndpoint, specifying GET_HLS_STREAMING_SESSION_URL
for the APIName parameter.
Retrieve the HLS URL using GetHLSStreamingSessionURL. Kinesis
Video Streams creates an HLS streaming session to be used for accessing
content in a stream using the HLS protocol.
GetHLSStreamingSessionURL returns an authenticated URL (that
includes an encrypted session token) for the session's HLS master
playlist (the root resource needed for streaming with HLS).
Don't share or store this token where an unauthorized entity could access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you would use with your AWS credentials.
The media that is made available through the playlist consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bit rates) is made available.
Provide the URL (containing the encrypted session token) for the HLS master playlist to a media player that supports the HLS protocol. Kinesis Video Streams makes the HLS media playlist, initialization fragment, and media fragments available through the master playlist URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video decoder and renderer. The media fragments contain H.264-encoded video frames and time stamps.
The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions:
GetHLSMasterPlaylist: Retrieves an HLS master playlist, which contains
a URL for the GetHLSMediaPlaylist action, and additional
metadata for the media player, including estimated bit rate and resolution.
GetHLSMediaPlaylist: Retrieves an HLS media playlist, which contains a
URL to access the MP4 intitialization fragment with the
GetMP4InitFragment action, and URLs to access the MP4 media
fragments with the GetMP4MediaFragment actions. The HLS media
playlist also contains metadata about the stream that the player needs to
play it, such as whether the PlaybackMode is LIVE
or ON_DEMAND. The HLS media playlist is typically static for
sessions with a PlaybackType of ON_DEMAND. The HLS
media playlist is continually updated with new fragments for sessions with a
PlaybackType of LIVE.
GetMP4InitFragment: Retrieves the MP4 initialization fragment. The
media player typically loads the initialization fragment before loading any
media fragments. This fragment contains the "fytp" and "
moov" MP4 atoms, and the child atoms that are needed to
initialize the media player decoder.
The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream, which the media player needs to decode video frames.
GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments
contain the "moof" and "mdat" MP4 atoms and their
child atoms, containing the encoded fragment's video frames and their time
stamps.
After the first media fragment is made available in a streaming session, any fragments that don't contain the same codec private data are excluded in the HLS media playlist. Therefore, the codec private data does not change between fragments in a session.
The following restrictions apply to HLS sessions:
A streaming session URL should not be shared between players. The service might throttle a session if multiple media players are sharing it. For connection limits, see Kinesis Video Streams Limits.
A Kinesis video stream can have a maximum of five active HLS streaming
sessions. If a new session is created when the maximum number of sessions is
already active, the oldest (earliest created) session is closed. The number
of active GetMedia connections on a Kinesis video stream does
not count against this limit, and the number of active HLS sessions does not
count against the active GetMedia connection limit.
You can monitor the amount of data that the media player consumes by
monitoring the GetMP4MediaFragment.OutgoingBytes Amazon
CloudWatch metric. For information about using CloudWatch to monitor Kinesis
Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis
Video Streams Pricing and AWS
Pricing. Charges for both HLS sessions and outgoing AWS data apply.
For more information about HLS, see HTTP Live Streaming on the Apple Developer site.
| Constructor and Description |
|---|
GetHLSStreamingSessionURLRequest() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getDiscontinuityMode()
Returns the value of the discontinuityMode property for this object.
|
java.lang.Integer |
getExpires()
The time in seconds until the requested session expires.
|
HLSFragmentSelector |
getHLSFragmentSelector()
The time range of the requested fragment, and the source of the time
stamp.
|
java.lang.Long |
getMaxMediaPlaylistFragmentResults()
The maximum number of fragments that Kinesis Video Streams will return.
|
java.lang.String |
getPlaybackMode()
Whether to retrieve live or archived, on-demand data.
|
java.lang.String |
getStreamARN()
The Amazon Resource Name (ARN) of the stream for which to retrieve the
HLS master playlist URL.
|
java.lang.String |
getStreamName()
The name of the stream for which to retrieve the HLS master playlist URL.
|
int |
hashCode() |
void |
setDiscontinuityMode(DiscontinuityMode discontinuityMode)
Sets the value of discontinuityMode
|
void |
setDiscontinuityMode(java.lang.String discontinuityMode)
Sets the value of discontinuityMode
|
void |
setExpires(java.lang.Integer expires)
The time in seconds until the requested session expires.
|
void |
setHLSFragmentSelector(HLSFragmentSelector hLSFragmentSelector)
The time range of the requested fragment, and the source of the time
stamp.
|
void |
setMaxMediaPlaylistFragmentResults(java.lang.Long maxMediaPlaylistFragmentResults)
The maximum number of fragments that Kinesis Video Streams will return.
|
void |
setPlaybackMode(PlaybackMode playbackMode)
Whether to retrieve live or archived, on-demand data.
|
void |
setPlaybackMode(java.lang.String playbackMode)
Whether to retrieve live or archived, on-demand data.
|
void |
setStreamARN(java.lang.String streamARN)
The Amazon Resource Name (ARN) of the stream for which to retrieve the
HLS master playlist URL.
|
void |
setStreamName(java.lang.String streamName)
The name of the stream for which to retrieve the HLS master playlist URL.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
GetHLSStreamingSessionURLRequest |
withDiscontinuityMode(DiscontinuityMode discontinuityMode)
Sets the value of the discontinuityMode property for this object.
|
GetHLSStreamingSessionURLRequest |
withDiscontinuityMode(java.lang.String discontinuityMode)
Sets the value of the discontinuityMode property for this object.
|
GetHLSStreamingSessionURLRequest |
withExpires(java.lang.Integer expires)
The time in seconds until the requested session expires.
|
GetHLSStreamingSessionURLRequest |
withHLSFragmentSelector(HLSFragmentSelector hLSFragmentSelector)
The time range of the requested fragment, and the source of the time
stamp.
|
GetHLSStreamingSessionURLRequest |
withMaxMediaPlaylistFragmentResults(java.lang.Long maxMediaPlaylistFragmentResults)
The maximum number of fragments that Kinesis Video Streams will return.
|
GetHLSStreamingSessionURLRequest |
withPlaybackMode(PlaybackMode playbackMode)
Whether to retrieve live or archived, on-demand data.
|
GetHLSStreamingSessionURLRequest |
withPlaybackMode(java.lang.String playbackMode)
Whether to retrieve live or archived, on-demand data.
|
GetHLSStreamingSessionURLRequest |
withStreamARN(java.lang.String streamARN)
The Amazon Resource Name (ARN) of the stream for which to retrieve the
HLS master playlist URL.
|
GetHLSStreamingSessionURLRequest |
withStreamName(java.lang.String streamName)
The name of the stream for which to retrieve the HLS master playlist URL.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic java.lang.String getStreamName()
The name of the stream for which to retrieve the HLS master playlist URL.
You must specify either the StreamName or the
StreamARN.
Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+
The name of the stream for which to retrieve the HLS master playlist URL.
You must specify either the StreamName or the
StreamARN.
public void setStreamName(java.lang.String streamName)
The name of the stream for which to retrieve the HLS master playlist URL.
You must specify either the StreamName or the
StreamARN.
Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+
streamName - The name of the stream for which to retrieve the HLS master playlist URL.
You must specify either the StreamName or the
StreamARN.
public GetHLSStreamingSessionURLRequest withStreamName(java.lang.String streamName)
The name of the stream for which to retrieve the HLS master playlist URL.
You must specify either the StreamName or the
StreamARN.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+
streamName - The name of the stream for which to retrieve the HLS master playlist URL.
You must specify either the StreamName or the
StreamARN.
public java.lang.String getStreamARN()
The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master playlist URL.
You must specify either the StreamName or the
StreamARN.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master playlist URL.
You must specify either the StreamName or the
StreamARN.
public void setStreamARN(java.lang.String streamARN)
The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master playlist URL.
You must specify either the StreamName or the
StreamARN.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
streamARN - The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master playlist URL.
You must specify either the StreamName or the
StreamARN.
public GetHLSStreamingSessionURLRequest withStreamARN(java.lang.String streamARN)
The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master playlist URL.
You must specify either the StreamName or the
StreamARN.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
streamARN - The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master playlist URL.
You must specify either the StreamName or the
StreamARN.
public java.lang.String getPlaybackMode()
Whether to retrieve live or archived, on-demand data.
Features of the two types of session include the following:
LIVE : For sessions of this type, the HLS media
playlist is continually updated with the latest fragments as they become
available. We recommend that the media player retrieve a new playlist 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 HLS media playlist, 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 HLS media playlist 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 playlist, the older fragment is not
added, and the gap is not filled.
ON_DEMAND : For sessions of this type, the HLS media
playlist contains all the fragments for the session, up to the number
that is specified in MaxMediaPlaylistFragmentResults. The
playlist 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.
The duration of the fragments in the HLS media playlists is typically reported as short by one frame (for example, 33 milliseconds for a 30 FPS fragment). This might cause the media player to report a shorter total duration until the media player decodes the fragments.
In both playback modes, if there are multiple fragments with the same start time stamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the HLS media playlist. The other fragments are not included. Fragments that have different time stamps but have overlapping durations are still included in the HLS media playlist. This can lead to unexpected behavior in the media player.
The default is LIVE.
Constraints:
Allowed Values: LIVE, ON_DEMAND
Whether to retrieve live or archived, on-demand data.
Features of the two types of session include the following:
LIVE : For sessions of this type, the HLS
media playlist is continually updated with the latest fragments
as they become available. We recommend that the media player
retrieve a new playlist 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 HLS media playlist, 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 HLS media playlist
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 playlist, the older fragment is not
added, and the gap is not filled.
ON_DEMAND : For sessions of this type, the
HLS media playlist contains all the fragments for the session, up
to the number that is specified in
MaxMediaPlaylistFragmentResults. The playlist 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.
The duration of the fragments in the HLS media playlists is typically reported as short by one frame (for example, 33 milliseconds for a 30 FPS fragment). This might cause the media player to report a shorter total duration until the media player decodes the fragments.
In both playback modes, if there are multiple fragments with the same start time stamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the HLS media playlist. The other fragments are not included. Fragments that have different time stamps but have overlapping durations are still included in the HLS media playlist. This can lead to unexpected behavior in the media player.
The default is LIVE.
PlaybackModepublic void setPlaybackMode(java.lang.String playbackMode)
Whether to retrieve live or archived, on-demand data.
Features of the two types of session include the following:
LIVE : For sessions of this type, the HLS media
playlist is continually updated with the latest fragments as they become
available. We recommend that the media player retrieve a new playlist 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 HLS media playlist, 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 HLS media playlist 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 playlist, the older fragment is not
added, and the gap is not filled.
ON_DEMAND : For sessions of this type, the HLS media
playlist contains all the fragments for the session, up to the number
that is specified in MaxMediaPlaylistFragmentResults. The
playlist 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.
The duration of the fragments in the HLS media playlists is typically reported as short by one frame (for example, 33 milliseconds for a 30 FPS fragment). This might cause the media player to report a shorter total duration until the media player decodes the fragments.
In both playback modes, if there are multiple fragments with the same start time stamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the HLS media playlist. The other fragments are not included. Fragments that have different time stamps but have overlapping durations are still included in the HLS media playlist. This can lead to unexpected behavior in the media player.
The default is LIVE.
Constraints:
Allowed Values: LIVE, ON_DEMAND
playbackMode - Whether to retrieve live or archived, on-demand data.
Features of the two types of session include the following:
LIVE : For sessions of this type, the HLS
media playlist is continually updated with the latest
fragments as they become available. We recommend that the
media player retrieve a new playlist 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 HLS media playlist, 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 HLS
media playlist 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 playlist, the older
fragment is not added, and the gap is not filled.
ON_DEMAND : For sessions of this type,
the HLS media playlist contains all the fragments for the
session, up to the number that is specified in
MaxMediaPlaylistFragmentResults. The playlist
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.
The duration of the fragments in the HLS media playlists is typically reported as short by one frame (for example, 33 milliseconds for a 30 FPS fragment). This might cause the media player to report a shorter total duration until the media player decodes the fragments.
In both playback modes, if there are multiple fragments with the same start time stamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the HLS media playlist. The other fragments are not included. Fragments that have different time stamps but have overlapping durations are still included in the HLS media playlist. This can lead to unexpected behavior in the media player.
The default is LIVE.
PlaybackModepublic GetHLSStreamingSessionURLRequest withPlaybackMode(java.lang.String playbackMode)
Whether to retrieve live or archived, on-demand data.
Features of the two types of session include the following:
LIVE : For sessions of this type, the HLS media
playlist is continually updated with the latest fragments as they become
available. We recommend that the media player retrieve a new playlist 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 HLS media playlist, 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 HLS media playlist 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 playlist, the older fragment is not
added, and the gap is not filled.
ON_DEMAND : For sessions of this type, the HLS media
playlist contains all the fragments for the session, up to the number
that is specified in MaxMediaPlaylistFragmentResults. The
playlist 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.
The duration of the fragments in the HLS media playlists is typically reported as short by one frame (for example, 33 milliseconds for a 30 FPS fragment). This might cause the media player to report a shorter total duration until the media player decodes the fragments.
In both playback modes, if there are multiple fragments with the same start time stamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the HLS media playlist. The other fragments are not included. Fragments that have different time stamps but have overlapping durations are still included in the HLS media playlist. This can lead to unexpected behavior in the media player.
The default is LIVE.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: LIVE, ON_DEMAND
playbackMode - Whether to retrieve live or archived, on-demand data.
Features of the two types of session include the following:
LIVE : For sessions of this type, the HLS
media playlist is continually updated with the latest
fragments as they become available. We recommend that the
media player retrieve a new playlist 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 HLS media playlist, 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 HLS
media playlist 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 playlist, the older
fragment is not added, and the gap is not filled.
ON_DEMAND : For sessions of this type,
the HLS media playlist contains all the fragments for the
session, up to the number that is specified in
MaxMediaPlaylistFragmentResults. The playlist
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.
The duration of the fragments in the HLS media playlists is typically reported as short by one frame (for example, 33 milliseconds for a 30 FPS fragment). This might cause the media player to report a shorter total duration until the media player decodes the fragments.
In both playback modes, if there are multiple fragments with the same start time stamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the HLS media playlist. The other fragments are not included. Fragments that have different time stamps but have overlapping durations are still included in the HLS media playlist. This can lead to unexpected behavior in the media player.
The default is LIVE.
PlaybackModepublic void setPlaybackMode(PlaybackMode playbackMode)
Whether to retrieve live or archived, on-demand data.
Features of the two types of session include the following:
LIVE : For sessions of this type, the HLS media
playlist is continually updated with the latest fragments as they become
available. We recommend that the media player retrieve a new playlist 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 HLS media playlist, 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 HLS media playlist 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 playlist, the older fragment is not
added, and the gap is not filled.
ON_DEMAND : For sessions of this type, the HLS media
playlist contains all the fragments for the session, up to the number
that is specified in MaxMediaPlaylistFragmentResults. The
playlist 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.
The duration of the fragments in the HLS media playlists is typically reported as short by one frame (for example, 33 milliseconds for a 30 FPS fragment). This might cause the media player to report a shorter total duration until the media player decodes the fragments.
In both playback modes, if there are multiple fragments with the same start time stamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the HLS media playlist. The other fragments are not included. Fragments that have different time stamps but have overlapping durations are still included in the HLS media playlist. This can lead to unexpected behavior in the media player.
The default is LIVE.
Constraints:
Allowed Values: LIVE, ON_DEMAND
playbackMode - Whether to retrieve live or archived, on-demand data.
Features of the two types of session include the following:
LIVE : For sessions of this type, the HLS
media playlist is continually updated with the latest
fragments as they become available. We recommend that the
media player retrieve a new playlist 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 HLS media playlist, 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 HLS
media playlist 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 playlist, the older
fragment is not added, and the gap is not filled.
ON_DEMAND : For sessions of this type,
the HLS media playlist contains all the fragments for the
session, up to the number that is specified in
MaxMediaPlaylistFragmentResults. The playlist
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.
The duration of the fragments in the HLS media playlists is typically reported as short by one frame (for example, 33 milliseconds for a 30 FPS fragment). This might cause the media player to report a shorter total duration until the media player decodes the fragments.
In both playback modes, if there are multiple fragments with the same start time stamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the HLS media playlist. The other fragments are not included. Fragments that have different time stamps but have overlapping durations are still included in the HLS media playlist. This can lead to unexpected behavior in the media player.
The default is LIVE.
PlaybackModepublic GetHLSStreamingSessionURLRequest withPlaybackMode(PlaybackMode playbackMode)
Whether to retrieve live or archived, on-demand data.
Features of the two types of session include the following:
LIVE : For sessions of this type, the HLS media
playlist is continually updated with the latest fragments as they become
available. We recommend that the media player retrieve a new playlist 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 HLS media playlist, 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 HLS media playlist 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 playlist, the older fragment is not
added, and the gap is not filled.
ON_DEMAND : For sessions of this type, the HLS media
playlist contains all the fragments for the session, up to the number
that is specified in MaxMediaPlaylistFragmentResults. The
playlist 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.
The duration of the fragments in the HLS media playlists is typically reported as short by one frame (for example, 33 milliseconds for a 30 FPS fragment). This might cause the media player to report a shorter total duration until the media player decodes the fragments.
In both playback modes, if there are multiple fragments with the same start time stamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the HLS media playlist. The other fragments are not included. Fragments that have different time stamps but have overlapping durations are still included in the HLS media playlist. This can lead to unexpected behavior in the media player.
The default is LIVE.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: LIVE, ON_DEMAND
playbackMode - Whether to retrieve live or archived, on-demand data.
Features of the two types of session include the following:
LIVE : For sessions of this type, the HLS
media playlist is continually updated with the latest
fragments as they become available. We recommend that the
media player retrieve a new playlist 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 HLS media playlist, 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 HLS
media playlist 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 playlist, the older
fragment is not added, and the gap is not filled.
ON_DEMAND : For sessions of this type,
the HLS media playlist contains all the fragments for the
session, up to the number that is specified in
MaxMediaPlaylistFragmentResults. The playlist
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.
The duration of the fragments in the HLS media playlists is typically reported as short by one frame (for example, 33 milliseconds for a 30 FPS fragment). This might cause the media player to report a shorter total duration until the media player decodes the fragments.
In both playback modes, if there are multiple fragments with the same start time stamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the HLS media playlist. The other fragments are not included. Fragments that have different time stamps but have overlapping durations are still included in the HLS media playlist. This can lead to unexpected behavior in the media player.
The default is LIVE.
PlaybackModepublic HLSFragmentSelector getHLSFragmentSelector()
The time range of the requested fragment, and the source of the time stamp.
This parameter is required if PlaybackMode is
ON_DEMAND. This parameter is optional if
PlaybackMode is LIVE. If
PlaybackMode is LIVE, the
FragmentSelectorType can be set, but the
TimestampRange should not be set.
The time range of the requested fragment, and the source of the time stamp.
This parameter is required if PlaybackMode is
ON_DEMAND. This parameter is optional if
PlaybackMode is LIVE. If
PlaybackMode is LIVE, the
FragmentSelectorType can be set, but the
TimestampRange should not be set.
public void setHLSFragmentSelector(HLSFragmentSelector hLSFragmentSelector)
The time range of the requested fragment, and the source of the time stamp.
This parameter is required if PlaybackMode is
ON_DEMAND. This parameter is optional if
PlaybackMode is LIVE. If
PlaybackMode is LIVE, the
FragmentSelectorType can be set, but the
TimestampRange should not be set.
hLSFragmentSelector - The time range of the requested fragment, and the source of the time stamp.
This parameter is required if PlaybackMode is
ON_DEMAND. This parameter is optional if
PlaybackMode is LIVE. If
PlaybackMode is LIVE, the
FragmentSelectorType can be set, but the
TimestampRange should not be set.
public GetHLSStreamingSessionURLRequest withHLSFragmentSelector(HLSFragmentSelector hLSFragmentSelector)
The time range of the requested fragment, and the source of the time stamp.
This parameter is required if PlaybackMode is
ON_DEMAND. This parameter is optional if
PlaybackMode is LIVE. If
PlaybackMode is LIVE, the
FragmentSelectorType can be set, but the
TimestampRange should not be set.
Returns a reference to this object so that method calls can be chained together.
hLSFragmentSelector - The time range of the requested fragment, and the source of the time stamp.
This parameter is required if PlaybackMode is
ON_DEMAND. This parameter is optional if
PlaybackMode is LIVE. If
PlaybackMode is LIVE, the
FragmentSelectorType can be set, but the
TimestampRange should not be set.
public java.lang.String getDiscontinuityMode()
Constraints:
Allowed Values: ALWAYS, NEVER
DiscontinuityModepublic void setDiscontinuityMode(java.lang.String discontinuityMode)
Constraints:
Allowed Values: ALWAYS, NEVER
discontinuityMode - The new value for the discontinuityMode property
for this object.DiscontinuityModepublic GetHLSStreamingSessionURLRequest withDiscontinuityMode(java.lang.String discontinuityMode)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ALWAYS, NEVER
discontinuityMode - The new value for the discontinuityMode property
for this object.DiscontinuityModepublic void setDiscontinuityMode(DiscontinuityMode discontinuityMode)
Constraints:
Allowed Values: ALWAYS, NEVER
discontinuityMode - The new value for the discontinuityMode property
for this object.DiscontinuityModepublic GetHLSStreamingSessionURLRequest withDiscontinuityMode(DiscontinuityMode discontinuityMode)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ALWAYS, NEVER
discontinuityMode - The new value for the discontinuityMode property
for this object.DiscontinuityModepublic java.lang.Integer getExpires()
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 GetHLSMasterPlaylist, GetHLSMediaPlaylist, GetMP4InitFragment, or
GetMP4MediaFragment can be made for that session.
The default is 3600 (one hour).
Constraints:
Range: 300 - 43200
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
GetHLSMasterPlaylist,
GetHLSMediaPlaylist, GetMP4InitFragment
, or GetMP4MediaFragment can be made for that
session.
The default is 3600 (one hour).
public void setExpires(java.lang.Integer 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 GetHLSMasterPlaylist, GetHLSMediaPlaylist, GetMP4InitFragment, or
GetMP4MediaFragment can be made for that session.
The default is 3600 (one hour).
Constraints:
Range: 300 - 43200
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
GetHLSMasterPlaylist,
GetHLSMediaPlaylist,
GetMP4InitFragment, or
GetMP4MediaFragment can be made for that session.
The default is 3600 (one hour).
public GetHLSStreamingSessionURLRequest withExpires(java.lang.Integer 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 GetHLSMasterPlaylist, GetHLSMediaPlaylist, GetMP4InitFragment, or
GetMP4MediaFragment can be made for that session.
The default is 3600 (one hour).
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 300 - 43200
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
GetHLSMasterPlaylist,
GetHLSMediaPlaylist,
GetMP4InitFragment, or
GetMP4MediaFragment can be made for that session.
The default is 3600 (one hour).
public java.lang.Long getMaxMediaPlaylistFragmentResults()
The maximum number of fragments that Kinesis Video Streams will return.
When the PlaybackMode is LIVE, the most recent
fragments are returned up to this value. When the
PlaybackMode is ON_DEMAND, the oldest fragments
are returned, up to this maximum number.
When there are more fragments available in a live HLS media playlist, 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 HLS media playlist have a minimum of 3 fragments and a maximum of 10 fragments.
The default is 5 fragments if PlaybackMode is
LIVE, and 1000 if PlaybackMode is
ON_DEMAND.
The maximum value of 1000 fragments corresponds to more than 16 minutes of video on streams with one-second fragments, and more than 2 1/2 hours of video on streams with ten-second fragments.
Constraints:
Range: 1 - 1000
The maximum number of fragments that Kinesis Video Streams will return.
When the PlaybackMode is LIVE, the most
recent fragments are returned up to this value. When the
PlaybackMode is ON_DEMAND, the oldest
fragments are returned, up to this maximum number.
When there are more fragments available in a live HLS media playlist, 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 HLS media playlist have a minimum of 3 fragments and a maximum of 10 fragments.
The default is 5 fragments if PlaybackMode is
LIVE, and 1000 if PlaybackMode is
ON_DEMAND.
The maximum value of 1000 fragments corresponds to more than 16 minutes of video on streams with one-second fragments, and more than 2 1/2 hours of video on streams with ten-second fragments.
public void setMaxMediaPlaylistFragmentResults(java.lang.Long maxMediaPlaylistFragmentResults)
The maximum number of fragments that Kinesis Video Streams will return.
When the PlaybackMode is LIVE, the most recent
fragments are returned up to this value. When the
PlaybackMode is ON_DEMAND, the oldest fragments
are returned, up to this maximum number.
When there are more fragments available in a live HLS media playlist, 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 HLS media playlist have a minimum of 3 fragments and a maximum of 10 fragments.
The default is 5 fragments if PlaybackMode is
LIVE, and 1000 if PlaybackMode is
ON_DEMAND.
The maximum value of 1000 fragments corresponds to more than 16 minutes of video on streams with one-second fragments, and more than 2 1/2 hours of video on streams with ten-second fragments.
Constraints:
Range: 1 - 1000
maxMediaPlaylistFragmentResults - The maximum number of fragments that Kinesis Video Streams will return.
When the PlaybackMode is LIVE, the
most recent fragments are returned up to this value. When the
PlaybackMode is ON_DEMAND, the
oldest fragments are returned, up to this maximum number.
When there are more fragments available in a live HLS media playlist, 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 HLS media playlist have a minimum of 3 fragments and a maximum of 10 fragments.
The default is 5 fragments if PlaybackMode is
LIVE, and 1000 if PlaybackMode is
ON_DEMAND.
The maximum value of 1000 fragments corresponds to more than 16 minutes of video on streams with one-second fragments, and more than 2 1/2 hours of video on streams with ten-second fragments.
public GetHLSStreamingSessionURLRequest withMaxMediaPlaylistFragmentResults(java.lang.Long maxMediaPlaylistFragmentResults)
The maximum number of fragments that Kinesis Video Streams will return.
When the PlaybackMode is LIVE, the most recent
fragments are returned up to this value. When the
PlaybackMode is ON_DEMAND, the oldest fragments
are returned, up to this maximum number.
When there are more fragments available in a live HLS media playlist, 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 HLS media playlist have a minimum of 3 fragments and a maximum of 10 fragments.
The default is 5 fragments if PlaybackMode is
LIVE, and 1000 if PlaybackMode is
ON_DEMAND.
The maximum value of 1000 fragments corresponds to more than 16 minutes of video on streams with one-second fragments, and more than 2 1/2 hours of video on streams with ten-second fragments.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 1000
maxMediaPlaylistFragmentResults - The maximum number of fragments that Kinesis Video Streams will return.
When the PlaybackMode is LIVE, the
most recent fragments are returned up to this value. When the
PlaybackMode is ON_DEMAND, the
oldest fragments are returned, up to this maximum number.
When there are more fragments available in a live HLS media playlist, 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 HLS media playlist have a minimum of 3 fragments and a maximum of 10 fragments.
The default is 5 fragments if PlaybackMode is
LIVE, and 1000 if PlaybackMode is
ON_DEMAND.
The maximum value of 1000 fragments corresponds to more than 16 minutes of video on streams with one-second fragments, and more than 2 1/2 hours of video on streams with ten-second fragments.
public java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.ObjectCopyright © 2018 Amazon Web Services, Inc. All Rights Reserved.