AWSKinesisVideoArchivedMediaGetHLSStreamingSessionURLInput Class Reference

Inherits from AWSRequest : AWSModel : AWSMTLModel
Declared in AWSKinesisVideoArchivedMediaModel.h
AWSKinesisVideoArchivedMediaModel.m

  discontinuityMode

@property (nonatomic, assign) AWSKinesisVideoArchivedMediaDiscontinuityMode discontinuityMode

Declared In

AWSKinesisVideoArchivedMediaModel.h

  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).

@property (nonatomic, strong) NSNumber *expires

Declared In

AWSKinesisVideoArchivedMediaModel.h

  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.

@property (nonatomic, strong) AWSKinesisVideoArchivedMediaHLSFragmentSelector *HLSFragmentSelector

Declared In

AWSKinesisVideoArchivedMediaModel.h

  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.

@property (nonatomic, strong) NSNumber *maxMediaPlaylistFragmentResults

Declared In

AWSKinesisVideoArchivedMediaModel.h

  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.

@property (nonatomic, assign) AWSKinesisVideoArchivedMediaPlaybackMode playbackMode

Declared In

AWSKinesisVideoArchivedMediaModel.h

  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.

@property (nonatomic, strong) NSString *streamARN

Declared In

AWSKinesisVideoArchivedMediaModel.h

  streamName

The name of the stream for which to retrieve the HLS master playlist URL.

You must specify either the StreamName or the StreamARN.

@property (nonatomic, strong) NSString *streamName

Declared In

AWSKinesisVideoArchivedMediaModel.h