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.MediaLive.Types.VideoDescription

Description

Documentation

data VideoDescription Source #

Video settings for this stream.

See: newVideoDescription smart constructor.

Constructors

VideoDescription'

Fields

codecSettings :: Maybe VideoCodecSettings
Video codec settings.
height :: Maybe Int
Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
respondToAfd :: Maybe VideoDescriptionRespondToAfd
Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH. RESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME_CAPTURE. PASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output. NONE: MediaLive does not clip the input video and does not include the AFD values in the output
scalingBehavior :: Maybe VideoDescriptionScalingBehavior
STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.
sharpness :: Maybe Natural
Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
width :: Maybe Int
Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
name :: Text
The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.

Instances

Instances details

FromJSON VideoDescription Source #
Instance details Defined in Amazonka.MediaLive.Types.VideoDescription Methods parseJSON :: Value -> Parser VideoDescription # parseJSONList :: Value -> Parser [VideoDescription] #
ToJSON VideoDescription Source #
Instance details Defined in Amazonka.MediaLive.Types.VideoDescription Methods toJSON :: VideoDescription -> Value # toEncoding :: VideoDescription -> Encoding # toJSONList :: [VideoDescription] -> Value # toEncodingList :: [VideoDescription] -> Encoding #
Generic VideoDescription Source #
Instance details Defined in Amazonka.MediaLive.Types.VideoDescription Associated Types type Rep VideoDescription :: Type -> Type # Methods from :: VideoDescription -> Rep VideoDescription x # to :: Rep VideoDescription x -> VideoDescription #
Read VideoDescription Source #
Instance details Defined in Amazonka.MediaLive.Types.VideoDescription Methods readsPrec :: Int -> ReadS VideoDescription # readList :: ReadS [VideoDescription] # readPrec :: ReadPrec VideoDescription # readListPrec :: ReadPrec [VideoDescription] #
Show VideoDescription Source #
Instance details Defined in Amazonka.MediaLive.Types.VideoDescription Methods showsPrec :: Int -> VideoDescription -> ShowS # show :: VideoDescription -> String # showList :: [VideoDescription] -> ShowS #
NFData VideoDescription Source #
Instance details Defined in Amazonka.MediaLive.Types.VideoDescription Methods rnf :: VideoDescription -> () #
Eq VideoDescription Source #
Instance details Defined in Amazonka.MediaLive.Types.VideoDescription Methods (==) :: VideoDescription -> VideoDescription -> Bool # (/=) :: VideoDescription -> VideoDescription -> Bool #
Hashable VideoDescription Source #
Instance details Defined in Amazonka.MediaLive.Types.VideoDescription Methods hashWithSalt :: Int -> VideoDescription -> Int # hash :: VideoDescription -> Int #
type Rep VideoDescription Source #
Instance details Defined in Amazonka.MediaLive.Types.VideoDescription type Rep VideoDescription = D1 ('MetaData "VideoDescription" "Amazonka.MediaLive.Types.VideoDescription" "amazonka-medialive-2.0-FK9HUAz0OmeIH2i6eRdod0" 'False) (C1 ('MetaCons "VideoDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "codecSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VideoCodecSettings)) :: (S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "respondToAfd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VideoDescriptionRespondToAfd)))) :: ((S1 ('MetaSel ('Just "scalingBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VideoDescriptionScalingBehavior)) :: S1 ('MetaSel ('Just "sharpness") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newVideoDescription Source #

Arguments

:: Text	`$sel:name:VideoDescription'`
-> VideoDescription

Create a value of VideoDescription 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:codecSettings:VideoDescription', videoDescription_codecSettings - Video codec settings.

$sel:height:VideoDescription', videoDescription_height - Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.

$sel:respondToAfd:VideoDescription', videoDescription_respondToAfd - Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH. RESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME_CAPTURE. PASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output. NONE: MediaLive does not clip the input video and does not include the AFD values in the output

$sel:scalingBehavior:VideoDescription', videoDescription_scalingBehavior - STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.

$sel:sharpness:VideoDescription', videoDescription_sharpness - Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.

$sel:width:VideoDescription', videoDescription_width - Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.

$sel:name:VideoDescription', videoDescription_name - The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.

videoDescription_codecSettings :: Lens' VideoDescription (Maybe VideoCodecSettings) Source #

Video codec settings.

videoDescription_height :: Lens' VideoDescription (Maybe Int) Source #

Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.

videoDescription_respondToAfd :: Lens' VideoDescription (Maybe VideoDescriptionRespondToAfd) Source #

Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH. RESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME_CAPTURE. PASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output. NONE: MediaLive does not clip the input video and does not include the AFD values in the output

videoDescription_scalingBehavior :: Lens' VideoDescription (Maybe VideoDescriptionScalingBehavior) Source #

STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.

videoDescription_sharpness :: Lens' VideoDescription (Maybe Natural) Source #

Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.

videoDescription_width :: Lens' VideoDescription (Maybe Int) Source #

Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.

videoDescription_name :: Lens' VideoDescription Text Source #

The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.