Amazonka.MediaConvert.Types.VideoDescription

Documentation

data VideoDescription

Settings related to video encoding of your output. The specific video settings depend on the video codec that you choose. When you work directly in your JSON job specification, include one instance of Video description (VideoDescription) per output.

See: newVideoDescription smart constructor.

Constructors

VideoDescription'

Fields

• afdSignaling :: Maybe AfdSignaling

  This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.

• antiAlias :: Maybe AntiAlias

  The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.

• codecSettings :: Maybe VideoCodecSettings

  Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings

• colorMetadata :: Maybe ColorMetadata

  Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.

• crop :: Maybe Rectangle

  Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.

• dropFrameTimecode :: Maybe DropFrameTimecode

  Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled.

• fixedAfd :: Maybe Natural

  Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output.

• height :: Maybe Natural

  Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.

• position :: Maybe Rectangle

  Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black.

• respondToAfd :: Maybe RespondToAfd

  Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to (NONE). A preferred implementation of this workflow is to set RespondToAfd to (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.

• scalingBehavior :: Maybe ScalingBehavior

  Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.

• sharpness :: Maybe Natural

  Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This setting changes the width of the anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from your input resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content.

• timecodeInsertion :: Maybe VideoTimecodeInsertion

  Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.

• videoPreprocessors :: Maybe VideoPreprocessor

  Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.

• width :: Maybe Natural

  Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width.

Instances

FromJSON VideoDescription

Defined in Amazonka.MediaConvert.Types.VideoDescription

Methods

parseJSON :: Value -> Parser VideoDescription

parseJSONList :: Value -> Parser [VideoDescription]

ToJSON VideoDescription

Defined in Amazonka.MediaConvert.Types.VideoDescription

Methods

toJSON :: VideoDescription -> Value

toEncoding :: VideoDescription -> Encoding

toJSONList :: [VideoDescription] -> Value

toEncodingList :: [VideoDescription] -> Encoding

Generic VideoDescription

Defined in Amazonka.MediaConvert.Types.VideoDescription

Associated Types

type Rep VideoDescription :: Type -> Type

Methods

from :: VideoDescription -> Rep VideoDescription x

to :: Rep VideoDescription x -> VideoDescription

Read VideoDescription

Defined in Amazonka.MediaConvert.Types.VideoDescription

Methods

readsPrec :: Int -> ReadS VideoDescription

readList :: ReadS [VideoDescription]

readPrec :: ReadPrec VideoDescription

readListPrec :: ReadPrec [VideoDescription]

Show VideoDescription

Defined in Amazonka.MediaConvert.Types.VideoDescription

Methods

showsPrec :: Int -> VideoDescription -> ShowS

show :: VideoDescription -> String

showList :: [VideoDescription] -> ShowS

NFData VideoDescription

Defined in Amazonka.MediaConvert.Types.VideoDescription

Methods

rnf :: VideoDescription -> ()

Eq VideoDescription

Defined in Amazonka.MediaConvert.Types.VideoDescription

Methods

(==) :: VideoDescription -> VideoDescription -> Bool

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

Hashable VideoDescription

Defined in Amazonka.MediaConvert.Types.VideoDescription

Methods

hashWithSalt :: Int -> VideoDescription -> Int

hash :: VideoDescription -> Int

type Rep VideoDescription

Defined in Amazonka.MediaConvert.Types.VideoDescription

type Rep VideoDescription = D1 ('MetaData "VideoDescription" "Amazonka.MediaConvert.Types.VideoDescription" "amazonka-mediaconvert-2.0-ClG8xHhlx4y6bdaCrZchqH" 'False) (C1 ('MetaCons "VideoDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "afdSignaling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AfdSignaling)) :*: (S1 ('MetaSel ('Just "antiAlias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AntiAlias)) :*: S1 ('MetaSel ('Just "codecSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VideoCodecSettings)))) :*: ((S1 ('MetaSel ('Just "colorMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ColorMetadata)) :*: S1 ('MetaSel ('Just "crop") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Rectangle))) :*: (S1 ('MetaSel ('Just "dropFrameTimecode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DropFrameTimecode)) :*: S1 ('MetaSel ('Just "fixedAfd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :*: (((S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Rectangle))) :*: (S1 ('MetaSel ('Just "respondToAfd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RespondToAfd)) :*: S1 ('MetaSel ('Just "scalingBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScalingBehavior)))) :*: ((S1 ('MetaSel ('Just "sharpness") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "timecodeInsertion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VideoTimecodeInsertion))) :*: (S1 ('MetaSel ('Just "videoPreprocessors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VideoPreprocessor)) :*: S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))))

newVideoDescription :: 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:afdSignaling:VideoDescription', videoDescription_afdSignaling - This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.

$sel:antiAlias:VideoDescription', videoDescription_antiAlias - The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.

$sel:codecSettings:VideoDescription', videoDescription_codecSettings - Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings

$sel:colorMetadata:VideoDescription', videoDescription_colorMetadata - Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.

$sel:crop:VideoDescription', videoDescription_crop - Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.

$sel:dropFrameTimecode:VideoDescription', videoDescription_dropFrameTimecode - Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled.

$sel:fixedAfd:VideoDescription', videoDescription_fixedAfd - Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output.

VideoDescription, videoDescription_height - Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.

$sel:position:VideoDescription', videoDescription_position - Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black.

$sel:respondToAfd:VideoDescription', videoDescription_respondToAfd - Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to (NONE). A preferred implementation of this workflow is to set RespondToAfd to (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.

$sel:scalingBehavior:VideoDescription', videoDescription_scalingBehavior - Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.

$sel:sharpness:VideoDescription', videoDescription_sharpness - Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This setting changes the width of the anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from your input resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content.

$sel:timecodeInsertion:VideoDescription', videoDescription_timecodeInsertion - Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.

$sel:videoPreprocessors:VideoDescription', videoDescription_videoPreprocessors - Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.

VideoDescription, videoDescription_width - Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width.

videoDescription_afdSignaling :: Lens' VideoDescription (Maybe AfdSignaling)

This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.

videoDescription_antiAlias :: Lens' VideoDescription (Maybe AntiAlias)

The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.

videoDescription_codecSettings :: Lens' VideoDescription (Maybe VideoCodecSettings)

Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings

videoDescription_colorMetadata :: Lens' VideoDescription (Maybe ColorMetadata)

Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.

videoDescription_crop :: Lens' VideoDescription (Maybe Rectangle)

Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.

videoDescription_dropFrameTimecode :: Lens' VideoDescription (Maybe DropFrameTimecode)

Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled.

videoDescription_fixedAfd :: Lens' VideoDescription (Maybe Natural)

Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output.

videoDescription_height :: Lens' VideoDescription (Maybe Natural)

Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.

videoDescription_position :: Lens' VideoDescription (Maybe Rectangle)

Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black.

videoDescription_respondToAfd :: Lens' VideoDescription (Maybe RespondToAfd)

Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to (NONE). A preferred implementation of this workflow is to set RespondToAfd to (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.

videoDescription_scalingBehavior :: Lens' VideoDescription (Maybe ScalingBehavior)

Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.

videoDescription_sharpness :: Lens' VideoDescription (Maybe Natural)

Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This setting changes the width of the anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from your input resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content.

videoDescription_timecodeInsertion :: Lens' VideoDescription (Maybe VideoTimecodeInsertion)

Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.

videoDescription_videoPreprocessors :: Lens' VideoDescription (Maybe VideoPreprocessor)

Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.

videoDescription_width :: Lens' VideoDescription (Maybe Natural)

Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width.