amazonka-kinesis-video-archived-media-1.6.0: Amazon Kinesis Video Streams Archived Media SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.KinesisVideoArchivedMedia.GetMediaForFragmentList

Contents

Description

Gets media for a list of fragments (specified by fragment number) from the archived data in a Kinesis video stream.

The following limits apply when using the GetMediaForFragmentList API:

  • A client can call GetMediaForFragmentList up to five times per second per stream.
  • Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMediaForFragmentList session.

Synopsis

Creating a Request

getMediaForFragmentList Source #

Creates a value of GetMediaForFragmentList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • gmfflStreamName - The name of the stream from which to retrieve fragment media.
  • gmfflFragments - A list of the numbers of fragments for which to retrieve media. You retrieve these values with ListFragments .

data GetMediaForFragmentList Source #

See: getMediaForFragmentList smart constructor.

Instances

Eq GetMediaForFragmentList Source # 
Data GetMediaForFragmentList Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetMediaForFragmentList -> c GetMediaForFragmentList #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetMediaForFragmentList #

toConstr :: GetMediaForFragmentList -> Constr #

dataTypeOf :: GetMediaForFragmentList -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetMediaForFragmentList) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetMediaForFragmentList) #

gmapT :: (forall b. Data b => b -> b) -> GetMediaForFragmentList -> GetMediaForFragmentList #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetMediaForFragmentList -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetMediaForFragmentList -> r #

gmapQ :: (forall d. Data d => d -> u) -> GetMediaForFragmentList -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetMediaForFragmentList -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetMediaForFragmentList -> m GetMediaForFragmentList #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetMediaForFragmentList -> m GetMediaForFragmentList #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetMediaForFragmentList -> m GetMediaForFragmentList #

Read GetMediaForFragmentList Source # 
Show GetMediaForFragmentList Source # 
Generic GetMediaForFragmentList Source # 
Hashable GetMediaForFragmentList Source # 
ToJSON GetMediaForFragmentList Source # 
NFData GetMediaForFragmentList Source # 

Methods

rnf :: GetMediaForFragmentList -> () #

AWSRequest GetMediaForFragmentList Source # 
ToHeaders GetMediaForFragmentList Source # 
ToPath GetMediaForFragmentList Source # 
ToQuery GetMediaForFragmentList Source # 
type Rep GetMediaForFragmentList Source # 
type Rep GetMediaForFragmentList = D1 * (MetaData "GetMediaForFragmentList" "Network.AWS.KinesisVideoArchivedMedia.GetMediaForFragmentList" "amazonka-kinesis-video-archived-media-1.6.0-BK4sg7YWMNVCwg3NegaW0Y" False) (C1 * (MetaCons "GetMediaForFragmentList'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_gmfflStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_gmfflFragments") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [Text]))))
type Rs GetMediaForFragmentList Source # 

Request Lenses

gmfflStreamName :: Lens' GetMediaForFragmentList Text Source #

The name of the stream from which to retrieve fragment media.

gmfflFragments :: Lens' GetMediaForFragmentList [Text] Source #

A list of the numbers of fragments for which to retrieve media. You retrieve these values with ListFragments .

Destructuring the Response

getMediaForFragmentListResponse Source #

Creates a value of GetMediaForFragmentListResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • gmfflrsContentType - The content type of the requested media.
  • gmfflrsResponseStatus - -- | The response status code.
  • gmfflrsPayload - The payload that Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see PutMedia . The chunks that Kinesis Video Streams returns in the GetMediaForFragmentList call also include the following additional Matroska (MKV) tags: * AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk. * AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side time stamp of the fragment. * AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side time stamp of the fragment. The following tags will be included if an exception occurs: * AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the exception * AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the exception * AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception

Response Lenses

gmfflrsContentType :: Lens' GetMediaForFragmentListResponse (Maybe Text) Source #

The content type of the requested media.

gmfflrsPayload :: Lens' GetMediaForFragmentListResponse RsBody Source #

The payload that Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see PutMedia . The chunks that Kinesis Video Streams returns in the GetMediaForFragmentList call also include the following additional Matroska (MKV) tags: * AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk. * AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side time stamp of the fragment. * AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side time stamp of the fragment. The following tags will be included if an exception occurs: * AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the exception * AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the exception * AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception