amazonka-ivs-2.0: Amazon Interactive Video Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IVS.Types.Stream

Description

 
Synopsis

Documentation

data Stream Source #

Specifies a live video stream that has been ingested and distributed.

See: newStream smart constructor.

Constructors

Stream' 

Fields

  • channelArn :: Maybe Text

    Channel ARN for the stream.

  • health :: Maybe StreamHealth

    The stream’s health.

  • playbackUrl :: Maybe Text

    URL of the master playlist, required by the video player to play the HLS stream.

  • startTime :: Maybe ISO8601

    Time of the stream’s start. This is an ISO 8601 timestamp; /note that this is returned as a string/.

  • state :: Maybe StreamState

    The stream’s state.

  • streamId :: Maybe Text

    Unique identifier for a live or previously live stream in the specified channel.

  • viewerCount :: Maybe Integer

    A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.

Instances

Instances details
FromJSON Stream Source # 
Instance details

Defined in Amazonka.IVS.Types.Stream

Methods

parseJSON :: Value -> Parser Stream #

parseJSONList :: Value -> Parser [Stream] #

Generic Stream Source # 
Instance details

Defined in Amazonka.IVS.Types.Stream

Associated Types

type Rep Stream :: Type -> Type #

Methods

from :: Stream -> Rep Stream x #

to :: Rep Stream x -> Stream #

Read Stream Source # 
Instance details

Defined in Amazonka.IVS.Types.Stream

Methods

readsPrec :: Int -> ReadS Stream #

readList :: ReadS [Stream] #

readPrec :: ReadPrec Stream #

readListPrec :: ReadPrec [Stream] #

Show Stream Source # 
Instance details

Defined in Amazonka.IVS.Types.Stream

Methods

showsPrec :: Int -> Stream -> ShowS #

show :: Stream -> String #

showList :: [Stream] -> ShowS #

NFData Stream Source # 
Instance details

Defined in Amazonka.IVS.Types.Stream

Methods

rnf :: Stream -> () #

Eq Stream Source # 
Instance details

Defined in Amazonka.IVS.Types.Stream

Methods

(==) :: Stream -> Stream -> Bool #

(/=) :: Stream -> Stream -> Bool #

Hashable Stream Source # 
Instance details

Defined in Amazonka.IVS.Types.Stream

Methods

hashWithSalt :: Int -> Stream -> Int #

hash :: Stream -> Int #

type Rep Stream Source # 
Instance details

Defined in Amazonka.IVS.Types.Stream

type Rep Stream = D1 ('MetaData "Stream" "Amazonka.IVS.Types.Stream" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "Stream'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "health") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamHealth)) :*: S1 ('MetaSel ('Just "playbackUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamState))) :*: (S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "viewerCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))))

newStream :: Stream Source #

Create a value of Stream with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:channelArn:Stream', stream_channelArn - Channel ARN for the stream.

$sel:health:Stream', stream_health - The stream’s health.

$sel:playbackUrl:Stream', stream_playbackUrl - URL of the master playlist, required by the video player to play the HLS stream.

$sel:startTime:Stream', stream_startTime - Time of the stream’s start. This is an ISO 8601 timestamp; /note that this is returned as a string/.

$sel:state:Stream', stream_state - The stream’s state.

$sel:streamId:Stream', stream_streamId - Unique identifier for a live or previously live stream in the specified channel.

$sel:viewerCount:Stream', stream_viewerCount - A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.

stream_channelArn :: Lens' Stream (Maybe Text) Source #

Channel ARN for the stream.

stream_health :: Lens' Stream (Maybe StreamHealth) Source #

The stream’s health.

stream_playbackUrl :: Lens' Stream (Maybe Text) Source #

URL of the master playlist, required by the video player to play the HLS stream.

stream_startTime :: Lens' Stream (Maybe UTCTime) Source #

Time of the stream’s start. This is an ISO 8601 timestamp; /note that this is returned as a string/.

stream_state :: Lens' Stream (Maybe StreamState) Source #

The stream’s state.

stream_streamId :: Lens' Stream (Maybe Text) Source #

Unique identifier for a live or previously live stream in the specified channel.

stream_viewerCount :: Lens' Stream (Maybe Integer) Source #

A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.