Amazonka.IVS.Types.VideoConfiguration

Documentation

data VideoConfiguration

Object specifying a stream’s video configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfiguration object and used for monitoring stream health.

See: newVideoConfiguration smart constructor.

Constructors

VideoConfiguration'

Fields

• avcLevel :: Maybe Text

  Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.

• avcProfile :: Maybe Text

  Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.

• codec :: Maybe Text

  Codec used for the video encoding.

• encoder :: Maybe Text

  Software or hardware used to encode the video.

• targetBitrate :: Maybe Integer

  The expected ingest bitrate (bits per second). This is configured in the encoder.

• targetFramerate :: Maybe Integer

  The expected ingest framerate. This is configured in the encoder.

• videoHeight :: Maybe Integer

  Video-resolution height in pixels.

• videoWidth :: Maybe Integer

  Video-resolution width in pixels.

Instances

FromJSON VideoConfiguration

Defined in Amazonka.IVS.Types.VideoConfiguration

Methods

parseJSON :: Value -> Parser VideoConfiguration

parseJSONList :: Value -> Parser [VideoConfiguration]

Generic VideoConfiguration

Defined in Amazonka.IVS.Types.VideoConfiguration

Associated Types

type Rep VideoConfiguration :: Type -> Type

Methods

from :: VideoConfiguration -> Rep VideoConfiguration x

to :: Rep VideoConfiguration x -> VideoConfiguration

Read VideoConfiguration

Defined in Amazonka.IVS.Types.VideoConfiguration

Methods

readsPrec :: Int -> ReadS VideoConfiguration

readList :: ReadS [VideoConfiguration]

readPrec :: ReadPrec VideoConfiguration

readListPrec :: ReadPrec [VideoConfiguration]

Show VideoConfiguration

Defined in Amazonka.IVS.Types.VideoConfiguration

Methods

showsPrec :: Int -> VideoConfiguration -> ShowS

show :: VideoConfiguration -> String

showList :: [VideoConfiguration] -> ShowS

NFData VideoConfiguration

Defined in Amazonka.IVS.Types.VideoConfiguration

Methods

rnf :: VideoConfiguration -> ()

Eq VideoConfiguration

Defined in Amazonka.IVS.Types.VideoConfiguration

Methods

(==) :: VideoConfiguration -> VideoConfiguration -> Bool

(/=) :: VideoConfiguration -> VideoConfiguration -> Bool

Hashable VideoConfiguration

Defined in Amazonka.IVS.Types.VideoConfiguration

Methods

hashWithSalt :: Int -> VideoConfiguration -> Int

hash :: VideoConfiguration -> Int

type Rep VideoConfiguration

Defined in Amazonka.IVS.Types.VideoConfiguration

type Rep VideoConfiguration = D1 ('MetaData "VideoConfiguration" "Amazonka.IVS.Types.VideoConfiguration" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "VideoConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "avcLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "avcProfile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "codec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "encoder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "targetBitrate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "targetFramerate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "videoHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "videoWidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))))

newVideoConfiguration :: VideoConfiguration

Create a value of VideoConfiguration 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:avcLevel:VideoConfiguration', videoConfiguration_avcLevel - Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.

$sel:avcProfile:VideoConfiguration', videoConfiguration_avcProfile - Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.

$sel:codec:VideoConfiguration', videoConfiguration_codec - Codec used for the video encoding.

$sel:encoder:VideoConfiguration', videoConfiguration_encoder - Software or hardware used to encode the video.

$sel:targetBitrate:VideoConfiguration', videoConfiguration_targetBitrate - The expected ingest bitrate (bits per second). This is configured in the encoder.

$sel:targetFramerate:VideoConfiguration', videoConfiguration_targetFramerate - The expected ingest framerate. This is configured in the encoder.

$sel:videoHeight:VideoConfiguration', videoConfiguration_videoHeight - Video-resolution height in pixels.

$sel:videoWidth:VideoConfiguration', videoConfiguration_videoWidth - Video-resolution width in pixels.

videoConfiguration_avcLevel :: Lens' VideoConfiguration (Maybe Text)

Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.

videoConfiguration_avcProfile :: Lens' VideoConfiguration (Maybe Text)

Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.

videoConfiguration_codec :: Lens' VideoConfiguration (Maybe Text)

Codec used for the video encoding.

videoConfiguration_encoder :: Lens' VideoConfiguration (Maybe Text)

Software or hardware used to encode the video.

videoConfiguration_targetBitrate :: Lens' VideoConfiguration (Maybe Integer)

The expected ingest bitrate (bits per second). This is configured in the encoder.

videoConfiguration_targetFramerate :: Lens' VideoConfiguration (Maybe Integer)

The expected ingest framerate. This is configured in the encoder.

videoConfiguration_videoHeight :: Lens' VideoConfiguration (Maybe Integer)

Video-resolution height in pixels.

videoConfiguration_videoWidth :: Lens' VideoConfiguration (Maybe Integer)

Video-resolution width in pixels.