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

#include <GetDASHStreamingSessionURLRequest.h>

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

Public Member Functions

 GetDASHStreamingSessionURLRequest ()
 
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)
 
GetDASHStreamingSessionURLRequestWithStreamName (const Aws::String &value)
 
GetDASHStreamingSessionURLRequestWithStreamName (Aws::String &&value)
 
GetDASHStreamingSessionURLRequestWithStreamName (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)
 
GetDASHStreamingSessionURLRequestWithStreamARN (const Aws::String &value)
 
GetDASHStreamingSessionURLRequestWithStreamARN (Aws::String &&value)
 
GetDASHStreamingSessionURLRequestWithStreamARN (const char *value)
 
const DASHPlaybackModeGetPlaybackMode () const
 
bool PlaybackModeHasBeenSet () const
 
void SetPlaybackMode (const DASHPlaybackMode &value)
 
void SetPlaybackMode (DASHPlaybackMode &&value)
 
GetDASHStreamingSessionURLRequestWithPlaybackMode (const DASHPlaybackMode &value)
 
GetDASHStreamingSessionURLRequestWithPlaybackMode (DASHPlaybackMode &&value)
 
const DASHDisplayFragmentTimestampGetDisplayFragmentTimestamp () const
 
bool DisplayFragmentTimestampHasBeenSet () const
 
void SetDisplayFragmentTimestamp (const DASHDisplayFragmentTimestamp &value)
 
void SetDisplayFragmentTimestamp (DASHDisplayFragmentTimestamp &&value)
 
GetDASHStreamingSessionURLRequestWithDisplayFragmentTimestamp (const DASHDisplayFragmentTimestamp &value)
 
GetDASHStreamingSessionURLRequestWithDisplayFragmentTimestamp (DASHDisplayFragmentTimestamp &&value)
 
const DASHDisplayFragmentNumberGetDisplayFragmentNumber () const
 
bool DisplayFragmentNumberHasBeenSet () const
 
void SetDisplayFragmentNumber (const DASHDisplayFragmentNumber &value)
 
void SetDisplayFragmentNumber (DASHDisplayFragmentNumber &&value)
 
GetDASHStreamingSessionURLRequestWithDisplayFragmentNumber (const DASHDisplayFragmentNumber &value)
 
GetDASHStreamingSessionURLRequestWithDisplayFragmentNumber (DASHDisplayFragmentNumber &&value)
 
const DASHFragmentSelectorGetDASHFragmentSelector () const
 
bool DASHFragmentSelectorHasBeenSet () const
 
void SetDASHFragmentSelector (const DASHFragmentSelector &value)
 
void SetDASHFragmentSelector (DASHFragmentSelector &&value)
 
GetDASHStreamingSessionURLRequestWithDASHFragmentSelector (const DASHFragmentSelector &value)
 
GetDASHStreamingSessionURLRequestWithDASHFragmentSelector (DASHFragmentSelector &&value)
 
int GetExpires () const
 
bool ExpiresHasBeenSet () const
 
void SetExpires (int value)
 
GetDASHStreamingSessionURLRequestWithExpires (int value)
 
long long GetMaxManifestFragmentResults () const
 
bool MaxManifestFragmentResultsHasBeenSet () const
 
void SetMaxManifestFragmentResults (long long value)
 
GetDASHStreamingSessionURLRequestWithMaxManifestFragmentResults (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 25 of file GetDASHStreamingSessionURLRequest.h.

Constructor & Destructor Documentation

◆ GetDASHStreamingSessionURLRequest()

Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::GetDASHStreamingSessionURLRequest ( )

Member Function Documentation

◆ DASHFragmentSelectorHasBeenSet()

bool Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::DASHFragmentSelectorHasBeenSet ( ) 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 618 of file GetDASHStreamingSessionURLRequest.h.

◆ DisplayFragmentNumberHasBeenSet()

bool Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::DisplayFragmentNumberHasBeenSet ( ) const
inline

Fragments are identified in the manifest file based on their sequence number in the session. If DisplayFragmentNumber is set to ALWAYS, the Kinesis Video Streams fragment number is added to each S element in the manifest file with the attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with other APIs (e.g. GetMedia and GetMediaForFragmentList). A custom MPEG-DASH media player is necessary to leverage these this custom attribute.

The default value is NEVER.

Definition at line 543 of file GetDASHStreamingSessionURLRequest.h.

◆ DisplayFragmentTimestampHasBeenSet()

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

Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file can be derived using attributes in the manifest itself. However, typically, MPEG-DASH compatible media players do not properly handle gaps in the media timeline. Kinesis Video Streams adjusts the media timeline in the manifest file to enable playback of media with discontinuities. Therefore, the wall-clock time derived from the manifest file may be inaccurate. If DisplayFragmentTimestamp is set to ALWAYS, the accurate fragment timestamp is added to each S element in the manifest file with the attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this custom attribute.

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

Definition at line 446 of file GetDASHStreamingSessionURLRequest.h.

◆ ExpiresHasBeenSet()

bool Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::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 GetDashManifest, GetMP4InitFragment, or GetMP4MediaFragment can be made for that session.

The default is 300 (5 minutes).

Definition at line 689 of file GetDASHStreamingSessionURLRequest.h.

◆ GetDASHFragmentSelector()

const DASHFragmentSelector& Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::GetDASHFragmentSelector ( ) 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 605 of file GetDASHStreamingSessionURLRequest.h.

◆ GetDisplayFragmentNumber()

const DASHDisplayFragmentNumber& Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::GetDisplayFragmentNumber ( ) const
inline

Fragments are identified in the manifest file based on their sequence number in the session. If DisplayFragmentNumber is set to ALWAYS, the Kinesis Video Streams fragment number is added to each S element in the manifest file with the attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with other APIs (e.g. GetMedia and GetMediaForFragmentList). A custom MPEG-DASH media player is necessary to leverage these this custom attribute.

The default value is NEVER.

Definition at line 531 of file GetDASHStreamingSessionURLRequest.h.

◆ GetDisplayFragmentTimestamp()

const DASHDisplayFragmentTimestamp& Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::GetDisplayFragmentTimestamp ( ) const
inline

Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file can be derived using attributes in the manifest itself. However, typically, MPEG-DASH compatible media players do not properly handle gaps in the media timeline. Kinesis Video Streams adjusts the media timeline in the manifest file to enable playback of media with discontinuities. Therefore, the wall-clock time derived from the manifest file may be inaccurate. If DisplayFragmentTimestamp is set to ALWAYS, the accurate fragment timestamp is added to each S element in the manifest file with the attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this custom attribute.

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

Definition at line 428 of file GetDASHStreamingSessionURLRequest.h.

◆ GetExpires()

int Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::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 GetDashManifest, GetMP4InitFragment, or GetMP4MediaFragment can be made for that session.

The default is 300 (5 minutes).

Definition at line 680 of file GetDASHStreamingSessionURLRequest.h.

◆ GetMaxManifestFragmentResults()

long long Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::GetMaxManifestFragmentResults ( ) const
inline

The maximum number of fragments that are returned in the MPEG-DASH manifest.

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 MPEG-DASH manifest, video players often buffer content before starting playback. Increasing the buffer size increases the playback latency, but it decreases the likelihood that rebuffering will occur during playback. We recommend that a live MPEG-DASH manifest have a minimum of 3 fragments and a maximum of 10 fragments.

The default is 5 fragments if PlaybackMode 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 727 of file GetDASHStreamingSessionURLRequest.h.

◆ GetPlaybackMode()

const DASHPlaybackMode& Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::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 MPEG-DASH manifest is continually updated with the latest fragments as they become available. We recommend that the media player retrieve a new manifest on a one-second interval. When this type of session is played in a media player, the user interface typically displays a "live" notification, with no scrubber control for choosing the position in the playback window to display.

    In LIVE mode, the newest available fragments are included in an MPEG-DASH manifest, even if there is a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt or cause a jump in playback. In this mode, fragments are not added to the MPEG-DASH manifest if they are older than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment is added to the manifest, the older fragment is not added, and the gap is not filled.

  • LIVE_REPLAY : For sessions of this type, the MPEG-DASH manifest is updated similarly to how it is updated 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 manifest every two seconds. This mode is useful to be able to start playback from when an event is detected and continue live streaming media that has not yet been ingested as of the time of the session creation. This mode is also useful to stream previously archived media without being limited by the 1,000 fragment limit in the ON_DEMAND mode.

  • ON_DEMAND : For sessions of this type, the MPEG-DASH manifest contains all the fragments for the session, up to the number that is specified in MaxManifestFragmentResults. The manifest must be retrieved only once for each session. When this type of session is played in a media player, the user interface typically displays a scrubber control for choosing the position in the playback window to display.

In all playback modes, if FragmentSelectorType 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 MPEG-DASH manifest. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media player.

The default is LIVE.

Definition at line 194 of file GetDASHStreamingSessionURLRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file GetDASHStreamingSessionURLRequest.h.

◆ GetStreamARN()

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

The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

Definition at line 101 of file GetDASHStreamingSessionURLRequest.h.

◆ GetStreamName()

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

The name of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

Definition at line 44 of file GetDASHStreamingSessionURLRequest.h.

◆ MaxManifestFragmentResultsHasBeenSet()

bool Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::MaxManifestFragmentResultsHasBeenSet ( ) const
inline

The maximum number of fragments that are returned in the MPEG-DASH manifest.

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 MPEG-DASH manifest, video players often buffer content before starting playback. Increasing the buffer size increases the playback latency, but it decreases the likelihood that rebuffering will occur during playback. We recommend that a live MPEG-DASH manifest have a minimum of 3 fragments and a maximum of 10 fragments.

The default is 5 fragments if PlaybackMode 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 746 of file GetDASHStreamingSessionURLRequest.h.

◆ PlaybackModeHasBeenSet()

bool Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::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 MPEG-DASH manifest is continually updated with the latest fragments as they become available. We recommend that the media player retrieve a new manifest on a one-second interval. When this type of session is played in a media player, the user interface typically displays a "live" notification, with no scrubber control for choosing the position in the playback window to display.

    In LIVE mode, the newest available fragments are included in an MPEG-DASH manifest, even if there is a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt or cause a jump in playback. In this mode, fragments are not added to the MPEG-DASH manifest if they are older than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment is added to the manifest, the older fragment is not added, and the gap is not filled.

  • LIVE_REPLAY : For sessions of this type, the MPEG-DASH manifest is updated similarly to how it is updated 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 manifest every two seconds. This mode is useful to be able to start playback from when an event is detected and continue live streaming media that has not yet been ingested as of the time of the session creation. This mode is also useful to stream previously archived media without being limited by the 1,000 fragment limit in the ON_DEMAND mode.

  • ON_DEMAND : For sessions of this type, the MPEG-DASH manifest contains all the fragments for the session, up to the number that is specified in MaxManifestFragmentResults. The manifest must be retrieved only once for each session. When this type of session is played in a media player, the user interface typically displays a scrubber control for choosing the position in the playback window to display.

In all playback modes, if FragmentSelectorType 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 MPEG-DASH manifest. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media player.

The default is LIVE.

Definition at line 237 of file GetDASHStreamingSessionURLRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDASHFragmentSelector() [1/2]

void Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::SetDASHFragmentSelector ( const DASHFragmentSelector 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 631 of file GetDASHStreamingSessionURLRequest.h.

◆ SetDASHFragmentSelector() [2/2]

void Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::SetDASHFragmentSelector ( DASHFragmentSelector &&  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 644 of file GetDASHStreamingSessionURLRequest.h.

◆ SetDisplayFragmentNumber() [1/2]

void Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::SetDisplayFragmentNumber ( const DASHDisplayFragmentNumber value)
inline

Fragments are identified in the manifest file based on their sequence number in the session. If DisplayFragmentNumber is set to ALWAYS, the Kinesis Video Streams fragment number is added to each S element in the manifest file with the attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with other APIs (e.g. GetMedia and GetMediaForFragmentList). A custom MPEG-DASH media player is necessary to leverage these this custom attribute.

The default value is NEVER.

Definition at line 555 of file GetDASHStreamingSessionURLRequest.h.

◆ SetDisplayFragmentNumber() [2/2]

void Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::SetDisplayFragmentNumber ( DASHDisplayFragmentNumber &&  value)
inline

Fragments are identified in the manifest file based on their sequence number in the session. If DisplayFragmentNumber is set to ALWAYS, the Kinesis Video Streams fragment number is added to each S element in the manifest file with the attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with other APIs (e.g. GetMedia and GetMediaForFragmentList). A custom MPEG-DASH media player is necessary to leverage these this custom attribute.

The default value is NEVER.

Definition at line 567 of file GetDASHStreamingSessionURLRequest.h.

◆ SetDisplayFragmentTimestamp() [1/2]

void Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::SetDisplayFragmentTimestamp ( const DASHDisplayFragmentTimestamp value)
inline

Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file can be derived using attributes in the manifest itself. However, typically, MPEG-DASH compatible media players do not properly handle gaps in the media timeline. Kinesis Video Streams adjusts the media timeline in the manifest file to enable playback of media with discontinuities. Therefore, the wall-clock time derived from the manifest file may be inaccurate. If DisplayFragmentTimestamp is set to ALWAYS, the accurate fragment timestamp is added to each S element in the manifest file with the attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this custom attribute.

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

Definition at line 464 of file GetDASHStreamingSessionURLRequest.h.

◆ SetDisplayFragmentTimestamp() [2/2]

void Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::SetDisplayFragmentTimestamp ( DASHDisplayFragmentTimestamp &&  value)
inline

Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file can be derived using attributes in the manifest itself. However, typically, MPEG-DASH compatible media players do not properly handle gaps in the media timeline. Kinesis Video Streams adjusts the media timeline in the manifest file to enable playback of media with discontinuities. Therefore, the wall-clock time derived from the manifest file may be inaccurate. If DisplayFragmentTimestamp is set to ALWAYS, the accurate fragment timestamp is added to each S element in the manifest file with the attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this custom attribute.

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

Definition at line 482 of file GetDASHStreamingSessionURLRequest.h.

◆ SetExpires()

void Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::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 GetDashManifest, GetMP4InitFragment, or GetMP4MediaFragment can be made for that session.

The default is 300 (5 minutes).

Definition at line 698 of file GetDASHStreamingSessionURLRequest.h.

◆ SetMaxManifestFragmentResults()

void Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::SetMaxManifestFragmentResults ( long long  value)
inline

The maximum number of fragments that are returned in the MPEG-DASH manifest.

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 MPEG-DASH manifest, video players often buffer content before starting playback. Increasing the buffer size increases the playback latency, but it decreases the likelihood that rebuffering will occur during playback. We recommend that a live MPEG-DASH manifest have a minimum of 3 fragments and a maximum of 10 fragments.

The default is 5 fragments if PlaybackMode 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 765 of file GetDASHStreamingSessionURLRequest.h.

◆ SetPlaybackMode() [1/2]

void Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::SetPlaybackMode ( const DASHPlaybackMode 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 MPEG-DASH manifest is continually updated with the latest fragments as they become available. We recommend that the media player retrieve a new manifest on a one-second interval. When this type of session is played in a media player, the user interface typically displays a "live" notification, with no scrubber control for choosing the position in the playback window to display.

    In LIVE mode, the newest available fragments are included in an MPEG-DASH manifest, even if there is a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt or cause a jump in playback. In this mode, fragments are not added to the MPEG-DASH manifest if they are older than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment is added to the manifest, the older fragment is not added, and the gap is not filled.

  • LIVE_REPLAY : For sessions of this type, the MPEG-DASH manifest is updated similarly to how it is updated 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 manifest every two seconds. This mode is useful to be able to start playback from when an event is detected and continue live streaming media that has not yet been ingested as of the time of the session creation. This mode is also useful to stream previously archived media without being limited by the 1,000 fragment limit in the ON_DEMAND mode.

  • ON_DEMAND : For sessions of this type, the MPEG-DASH manifest contains all the fragments for the session, up to the number that is specified in MaxManifestFragmentResults. The manifest must be retrieved only once for each session. When this type of session is played in a media player, the user interface typically displays a scrubber control for choosing the position in the playback window to display.

In all playback modes, if FragmentSelectorType 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 MPEG-DASH manifest. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media player.

The default is LIVE.

Definition at line 280 of file GetDASHStreamingSessionURLRequest.h.

◆ SetPlaybackMode() [2/2]

void Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::SetPlaybackMode ( DASHPlaybackMode &&  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 MPEG-DASH manifest is continually updated with the latest fragments as they become available. We recommend that the media player retrieve a new manifest on a one-second interval. When this type of session is played in a media player, the user interface typically displays a "live" notification, with no scrubber control for choosing the position in the playback window to display.

    In LIVE mode, the newest available fragments are included in an MPEG-DASH manifest, even if there is a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt or cause a jump in playback. In this mode, fragments are not added to the MPEG-DASH manifest if they are older than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment is added to the manifest, the older fragment is not added, and the gap is not filled.

  • LIVE_REPLAY : For sessions of this type, the MPEG-DASH manifest is updated similarly to how it is updated 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 manifest every two seconds. This mode is useful to be able to start playback from when an event is detected and continue live streaming media that has not yet been ingested as of the time of the session creation. This mode is also useful to stream previously archived media without being limited by the 1,000 fragment limit in the ON_DEMAND mode.

  • ON_DEMAND : For sessions of this type, the MPEG-DASH manifest contains all the fragments for the session, up to the number that is specified in MaxManifestFragmentResults. The manifest must be retrieved only once for each session. When this type of session is played in a media player, the user interface typically displays a scrubber control for choosing the position in the playback window to display.

In all playback modes, if FragmentSelectorType 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 MPEG-DASH manifest. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media player.

The default is LIVE.

Definition at line 323 of file GetDASHStreamingSessionURLRequest.h.

◆ SetStreamARN() [1/3]

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

The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

Definition at line 122 of file GetDASHStreamingSessionURLRequest.h.

◆ SetStreamARN() [2/3]

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

The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

Definition at line 115 of file GetDASHStreamingSessionURLRequest.h.

◆ SetStreamARN() [3/3]

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

The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

Definition at line 129 of file GetDASHStreamingSessionURLRequest.h.

◆ SetStreamName() [1/3]

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

The name of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

Definition at line 65 of file GetDASHStreamingSessionURLRequest.h.

◆ SetStreamName() [2/3]

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

The name of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

Definition at line 58 of file GetDASHStreamingSessionURLRequest.h.

◆ SetStreamName() [3/3]

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

The name of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

Definition at line 72 of file GetDASHStreamingSessionURLRequest.h.

◆ StreamARNHasBeenSet()

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

The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

Definition at line 108 of file GetDASHStreamingSessionURLRequest.h.

◆ StreamNameHasBeenSet()

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

The name of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

Definition at line 51 of file GetDASHStreamingSessionURLRequest.h.

◆ WithDASHFragmentSelector() [1/2]

GetDASHStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::WithDASHFragmentSelector ( const DASHFragmentSelector 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 657 of file GetDASHStreamingSessionURLRequest.h.

◆ WithDASHFragmentSelector() [2/2]

GetDASHStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::WithDASHFragmentSelector ( DASHFragmentSelector &&  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 670 of file GetDASHStreamingSessionURLRequest.h.

◆ WithDisplayFragmentNumber() [1/2]

GetDASHStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::WithDisplayFragmentNumber ( const DASHDisplayFragmentNumber value)
inline

Fragments are identified in the manifest file based on their sequence number in the session. If DisplayFragmentNumber is set to ALWAYS, the Kinesis Video Streams fragment number is added to each S element in the manifest file with the attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with other APIs (e.g. GetMedia and GetMediaForFragmentList). A custom MPEG-DASH media player is necessary to leverage these this custom attribute.

The default value is NEVER.

Definition at line 579 of file GetDASHStreamingSessionURLRequest.h.

◆ WithDisplayFragmentNumber() [2/2]

GetDASHStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::WithDisplayFragmentNumber ( DASHDisplayFragmentNumber &&  value)
inline

Fragments are identified in the manifest file based on their sequence number in the session. If DisplayFragmentNumber is set to ALWAYS, the Kinesis Video Streams fragment number is added to each S element in the manifest file with the attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with other APIs (e.g. GetMedia and GetMediaForFragmentList). A custom MPEG-DASH media player is necessary to leverage these this custom attribute.

The default value is NEVER.

Definition at line 591 of file GetDASHStreamingSessionURLRequest.h.

◆ WithDisplayFragmentTimestamp() [1/2]

GetDASHStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::WithDisplayFragmentTimestamp ( const DASHDisplayFragmentTimestamp value)
inline

Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file can be derived using attributes in the manifest itself. However, typically, MPEG-DASH compatible media players do not properly handle gaps in the media timeline. Kinesis Video Streams adjusts the media timeline in the manifest file to enable playback of media with discontinuities. Therefore, the wall-clock time derived from the manifest file may be inaccurate. If DisplayFragmentTimestamp is set to ALWAYS, the accurate fragment timestamp is added to each S element in the manifest file with the attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this custom attribute.

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

Definition at line 500 of file GetDASHStreamingSessionURLRequest.h.

◆ WithDisplayFragmentTimestamp() [2/2]

GetDASHStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::WithDisplayFragmentTimestamp ( DASHDisplayFragmentTimestamp &&  value)
inline

Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file can be derived using attributes in the manifest itself. However, typically, MPEG-DASH compatible media players do not properly handle gaps in the media timeline. Kinesis Video Streams adjusts the media timeline in the manifest file to enable playback of media with discontinuities. Therefore, the wall-clock time derived from the manifest file may be inaccurate. If DisplayFragmentTimestamp is set to ALWAYS, the accurate fragment timestamp is added to each S element in the manifest file with the attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this custom attribute.

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

Definition at line 518 of file GetDASHStreamingSessionURLRequest.h.

◆ WithExpires()

GetDASHStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::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 GetDashManifest, GetMP4InitFragment, or GetMP4MediaFragment can be made for that session.

The default is 300 (5 minutes).

Definition at line 707 of file GetDASHStreamingSessionURLRequest.h.

◆ WithMaxManifestFragmentResults()

GetDASHStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::WithMaxManifestFragmentResults ( long long  value)
inline

The maximum number of fragments that are returned in the MPEG-DASH manifest.

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 MPEG-DASH manifest, video players often buffer content before starting playback. Increasing the buffer size increases the playback latency, but it decreases the likelihood that rebuffering will occur during playback. We recommend that a live MPEG-DASH manifest have a minimum of 3 fragments and a maximum of 10 fragments.

The default is 5 fragments if PlaybackMode 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 784 of file GetDASHStreamingSessionURLRequest.h.

◆ WithPlaybackMode() [1/2]

GetDASHStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::WithPlaybackMode ( const DASHPlaybackMode 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 MPEG-DASH manifest is continually updated with the latest fragments as they become available. We recommend that the media player retrieve a new manifest on a one-second interval. When this type of session is played in a media player, the user interface typically displays a "live" notification, with no scrubber control for choosing the position in the playback window to display.

    In LIVE mode, the newest available fragments are included in an MPEG-DASH manifest, even if there is a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt or cause a jump in playback. In this mode, fragments are not added to the MPEG-DASH manifest if they are older than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment is added to the manifest, the older fragment is not added, and the gap is not filled.

  • LIVE_REPLAY : For sessions of this type, the MPEG-DASH manifest is updated similarly to how it is updated 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 manifest every two seconds. This mode is useful to be able to start playback from when an event is detected and continue live streaming media that has not yet been ingested as of the time of the session creation. This mode is also useful to stream previously archived media without being limited by the 1,000 fragment limit in the ON_DEMAND mode.

  • ON_DEMAND : For sessions of this type, the MPEG-DASH manifest contains all the fragments for the session, up to the number that is specified in MaxManifestFragmentResults. The manifest must be retrieved only once for each session. When this type of session is played in a media player, the user interface typically displays a scrubber control for choosing the position in the playback window to display.

In all playback modes, if FragmentSelectorType 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 MPEG-DASH manifest. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media player.

The default is LIVE.

Definition at line 366 of file GetDASHStreamingSessionURLRequest.h.

◆ WithPlaybackMode() [2/2]

GetDASHStreamingSessionURLRequest& Aws::KinesisVideoArchivedMedia::Model::GetDASHStreamingSessionURLRequest::WithPlaybackMode ( DASHPlaybackMode &&  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 MPEG-DASH manifest is continually updated with the latest fragments as they become available. We recommend that the media player retrieve a new manifest on a one-second interval. When this type of session is played in a media player, the user interface typically displays a "live" notification, with no scrubber control for choosing the position in the playback window to display.

    In LIVE mode, the newest available fragments are included in an MPEG-DASH manifest, even if there is a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt or cause a jump in playback. In this mode, fragments are not added to the MPEG-DASH manifest if they are older than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment is added to the manifest, the older fragment is not added, and the gap is not filled.

  • LIVE_REPLAY : For sessions of this type, the MPEG-DASH manifest is updated similarly to how it is updated 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 manifest every two seconds. This mode is useful to be able to start playback from when an event is detected and continue live streaming media that has not yet been ingested as of the time of the session creation. This mode is also useful to stream previously archived media without being limited by the 1,000 fragment limit in the ON_DEMAND mode.

  • ON_DEMAND : For sessions of this type, the MPEG-DASH manifest contains all the fragments for the session, up to the number that is specified in MaxManifestFragmentResults. The manifest must be retrieved only once for each session. When this type of session is played in a media player, the user interface typically displays a scrubber control for choosing the position in the playback window to display.

In all playback modes, if FragmentSelectorType 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 MPEG-DASH manifest. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media player.

The default is LIVE.

Definition at line 409 of file GetDASHStreamingSessionURLRequest.h.

◆ WithStreamARN() [1/3]

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

The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

Definition at line 143 of file GetDASHStreamingSessionURLRequest.h.

◆ WithStreamARN() [2/3]

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

The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

Definition at line 136 of file GetDASHStreamingSessionURLRequest.h.

◆ WithStreamARN() [3/3]

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

The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

Definition at line 150 of file GetDASHStreamingSessionURLRequest.h.

◆ WithStreamName() [1/3]

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

The name of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

Definition at line 86 of file GetDASHStreamingSessionURLRequest.h.

◆ WithStreamName() [2/3]

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

The name of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

Definition at line 79 of file GetDASHStreamingSessionURLRequest.h.

◆ WithStreamName() [3/3]

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

The name of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

Definition at line 93 of file GetDASHStreamingSessionURLRequest.h.


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