AWS SDK for C++  1.8.51
AWS SDK for C++
Public Member Functions | List of all members
Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest Class Reference

#include <GetHLSStreamingSessionURLRequest.h>

+ Inheritance diagram for Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest:

Public Member Functions

 GetHLSStreamingSessionURLRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetStreamName () const
 
bool StreamNameHasBeenSet () const
 
void SetStreamName (const Aws::String &value)
 
void SetStreamName (Aws::String &&value)
 
void SetStreamName (const char *value)
 
GetHLSStreamingSessionURLRequestWithStreamName (const Aws::String &value)
 
GetHLSStreamingSessionURLRequestWithStreamName (Aws::String &&value)
 
GetHLSStreamingSessionURLRequestWithStreamName (const char *value)
 
const Aws::StringGetStreamARN () const
 
bool StreamARNHasBeenSet () const
 
void SetStreamARN (const Aws::String &value)
 
void SetStreamARN (Aws::String &&value)
 
void SetStreamARN (const char *value)
 
GetHLSStreamingSessionURLRequestWithStreamARN (const Aws::String &value)
 
GetHLSStreamingSessionURLRequestWithStreamARN (Aws::String &&value)
 
GetHLSStreamingSessionURLRequestWithStreamARN (const char *value)
 
const HLSPlaybackModeGetPlaybackMode () const
 
bool PlaybackModeHasBeenSet () const
 
void SetPlaybackMode (const HLSPlaybackMode &value)
 
void SetPlaybackMode (HLSPlaybackMode &&value)
 
GetHLSStreamingSessionURLRequestWithPlaybackMode (const HLSPlaybackMode &value)
 
GetHLSStreamingSessionURLRequestWithPlaybackMode (HLSPlaybackMode &&value)
 
const HLSFragmentSelectorGetHLSFragmentSelector () const
 
bool HLSFragmentSelectorHasBeenSet () const
 
void SetHLSFragmentSelector (const HLSFragmentSelector &value)
 
void SetHLSFragmentSelector (HLSFragmentSelector &&value)
 
GetHLSStreamingSessionURLRequestWithHLSFragmentSelector (const HLSFragmentSelector &value)
 
GetHLSStreamingSessionURLRequestWithHLSFragmentSelector (HLSFragmentSelector &&value)
 
const ContainerFormatGetContainerFormat () const
 
bool ContainerFormatHasBeenSet () const
 
void SetContainerFormat (const ContainerFormat &value)
 
void SetContainerFormat (ContainerFormat &&value)
 
GetHLSStreamingSessionURLRequestWithContainerFormat (const ContainerFormat &value)
 
GetHLSStreamingSessionURLRequestWithContainerFormat (ContainerFormat &&value)
 
const HLSDiscontinuityModeGetDiscontinuityMode () const
 
bool DiscontinuityModeHasBeenSet () const
 
void SetDiscontinuityMode (const HLSDiscontinuityMode &value)
 
void SetDiscontinuityMode (HLSDiscontinuityMode &&value)
 
GetHLSStreamingSessionURLRequestWithDiscontinuityMode (const HLSDiscontinuityMode &value)
 
GetHLSStreamingSessionURLRequestWithDiscontinuityMode (HLSDiscontinuityMode &&value)
 
const HLSDisplayFragmentTimestampGetDisplayFragmentTimestamp () const
 
bool DisplayFragmentTimestampHasBeenSet () const
 
void SetDisplayFragmentTimestamp (const HLSDisplayFragmentTimestamp &value)
 
void SetDisplayFragmentTimestamp (HLSDisplayFragmentTimestamp &&value)
 
GetHLSStreamingSessionURLRequestWithDisplayFragmentTimestamp (const HLSDisplayFragmentTimestamp &value)
 
GetHLSStreamingSessionURLRequestWithDisplayFragmentTimestamp (HLSDisplayFragmentTimestamp &&value)
 
int GetExpires () const
 
bool ExpiresHasBeenSet () const
 
void SetExpires (int value)
 
GetHLSStreamingSessionURLRequestWithExpires (int value)
 
long long GetMaxMediaPlaylistFragmentResults () const
 
bool MaxMediaPlaylistFragmentResultsHasBeenSet () const
 
void SetMaxMediaPlaylistFragmentResults (long long value)
 
GetHLSStreamingSessionURLRequestWithMaxMediaPlaylistFragmentResults (long long value)
 
- Public Member Functions inherited from Aws::KinesisVideoArchivedMedia::KinesisVideoArchivedMediaRequest
virtual ~KinesisVideoArchivedMediaRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::KinesisVideoArchivedMedia::KinesisVideoArchivedMediaRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 26 of file GetHLSStreamingSessionURLRequest.h.

Constructor & Destructor Documentation

◆ GetHLSStreamingSessionURLRequest()

Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::GetHLSStreamingSessionURLRequest ( )

Member Function Documentation

◆ ContainerFormatHasBeenSet()

bool Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::ContainerFormatHasBeenSet ( ) const
inline

Specifies which format should be used for packaging the media. Specifying the FRAGMENTED_MP4 container format packages the media into MP4 fragments (fMP4 or CMAF). This is the recommended packaging because there is minimal packaging overhead. The other container format option is MPEG_TS. HLS has supported MPEG TS chunks since it was released and is sometimes the only supported packaging on older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This means MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4.

The default is FRAGMENTED_MP4.

Definition at line 522 of file GetHLSStreamingSessionURLRequest.h.

◆ DiscontinuityModeHasBeenSet()

bool Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::DiscontinuityModeHasBeenSet ( ) const
inline

Specifies when flags marking discontinuities between fragments are added to the media playlists.

Media players typically build a timeline of media content to play, based on the timestamps of each fragment. This means that if there is any overlap or gap between fragments (as is typical if HLSFragmentSelector is set to SERVER_TIMESTAMP), the media player timeline will also have small gaps between fragments in some places, and will overwrite frames in other places. Gaps in the media player timeline can cause playback to stall and overlaps can cause playback to be jittery. When there are discontinuity flags between fragments, the media player is expected to reset the timeline, resulting in the next fragment being played immediately after the previous fragment.

The following modes are supported:

  • ALWAYS: a discontinuity marker is placed between every fragment in the HLS media playlist. It is recommended to use a value of ALWAYS if the fragment timestamps are not accurate.

  • NEVER: no discontinuity markers are placed anywhere. It is recommended to use a value of NEVER to ensure the media player timeline most accurately maps to the producer timestamps.

  • ON_DISCONTIUNITY: a discontinuity marker is placed between fragments that have a gap or overlap of more than 50 milliseconds. For most playback scenarios, it is recommended to use a value of ON_DISCONTINUITY so that the media player timeline is only reset when there is a significant issue with the media timeline (e.g. a missing fragment).

The default is ALWAYS when HLSFragmentSelector is set to SERVER_TIMESTAMP, and NEVER when it is set to PRODUCER_TIMESTAMP.

Definition at line 633 of file GetHLSStreamingSessionURLRequest.h.

◆ DisplayFragmentTimestampHasBeenSet()

bool Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::DisplayFragmentTimestampHasBeenSet ( ) const
inline

Specifies when the fragment start timestamps should be included in the HLS media playlist. Typically, media players report the playhead position as a time relative to the start of the first fragment in the playback session. However, when the start timestamps are included in the HLS media playlist, some media players might report the current playhead as an absolute time based on the fragment timestamps. This can be useful for creating a playback experience that shows viewers the wall-clock time of the media.

The default is NEVER. When HLSFragmentSelector is SERVER_TIMESTAMP, the timestamps will be the server start timestamps. Similarly, when HLSFragmentSelector is PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.

Definition at line 782 of file GetHLSStreamingSessionURLRequest.h.

◆ ExpiresHasBeenSet()

bool Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::ExpiresHasBeenSet ( ) const
inline

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, GetMP4MediaFragment, or GetTSFragment can be made for that session.

The default is 300 (5 minutes).

Definition at line 867 of file GetHLSStreamingSessionURLRequest.h.

◆ GetContainerFormat()

const ContainerFormat& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::GetContainerFormat ( ) const
inline

Specifies which format should be used for packaging the media. Specifying the FRAGMENTED_MP4 container format packages the media into MP4 fragments (fMP4 or CMAF). This is the recommended packaging because there is minimal packaging overhead. The other container format option is MPEG_TS. HLS has supported MPEG TS chunks since it was released and is sometimes the only supported packaging on older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This means MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4.

The default is FRAGMENTED_MP4.

Definition at line 509 of file GetHLSStreamingSessionURLRequest.h.

◆ GetDiscontinuityMode()

const HLSDiscontinuityMode& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::GetDiscontinuityMode ( ) const
inline

Specifies when flags marking discontinuities between fragments are added to the media playlists.

Media players typically build a timeline of media content to play, based on the timestamps of each fragment. This means that if there is any overlap or gap between fragments (as is typical if HLSFragmentSelector is set to SERVER_TIMESTAMP), the media player timeline will also have small gaps between fragments in some places, and will overwrite frames in other places. Gaps in the media player timeline can cause playback to stall and overlaps can cause playback to be jittery. When there are discontinuity flags between fragments, the media player is expected to reset the timeline, resulting in the next fragment being played immediately after the previous fragment.

The following modes are supported:

  • ALWAYS: a discontinuity marker is placed between every fragment in the HLS media playlist. It is recommended to use a value of ALWAYS if the fragment timestamps are not accurate.

  • NEVER: no discontinuity markers are placed anywhere. It is recommended to use a value of NEVER to ensure the media player timeline most accurately maps to the producer timestamps.

  • ON_DISCONTIUNITY: a discontinuity marker is placed between fragments that have a gap or overlap of more than 50 milliseconds. For most playback scenarios, it is recommended to use a value of ON_DISCONTINUITY so that the media player timeline is only reset when there is a significant issue with the media timeline (e.g. a missing fragment).

The default is ALWAYS when HLSFragmentSelector is set to SERVER_TIMESTAMP, and NEVER when it is set to PRODUCER_TIMESTAMP.

Definition at line 604 of file GetHLSStreamingSessionURLRequest.h.

◆ GetDisplayFragmentTimestamp()

const HLSDisplayFragmentTimestamp& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::GetDisplayFragmentTimestamp ( ) const
inline

Specifies when the fragment start timestamps should be included in the HLS media playlist. Typically, media players report the playhead position as a time relative to the start of the first fragment in the playback session. However, when the start timestamps are included in the HLS media playlist, some media players might report the current playhead as an absolute time based on the fragment timestamps. This can be useful for creating a playback experience that shows viewers the wall-clock time of the media.

The default is NEVER. When HLSFragmentSelector is SERVER_TIMESTAMP, the timestamps will be the server start timestamps. Similarly, when HLSFragmentSelector is PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.

Definition at line 766 of file GetHLSStreamingSessionURLRequest.h.

◆ GetExpires()

int Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::GetExpires ( ) const
inline

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, GetMP4MediaFragment, or GetTSFragment can be made for that session.

The default is 300 (5 minutes).

Definition at line 857 of file GetHLSStreamingSessionURLRequest.h.

◆ GetHLSFragmentSelector()

const HLSFragmentSelector& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::GetHLSFragmentSelector ( ) const
inline

The time range of the requested fragment and the source of the timestamps.

This parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This parameter is optional if PlaybackMode is LIVE. If PlaybackMode is LIVE, the FragmentSelectorType can be set, but the TimestampRange should not be set. If PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and TimestampRange must be set.

Definition at line 430 of file GetHLSStreamingSessionURLRequest.h.

◆ GetMaxMediaPlaylistFragmentResults()

long long Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::GetMaxMediaPlaylistFragmentResults ( ) const
inline

The maximum number of fragments that are returned in the HLS media playlists.

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 a higher number of 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 or LIVE_REPLAY, and 1,000 if PlaybackMode is ON_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.

Definition at line 907 of file GetHLSStreamingSessionURLRequest.h.

◆ GetPlaybackMode()

const HLSPlaybackMode& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::GetPlaybackMode ( ) const
inline

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

  • LIVE_REPLAY : For sessions of this type, the HLS media playlist is updated similarly to how it is updated for LIVE 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 media playlist 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 the ON_DEMAND mode.

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

In all playback modes, if FragmentSelectorType is PRODUCER_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 HLS media playlist. The other fragments are not included. Fragments that have different timestamps 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.

Definition at line 196 of file GetHLSStreamingSessionURLRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file GetHLSStreamingSessionURLRequest.h.

◆ GetStreamARN()

const Aws::String& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::GetStreamARN ( ) const
inline

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.

Definition at line 102 of file GetHLSStreamingSessionURLRequest.h.

◆ GetStreamName()

const Aws::String& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::GetStreamName ( ) const
inline

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

You must specify either the StreamName or the StreamARN.

Definition at line 45 of file GetHLSStreamingSessionURLRequest.h.

◆ HLSFragmentSelectorHasBeenSet()

bool Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::HLSFragmentSelectorHasBeenSet ( ) const
inline

The time range of the requested fragment and the source of the timestamps.

This parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This parameter is optional if PlaybackMode is LIVE. If PlaybackMode is LIVE, the FragmentSelectorType can be set, but the TimestampRange should not be set. If PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and TimestampRange must be set.

Definition at line 443 of file GetHLSStreamingSessionURLRequest.h.

◆ MaxMediaPlaylistFragmentResultsHasBeenSet()

bool Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::MaxMediaPlaylistFragmentResultsHasBeenSet ( ) const
inline

The maximum number of fragments that are returned in the HLS media playlists.

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 a higher number of 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 or LIVE_REPLAY, and 1,000 if PlaybackMode is ON_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.

Definition at line 926 of file GetHLSStreamingSessionURLRequest.h.

◆ PlaybackModeHasBeenSet()

bool Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::PlaybackModeHasBeenSet ( ) const
inline

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

  • LIVE_REPLAY : For sessions of this type, the HLS media playlist is updated similarly to how it is updated for LIVE 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 media playlist 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 the ON_DEMAND mode.

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

In all playback modes, if FragmentSelectorType is PRODUCER_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 HLS media playlist. The other fragments are not included. Fragments that have different timestamps 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.

Definition at line 240 of file GetHLSStreamingSessionURLRequest.h.

◆ SerializePayload()

Aws::String Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetContainerFormat() [1/2]

void Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SetContainerFormat ( const ContainerFormat value)
inline

Specifies which format should be used for packaging the media. Specifying the FRAGMENTED_MP4 container format packages the media into MP4 fragments (fMP4 or CMAF). This is the recommended packaging because there is minimal packaging overhead. The other container format option is MPEG_TS. HLS has supported MPEG TS chunks since it was released and is sometimes the only supported packaging on older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This means MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4.

The default is FRAGMENTED_MP4.

Definition at line 535 of file GetHLSStreamingSessionURLRequest.h.

◆ SetContainerFormat() [2/2]

void Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SetContainerFormat ( ContainerFormat &&  value)
inline

Specifies which format should be used for packaging the media. Specifying the FRAGMENTED_MP4 container format packages the media into MP4 fragments (fMP4 or CMAF). This is the recommended packaging because there is minimal packaging overhead. The other container format option is MPEG_TS. HLS has supported MPEG TS chunks since it was released and is sometimes the only supported packaging on older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This means MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4.

The default is FRAGMENTED_MP4.

Definition at line 548 of file GetHLSStreamingSessionURLRequest.h.

◆ SetDiscontinuityMode() [1/2]

void Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SetDiscontinuityMode ( const HLSDiscontinuityMode value)
inline

Specifies when flags marking discontinuities between fragments are added to the media playlists.

Media players typically build a timeline of media content to play, based on the timestamps of each fragment. This means that if there is any overlap or gap between fragments (as is typical if HLSFragmentSelector is set to SERVER_TIMESTAMP), the media player timeline will also have small gaps between fragments in some places, and will overwrite frames in other places. Gaps in the media player timeline can cause playback to stall and overlaps can cause playback to be jittery. When there are discontinuity flags between fragments, the media player is expected to reset the timeline, resulting in the next fragment being played immediately after the previous fragment.

The following modes are supported:

  • ALWAYS: a discontinuity marker is placed between every fragment in the HLS media playlist. It is recommended to use a value of ALWAYS if the fragment timestamps are not accurate.

  • NEVER: no discontinuity markers are placed anywhere. It is recommended to use a value of NEVER to ensure the media player timeline most accurately maps to the producer timestamps.

  • ON_DISCONTIUNITY: a discontinuity marker is placed between fragments that have a gap or overlap of more than 50 milliseconds. For most playback scenarios, it is recommended to use a value of ON_DISCONTINUITY so that the media player timeline is only reset when there is a significant issue with the media timeline (e.g. a missing fragment).

The default is ALWAYS when HLSFragmentSelector is set to SERVER_TIMESTAMP, and NEVER when it is set to PRODUCER_TIMESTAMP.

Definition at line 662 of file GetHLSStreamingSessionURLRequest.h.

◆ SetDiscontinuityMode() [2/2]

void Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SetDiscontinuityMode ( HLSDiscontinuityMode &&  value)
inline

Specifies when flags marking discontinuities between fragments are added to the media playlists.

Media players typically build a timeline of media content to play, based on the timestamps of each fragment. This means that if there is any overlap or gap between fragments (as is typical if HLSFragmentSelector is set to SERVER_TIMESTAMP), the media player timeline will also have small gaps between fragments in some places, and will overwrite frames in other places. Gaps in the media player timeline can cause playback to stall and overlaps can cause playback to be jittery. When there are discontinuity flags between fragments, the media player is expected to reset the timeline, resulting in the next fragment being played immediately after the previous fragment.

The following modes are supported:

  • ALWAYS: a discontinuity marker is placed between every fragment in the HLS media playlist. It is recommended to use a value of ALWAYS if the fragment timestamps are not accurate.

  • NEVER: no discontinuity markers are placed anywhere. It is recommended to use a value of NEVER to ensure the media player timeline most accurately maps to the producer timestamps.

  • ON_DISCONTIUNITY: a discontinuity marker is placed between fragments that have a gap or overlap of more than 50 milliseconds. For most playback scenarios, it is recommended to use a value of ON_DISCONTINUITY so that the media player timeline is only reset when there is a significant issue with the media timeline (e.g. a missing fragment).

The default is ALWAYS when HLSFragmentSelector is set to SERVER_TIMESTAMP, and NEVER when it is set to PRODUCER_TIMESTAMP.

Definition at line 691 of file GetHLSStreamingSessionURLRequest.h.

◆ SetDisplayFragmentTimestamp() [1/2]

void Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SetDisplayFragmentTimestamp ( const HLSDisplayFragmentTimestamp value)
inline

Specifies when the fragment start timestamps should be included in the HLS media playlist. Typically, media players report the playhead position as a time relative to the start of the first fragment in the playback session. However, when the start timestamps are included in the HLS media playlist, some media players might report the current playhead as an absolute time based on the fragment timestamps. This can be useful for creating a playback experience that shows viewers the wall-clock time of the media.

The default is NEVER. When HLSFragmentSelector is SERVER_TIMESTAMP, the timestamps will be the server start timestamps. Similarly, when HLSFragmentSelector is PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.

Definition at line 798 of file GetHLSStreamingSessionURLRequest.h.

◆ SetDisplayFragmentTimestamp() [2/2]

void Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SetDisplayFragmentTimestamp ( HLSDisplayFragmentTimestamp &&  value)
inline

Specifies when the fragment start timestamps should be included in the HLS media playlist. Typically, media players report the playhead position as a time relative to the start of the first fragment in the playback session. However, when the start timestamps are included in the HLS media playlist, some media players might report the current playhead as an absolute time based on the fragment timestamps. This can be useful for creating a playback experience that shows viewers the wall-clock time of the media.

The default is NEVER. When HLSFragmentSelector is SERVER_TIMESTAMP, the timestamps will be the server start timestamps. Similarly, when HLSFragmentSelector is PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.

Definition at line 814 of file GetHLSStreamingSessionURLRequest.h.

◆ SetExpires()

void Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SetExpires ( int  value)
inline

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, GetMP4MediaFragment, or GetTSFragment can be made for that session.

The default is 300 (5 minutes).

Definition at line 877 of file GetHLSStreamingSessionURLRequest.h.

◆ SetHLSFragmentSelector() [1/2]

void Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SetHLSFragmentSelector ( const HLSFragmentSelector value)
inline

The time range of the requested fragment and the source of the timestamps.

This parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This parameter is optional if PlaybackMode is LIVE. If PlaybackMode is LIVE, the FragmentSelectorType can be set, but the TimestampRange should not be set. If PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and TimestampRange must be set.

Definition at line 456 of file GetHLSStreamingSessionURLRequest.h.

◆ SetHLSFragmentSelector() [2/2]

void Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SetHLSFragmentSelector ( HLSFragmentSelector &&  value)
inline

The time range of the requested fragment and the source of the timestamps.

This parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This parameter is optional if PlaybackMode is LIVE. If PlaybackMode is LIVE, the FragmentSelectorType can be set, but the TimestampRange should not be set. If PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and TimestampRange must be set.

Definition at line 469 of file GetHLSStreamingSessionURLRequest.h.

◆ SetMaxMediaPlaylistFragmentResults()

void Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SetMaxMediaPlaylistFragmentResults ( long long  value)
inline

The maximum number of fragments that are returned in the HLS media playlists.

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 a higher number of 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 or LIVE_REPLAY, and 1,000 if PlaybackMode is ON_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.

Definition at line 945 of file GetHLSStreamingSessionURLRequest.h.

◆ SetPlaybackMode() [1/2]

void Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SetPlaybackMode ( const HLSPlaybackMode value)
inline

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

  • LIVE_REPLAY : For sessions of this type, the HLS media playlist is updated similarly to how it is updated for LIVE 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 media playlist 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 the ON_DEMAND mode.

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

In all playback modes, if FragmentSelectorType is PRODUCER_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 HLS media playlist. The other fragments are not included. Fragments that have different timestamps 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.

Definition at line 284 of file GetHLSStreamingSessionURLRequest.h.

◆ SetPlaybackMode() [2/2]

void Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SetPlaybackMode ( HLSPlaybackMode &&  value)
inline

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

  • LIVE_REPLAY : For sessions of this type, the HLS media playlist is updated similarly to how it is updated for LIVE 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 media playlist 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 the ON_DEMAND mode.

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

In all playback modes, if FragmentSelectorType is PRODUCER_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 HLS media playlist. The other fragments are not included. Fragments that have different timestamps 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.

Definition at line 328 of file GetHLSStreamingSessionURLRequest.h.

◆ SetStreamARN() [1/3]

void Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SetStreamARN ( const Aws::String value)
inline

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.

Definition at line 116 of file GetHLSStreamingSessionURLRequest.h.

◆ SetStreamARN() [2/3]

void Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SetStreamARN ( Aws::String &&  value)
inline

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.

Definition at line 123 of file GetHLSStreamingSessionURLRequest.h.

◆ SetStreamARN() [3/3]

void Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SetStreamARN ( const char *  value)
inline

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.

Definition at line 130 of file GetHLSStreamingSessionURLRequest.h.

◆ SetStreamName() [1/3]

void Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SetStreamName ( const Aws::String value)
inline

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

You must specify either the StreamName or the StreamARN.

Definition at line 59 of file GetHLSStreamingSessionURLRequest.h.

◆ SetStreamName() [2/3]

void Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SetStreamName ( Aws::String &&  value)
inline

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

You must specify either the StreamName or the StreamARN.

Definition at line 66 of file GetHLSStreamingSessionURLRequest.h.

◆ SetStreamName() [3/3]

void Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::SetStreamName ( const char *  value)
inline

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

You must specify either the StreamName or the StreamARN.

Definition at line 73 of file GetHLSStreamingSessionURLRequest.h.

◆ StreamARNHasBeenSet()

bool Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::StreamARNHasBeenSet ( ) const
inline

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.

Definition at line 109 of file GetHLSStreamingSessionURLRequest.h.

◆ StreamNameHasBeenSet()

bool Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::StreamNameHasBeenSet ( ) const
inline

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

You must specify either the StreamName or the StreamARN.

Definition at line 52 of file GetHLSStreamingSessionURLRequest.h.

◆ WithContainerFormat() [1/2]

GetHLSStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::WithContainerFormat ( const ContainerFormat value)
inline

Specifies which format should be used for packaging the media. Specifying the FRAGMENTED_MP4 container format packages the media into MP4 fragments (fMP4 or CMAF). This is the recommended packaging because there is minimal packaging overhead. The other container format option is MPEG_TS. HLS has supported MPEG TS chunks since it was released and is sometimes the only supported packaging on older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This means MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4.

The default is FRAGMENTED_MP4.

Definition at line 561 of file GetHLSStreamingSessionURLRequest.h.

◆ WithContainerFormat() [2/2]

GetHLSStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::WithContainerFormat ( ContainerFormat &&  value)
inline

Specifies which format should be used for packaging the media. Specifying the FRAGMENTED_MP4 container format packages the media into MP4 fragments (fMP4 or CMAF). This is the recommended packaging because there is minimal packaging overhead. The other container format option is MPEG_TS. HLS has supported MPEG TS chunks since it was released and is sometimes the only supported packaging on older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This means MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4.

The default is FRAGMENTED_MP4.

Definition at line 574 of file GetHLSStreamingSessionURLRequest.h.

◆ WithDiscontinuityMode() [1/2]

GetHLSStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::WithDiscontinuityMode ( const HLSDiscontinuityMode value)
inline

Specifies when flags marking discontinuities between fragments are added to the media playlists.

Media players typically build a timeline of media content to play, based on the timestamps of each fragment. This means that if there is any overlap or gap between fragments (as is typical if HLSFragmentSelector is set to SERVER_TIMESTAMP), the media player timeline will also have small gaps between fragments in some places, and will overwrite frames in other places. Gaps in the media player timeline can cause playback to stall and overlaps can cause playback to be jittery. When there are discontinuity flags between fragments, the media player is expected to reset the timeline, resulting in the next fragment being played immediately after the previous fragment.

The following modes are supported:

  • ALWAYS: a discontinuity marker is placed between every fragment in the HLS media playlist. It is recommended to use a value of ALWAYS if the fragment timestamps are not accurate.

  • NEVER: no discontinuity markers are placed anywhere. It is recommended to use a value of NEVER to ensure the media player timeline most accurately maps to the producer timestamps.

  • ON_DISCONTIUNITY: a discontinuity marker is placed between fragments that have a gap or overlap of more than 50 milliseconds. For most playback scenarios, it is recommended to use a value of ON_DISCONTINUITY so that the media player timeline is only reset when there is a significant issue with the media timeline (e.g. a missing fragment).

The default is ALWAYS when HLSFragmentSelector is set to SERVER_TIMESTAMP, and NEVER when it is set to PRODUCER_TIMESTAMP.

Definition at line 720 of file GetHLSStreamingSessionURLRequest.h.

◆ WithDiscontinuityMode() [2/2]

GetHLSStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::WithDiscontinuityMode ( HLSDiscontinuityMode &&  value)
inline

Specifies when flags marking discontinuities between fragments are added to the media playlists.

Media players typically build a timeline of media content to play, based on the timestamps of each fragment. This means that if there is any overlap or gap between fragments (as is typical if HLSFragmentSelector is set to SERVER_TIMESTAMP), the media player timeline will also have small gaps between fragments in some places, and will overwrite frames in other places. Gaps in the media player timeline can cause playback to stall and overlaps can cause playback to be jittery. When there are discontinuity flags between fragments, the media player is expected to reset the timeline, resulting in the next fragment being played immediately after the previous fragment.

The following modes are supported:

  • ALWAYS: a discontinuity marker is placed between every fragment in the HLS media playlist. It is recommended to use a value of ALWAYS if the fragment timestamps are not accurate.

  • NEVER: no discontinuity markers are placed anywhere. It is recommended to use a value of NEVER to ensure the media player timeline most accurately maps to the producer timestamps.

  • ON_DISCONTIUNITY: a discontinuity marker is placed between fragments that have a gap or overlap of more than 50 milliseconds. For most playback scenarios, it is recommended to use a value of ON_DISCONTINUITY so that the media player timeline is only reset when there is a significant issue with the media timeline (e.g. a missing fragment).

The default is ALWAYS when HLSFragmentSelector is set to SERVER_TIMESTAMP, and NEVER when it is set to PRODUCER_TIMESTAMP.

Definition at line 749 of file GetHLSStreamingSessionURLRequest.h.

◆ WithDisplayFragmentTimestamp() [1/2]

GetHLSStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::WithDisplayFragmentTimestamp ( const HLSDisplayFragmentTimestamp value)
inline

Specifies when the fragment start timestamps should be included in the HLS media playlist. Typically, media players report the playhead position as a time relative to the start of the first fragment in the playback session. However, when the start timestamps are included in the HLS media playlist, some media players might report the current playhead as an absolute time based on the fragment timestamps. This can be useful for creating a playback experience that shows viewers the wall-clock time of the media.

The default is NEVER. When HLSFragmentSelector is SERVER_TIMESTAMP, the timestamps will be the server start timestamps. Similarly, when HLSFragmentSelector is PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.

Definition at line 830 of file GetHLSStreamingSessionURLRequest.h.

◆ WithDisplayFragmentTimestamp() [2/2]

GetHLSStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::WithDisplayFragmentTimestamp ( HLSDisplayFragmentTimestamp &&  value)
inline

Specifies when the fragment start timestamps should be included in the HLS media playlist. Typically, media players report the playhead position as a time relative to the start of the first fragment in the playback session. However, when the start timestamps are included in the HLS media playlist, some media players might report the current playhead as an absolute time based on the fragment timestamps. This can be useful for creating a playback experience that shows viewers the wall-clock time of the media.

The default is NEVER. When HLSFragmentSelector is SERVER_TIMESTAMP, the timestamps will be the server start timestamps. Similarly, when HLSFragmentSelector is PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.

Definition at line 846 of file GetHLSStreamingSessionURLRequest.h.

◆ WithExpires()

GetHLSStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::WithExpires ( int  value)
inline

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, GetMP4MediaFragment, or GetTSFragment can be made for that session.

The default is 300 (5 minutes).

Definition at line 887 of file GetHLSStreamingSessionURLRequest.h.

◆ WithHLSFragmentSelector() [1/2]

GetHLSStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::WithHLSFragmentSelector ( const HLSFragmentSelector value)
inline

The time range of the requested fragment and the source of the timestamps.

This parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This parameter is optional if PlaybackMode is LIVE. If PlaybackMode is LIVE, the FragmentSelectorType can be set, but the TimestampRange should not be set. If PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and TimestampRange must be set.

Definition at line 482 of file GetHLSStreamingSessionURLRequest.h.

◆ WithHLSFragmentSelector() [2/2]

GetHLSStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::WithHLSFragmentSelector ( HLSFragmentSelector &&  value)
inline

The time range of the requested fragment and the source of the timestamps.

This parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This parameter is optional if PlaybackMode is LIVE. If PlaybackMode is LIVE, the FragmentSelectorType can be set, but the TimestampRange should not be set. If PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and TimestampRange must be set.

Definition at line 495 of file GetHLSStreamingSessionURLRequest.h.

◆ WithMaxMediaPlaylistFragmentResults()

GetHLSStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::WithMaxMediaPlaylistFragmentResults ( long long  value)
inline

The maximum number of fragments that are returned in the HLS media playlists.

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 a higher number of 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 or LIVE_REPLAY, and 1,000 if PlaybackMode is ON_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.

Definition at line 964 of file GetHLSStreamingSessionURLRequest.h.

◆ WithPlaybackMode() [1/2]

GetHLSStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::WithPlaybackMode ( const HLSPlaybackMode value)
inline

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

  • LIVE_REPLAY : For sessions of this type, the HLS media playlist is updated similarly to how it is updated for LIVE 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 media playlist 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 the ON_DEMAND mode.

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

In all playback modes, if FragmentSelectorType is PRODUCER_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 HLS media playlist. The other fragments are not included. Fragments that have different timestamps 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.

Definition at line 372 of file GetHLSStreamingSessionURLRequest.h.

◆ WithPlaybackMode() [2/2]

GetHLSStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::WithPlaybackMode ( HLSPlaybackMode &&  value)
inline

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

  • LIVE_REPLAY : For sessions of this type, the HLS media playlist is updated similarly to how it is updated for LIVE 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 media playlist 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 the ON_DEMAND mode.

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

In all playback modes, if FragmentSelectorType is PRODUCER_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 HLS media playlist. The other fragments are not included. Fragments that have different timestamps 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.

Definition at line 416 of file GetHLSStreamingSessionURLRequest.h.

◆ WithStreamARN() [1/3]

GetHLSStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::WithStreamARN ( const Aws::String value)
inline

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.

Definition at line 137 of file GetHLSStreamingSessionURLRequest.h.

◆ WithStreamARN() [2/3]

GetHLSStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::WithStreamARN ( Aws::String &&  value)
inline

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.

Definition at line 144 of file GetHLSStreamingSessionURLRequest.h.

◆ WithStreamARN() [3/3]

GetHLSStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::WithStreamARN ( const char *  value)
inline

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.

Definition at line 151 of file GetHLSStreamingSessionURLRequest.h.

◆ WithStreamName() [1/3]

GetHLSStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::WithStreamName ( const Aws::String value)
inline

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

You must specify either the StreamName or the StreamARN.

Definition at line 80 of file GetHLSStreamingSessionURLRequest.h.

◆ WithStreamName() [2/3]

GetHLSStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::WithStreamName ( Aws::String &&  value)
inline

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

You must specify either the StreamName or the StreamARN.

Definition at line 87 of file GetHLSStreamingSessionURLRequest.h.

◆ WithStreamName() [3/3]

GetHLSStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetHLSStreamingSessionURLRequest::WithStreamName ( const char *  value)
inline

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

You must specify either the StreamName or the StreamARN.

Definition at line 94 of file GetHLSStreamingSessionURLRequest.h.


The documentation for this class was generated from the following file: