Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL
in a browser or media player to view the stream contents.
You must specify either the
StreamName or the
An Amazon Kinesis video stream has the following requirements for providing data through
The media type must be
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,
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
The following procedure shows how to use HLS with Kinesis Video Streams:
Get an endpoint using GetDataEndpoint,
GET_HLS_STREAMING_SESSION_URL for the
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
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 initialization fragment with the
action, and URLs to access the MP4 media fragments with the
actions. The HLS media playlist also contains metadata about the stream that the player
needs to play it, such as whether the
ON_DEMAND. The HLS media playlist is typically static for sessions
ON_DEMAND. The HLS media playlist
is continually updated with new fragments for sessions with a
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
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.
Data retrieved with this action is billable. See Pricing
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
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
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.