Class: Aws::MediaConvert::Types::VideoDescription

Inherits:

Struct

• Object
• Struct
• Aws::MediaConvert::Types::VideoDescription

Defined in:

gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb

Overview

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 Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #afd_signaling ⇒ String

  This setting only applies to H.264, H.265, and MPEG2 outputs.

• #anti_alias ⇒ String

  The anti-alias filter is automatically applied to all outputs.

• #codec_settings ⇒ Types::VideoCodecSettings

  Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding.

• #color_metadata ⇒ String

  Choose Insert (INSERT) for this setting to include color metadata in this output.

• #crop ⇒ Types::Rectangle

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

• #drop_frame_timecode ⇒ String

  Applies only to 29.97 fps outputs.

• #fixed_afd ⇒ Integer

  Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED).

• #height ⇒ Integer

  Use the Height (Height) setting to define the video resolution height for this output.

• #position ⇒ Types::Rectangle

  Use Selection placement (position) to define the video area in your output frame.

• #respond_to_afd ⇒ String

  Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input.

• #scaling_behavior ⇒ String

  Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio.

• #sharpness ⇒ Integer

  Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing.

• #timecode_insertion ⇒ String

  Applies only to H.264, H.265, MPEG2, and ProRes outputs.

• #video_preprocessors ⇒ Types::VideoPreprocessor

  Find additional transcoding features under Preprocessors (VideoPreprocessors).

• #width ⇒ Integer

  Use Width (Width) to define the video resolution width, in pixels, for this output.

Instance Attribute Details

#afd_signaling ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12355

class VideoDescription < Struct.new(
  :afd_signaling,
  :anti_alias,
  :codec_settings,
  :color_metadata,
  :crop,
  :drop_frame_timecode,
  :fixed_afd,
  :height,
  :position,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :timecode_insertion,
  :video_preprocessors,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#anti_alias ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12355

class VideoDescription < Struct.new(
  :afd_signaling,
  :anti_alias,
  :codec_settings,
  :color_metadata,
  :crop,
  :drop_frame_timecode,
  :fixed_afd,
  :height,
  :position,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :timecode_insertion,
  :video_preprocessors,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#codec_settings ⇒ Types::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

Returns:

• (Types::VideoCodecSettings)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12355

class VideoDescription < Struct.new(
  :afd_signaling,
  :anti_alias,
  :codec_settings,
  :color_metadata,
  :crop,
  :drop_frame_timecode,
  :fixed_afd,
  :height,
  :position,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :timecode_insertion,
  :video_preprocessors,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#color_metadata ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12355

class VideoDescription < Struct.new(
  :afd_signaling,
  :anti_alias,
  :codec_settings,
  :color_metadata,
  :crop,
  :drop_frame_timecode,
  :fixed_afd,
  :height,
  :position,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :timecode_insertion,
  :video_preprocessors,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#crop ⇒ Types::Rectangle

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

Returns:

• (Types::Rectangle)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12355

class VideoDescription < Struct.new(
  :afd_signaling,
  :anti_alias,
  :codec_settings,
  :color_metadata,
  :crop,
  :drop_frame_timecode,
  :fixed_afd,
  :height,
  :position,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :timecode_insertion,
  :video_preprocessors,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#drop_frame_timecode ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12355

class VideoDescription < Struct.new(
  :afd_signaling,
  :anti_alias,
  :codec_settings,
  :color_metadata,
  :crop,
  :drop_frame_timecode,
  :fixed_afd,
  :height,
  :position,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :timecode_insertion,
  :video_preprocessors,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#fixed_afd ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12355

class VideoDescription < Struct.new(
  :afd_signaling,
  :anti_alias,
  :codec_settings,
  :color_metadata,
  :crop,
  :drop_frame_timecode,
  :fixed_afd,
  :height,
  :position,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :timecode_insertion,
  :video_preprocessors,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#height ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12355

class VideoDescription < Struct.new(
  :afd_signaling,
  :anti_alias,
  :codec_settings,
  :color_metadata,
  :crop,
  :drop_frame_timecode,
  :fixed_afd,
  :height,
  :position,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :timecode_insertion,
  :video_preprocessors,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#position ⇒ Types::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.

Returns:

• (Types::Rectangle)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12355

class VideoDescription < Struct.new(
  :afd_signaling,
  :anti_alias,
  :codec_settings,
  :color_metadata,
  :crop,
  :drop_frame_timecode,
  :fixed_afd,
  :height,
  :position,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :timecode_insertion,
  :video_preprocessors,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#respond_to_afd ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12355

class VideoDescription < Struct.new(
  :afd_signaling,
  :anti_alias,
  :codec_settings,
  :color_metadata,
  :crop,
  :drop_frame_timecode,
  :fixed_afd,
  :height,
  :position,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :timecode_insertion,
  :video_preprocessors,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_behavior ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12355

class VideoDescription < Struct.new(
  :afd_signaling,
  :anti_alias,
  :codec_settings,
  :color_metadata,
  :crop,
  :drop_frame_timecode,
  :fixed_afd,
  :height,
  :position,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :timecode_insertion,
  :video_preprocessors,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#sharpness ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12355

class VideoDescription < Struct.new(
  :afd_signaling,
  :anti_alias,
  :codec_settings,
  :color_metadata,
  :crop,
  :drop_frame_timecode,
  :fixed_afd,
  :height,
  :position,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :timecode_insertion,
  :video_preprocessors,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#timecode_insertion ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12355

class VideoDescription < Struct.new(
  :afd_signaling,
  :anti_alias,
  :codec_settings,
  :color_metadata,
  :crop,
  :drop_frame_timecode,
  :fixed_afd,
  :height,
  :position,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :timecode_insertion,
  :video_preprocessors,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#video_preprocessors ⇒ Types::VideoPreprocessor

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

Returns:

• (Types::VideoPreprocessor)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12355

class VideoDescription < Struct.new(
  :afd_signaling,
  :anti_alias,
  :codec_settings,
  :color_metadata,
  :crop,
  :drop_frame_timecode,
  :fixed_afd,
  :height,
  :position,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :timecode_insertion,
  :video_preprocessors,
  :width)
  SENSITIVE = []
  include Aws::Structure
end

#width ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12355

class VideoDescription < Struct.new(
  :afd_signaling,
  :anti_alias,
  :codec_settings,
  :color_metadata,
  :crop,
  :drop_frame_timecode,
  :fixed_afd,
  :height,
  :position,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :timecode_insertion,
  :video_preprocessors,
  :width)
  SENSITIVE = []
  include Aws::Structure
end