Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.MediaConnect.Types.MediaStream

Description

Documentation

data MediaStream Source #

A single track or stream of media that contains video, audio, or ancillary data. After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams.

See: newMediaStream smart constructor.

Constructors

MediaStream'

Fields

attributes :: Maybe MediaStreamAttributes
Attributes that are related to the media stream.
clockRate :: Maybe Int
The sample rate for the stream. This value is measured in Hz.
description :: Maybe Text
A description that can help you quickly identify what your media stream is used for.
videoFormat :: Maybe Text
The resolution of the video.
mediaStreamType :: MediaStreamType
The type of media stream.
mediaStreamId :: Int
A unique identifier for the media stream.
mediaStreamName :: Text
A name that helps you distinguish one media stream from another.
fmt :: Int
The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.

Instances

Instances details

FromJSON MediaStream Source #
Instance details Defined in Amazonka.MediaConnect.Types.MediaStream Methods parseJSON :: Value -> Parser MediaStream # parseJSONList :: Value -> Parser [MediaStream] #
Generic MediaStream Source #
Instance details Defined in Amazonka.MediaConnect.Types.MediaStream Associated Types type Rep MediaStream :: Type -> Type # Methods from :: MediaStream -> Rep MediaStream x # to :: Rep MediaStream x -> MediaStream #
Read MediaStream Source #
Instance details Defined in Amazonka.MediaConnect.Types.MediaStream Methods readsPrec :: Int -> ReadS MediaStream # readList :: ReadS [MediaStream] # readPrec :: ReadPrec MediaStream # readListPrec :: ReadPrec [MediaStream] #
Show MediaStream Source #
Instance details Defined in Amazonka.MediaConnect.Types.MediaStream Methods showsPrec :: Int -> MediaStream -> ShowS # show :: MediaStream -> String # showList :: [MediaStream] -> ShowS #
NFData MediaStream Source #
Instance details Defined in Amazonka.MediaConnect.Types.MediaStream Methods rnf :: MediaStream -> () #
Eq MediaStream Source #
Instance details Defined in Amazonka.MediaConnect.Types.MediaStream Methods (==) :: MediaStream -> MediaStream -> Bool # (/=) :: MediaStream -> MediaStream -> Bool #
Hashable MediaStream Source #
Instance details Defined in Amazonka.MediaConnect.Types.MediaStream Methods hashWithSalt :: Int -> MediaStream -> Int # hash :: MediaStream -> Int #
type Rep MediaStream Source #
Instance details Defined in Amazonka.MediaConnect.Types.MediaStream type Rep MediaStream = D1 ('MetaData "MediaStream" "Amazonka.MediaConnect.Types.MediaStream" "amazonka-mediaconnect-2.0-KNF7B97aPsN1PZ2vBYFgux" 'False) (C1 ('MetaCons "MediaStream'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MediaStreamAttributes)) :: S1 ('MetaSel ('Just "clockRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "videoFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "mediaStreamType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MediaStreamType) :: S1 ('MetaSel ('Just "mediaStreamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "mediaStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "fmt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newMediaStream Source #

Arguments

:: MediaStreamType	`$sel:mediaStreamType:MediaStream'`
-> Int	`$sel:mediaStreamId:MediaStream'`
-> Text	`$sel:mediaStreamName:MediaStream'`
-> Int	`$sel:fmt:MediaStream'`
-> MediaStream

Create a value of MediaStream 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:attributes:MediaStream', mediaStream_attributes - Attributes that are related to the media stream.

$sel:clockRate:MediaStream', mediaStream_clockRate - The sample rate for the stream. This value is measured in Hz.

$sel:description:MediaStream', mediaStream_description - A description that can help you quickly identify what your media stream is used for.

$sel:videoFormat:MediaStream', mediaStream_videoFormat - The resolution of the video.

$sel:mediaStreamType:MediaStream', mediaStream_mediaStreamType - The type of media stream.

$sel:mediaStreamId:MediaStream', mediaStream_mediaStreamId - A unique identifier for the media stream.

$sel:mediaStreamName:MediaStream', mediaStream_mediaStreamName - A name that helps you distinguish one media stream from another.

$sel:fmt:MediaStream', mediaStream_fmt - The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.

mediaStream_attributes :: Lens' MediaStream (Maybe MediaStreamAttributes) Source #

Attributes that are related to the media stream.

mediaStream_clockRate :: Lens' MediaStream (Maybe Int) Source #

The sample rate for the stream. This value is measured in Hz.

mediaStream_description :: Lens' MediaStream (Maybe Text) Source #

A description that can help you quickly identify what your media stream is used for.

mediaStream_videoFormat :: Lens' MediaStream (Maybe Text) Source #

The resolution of the video.

mediaStream_mediaStreamType :: Lens' MediaStream MediaStreamType Source #

The type of media stream.

mediaStream_mediaStreamId :: Lens' MediaStream Int Source #

A unique identifier for the media stream.

mediaStream_mediaStreamName :: Lens' MediaStream Text Source #

A name that helps you distinguish one media stream from another.

mediaStream_fmt :: Lens' MediaStream Int Source #

The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.