You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::MediaLive::Types::VideoDescription

Inherits:

Struct

Object
Struct
Aws::MediaLive::Types::VideoDescription

show all

Defined in:: (unknown)

Overview

Note:

When passing VideoDescription as input to an Aws::Client method, you can use a vanilla Hash:

{
  codec_settings: {
    frame_capture_settings: {
      capture_interval: 1, # required
      capture_interval_units: "MILLISECONDS", # accepts MILLISECONDS, SECONDS
    },
    h264_settings: {
      adaptive_quantization: "HIGH", # accepts HIGH, HIGHER, LOW, MAX, MEDIUM, OFF
      afd_signaling: "AUTO", # accepts AUTO, FIXED, NONE
      bitrate: 1,
      buf_fill_pct: 1,
      buf_size: 1,
      color_metadata: "IGNORE", # accepts IGNORE, INSERT
      color_space_settings: {
        color_space_passthrough_settings: {
        },
        rec_601_settings: {
        },
        rec_709_settings: {
        },
      },
      entropy_encoding: "CABAC", # accepts CABAC, CAVLC
      filter_settings: {
        temporal_filter_settings: {
          post_filter_sharpening: "AUTO", # accepts AUTO, DISABLED, ENABLED
          strength: "AUTO", # accepts AUTO, STRENGTH_1, STRENGTH_2, STRENGTH_3, STRENGTH_4, STRENGTH_5, STRENGTH_6, STRENGTH_7, STRENGTH_8, STRENGTH_9, STRENGTH_10, STRENGTH_11, STRENGTH_12, STRENGTH_13, STRENGTH_14, STRENGTH_15, STRENGTH_16
        },
      },
      fixed_afd: "AFD_0000", # accepts AFD_0000, AFD_0010, AFD_0011, AFD_0100, AFD_1000, AFD_1001, AFD_1010, AFD_1011, AFD_1101, AFD_1110, AFD_1111
      flicker_aq: "DISABLED", # accepts DISABLED, ENABLED
      force_field_pictures: "DISABLED", # accepts DISABLED, ENABLED
      framerate_control: "INITIALIZE_FROM_SOURCE", # accepts INITIALIZE_FROM_SOURCE, SPECIFIED
      framerate_denominator: 1,
      framerate_numerator: 1,
      gop_b_reference: "DISABLED", # accepts DISABLED, ENABLED
      gop_closed_cadence: 1,
      gop_num_b_frames: 1,
      gop_size: 1.0,
      gop_size_units: "FRAMES", # accepts FRAMES, SECONDS
      level: "H264_LEVEL_1", # accepts H264_LEVEL_1, H264_LEVEL_1_1, H264_LEVEL_1_2, H264_LEVEL_1_3, H264_LEVEL_2, H264_LEVEL_2_1, H264_LEVEL_2_2, H264_LEVEL_3, H264_LEVEL_3_1, H264_LEVEL_3_2, H264_LEVEL_4, H264_LEVEL_4_1, H264_LEVEL_4_2, H264_LEVEL_5, H264_LEVEL_5_1, H264_LEVEL_5_2, H264_LEVEL_AUTO
      look_ahead_rate_control: "HIGH", # accepts HIGH, LOW, MEDIUM
      max_bitrate: 1,
      min_i_interval: 1,
      num_ref_frames: 1,
      par_control: "INITIALIZE_FROM_SOURCE", # accepts INITIALIZE_FROM_SOURCE, SPECIFIED
      par_denominator: 1,
      par_numerator: 1,
      profile: "BASELINE", # accepts BASELINE, HIGH, HIGH_10BIT, HIGH_422, HIGH_422_10BIT, MAIN
      quality_level: "ENHANCED_QUALITY", # accepts ENHANCED_QUALITY, STANDARD_QUALITY
      qvbr_quality_level: 1,
      rate_control_mode: "CBR", # accepts CBR, MULTIPLEX, QVBR, VBR
      scan_type: "INTERLACED", # accepts INTERLACED, PROGRESSIVE
      scene_change_detect: "DISABLED", # accepts DISABLED, ENABLED
      slices: 1,
      softness: 1,
      spatial_aq: "DISABLED", # accepts DISABLED, ENABLED
      subgop_length: "DYNAMIC", # accepts DYNAMIC, FIXED
      syntax: "DEFAULT", # accepts DEFAULT, RP2027
      temporal_aq: "DISABLED", # accepts DISABLED, ENABLED
      timecode_insertion: "DISABLED", # accepts DISABLED, PIC_TIMING_SEI
    },
    h265_settings: {
      adaptive_quantization: "HIGH", # accepts HIGH, HIGHER, LOW, MAX, MEDIUM, OFF
      afd_signaling: "AUTO", # accepts AUTO, FIXED, NONE
      alternative_transfer_function: "INSERT", # accepts INSERT, OMIT
      bitrate: 1,
      buf_size: 1,
      color_metadata: "IGNORE", # accepts IGNORE, INSERT
      color_space_settings: {
        color_space_passthrough_settings: {
        },
        hdr_10_settings: {
          max_cll: 1,
          max_fall: 1,
        },
        rec_601_settings: {
        },
        rec_709_settings: {
        },
      },
      filter_settings: {
        temporal_filter_settings: {
          post_filter_sharpening: "AUTO", # accepts AUTO, DISABLED, ENABLED
          strength: "AUTO", # accepts AUTO, STRENGTH_1, STRENGTH_2, STRENGTH_3, STRENGTH_4, STRENGTH_5, STRENGTH_6, STRENGTH_7, STRENGTH_8, STRENGTH_9, STRENGTH_10, STRENGTH_11, STRENGTH_12, STRENGTH_13, STRENGTH_14, STRENGTH_15, STRENGTH_16
        },
      },
      fixed_afd: "AFD_0000", # accepts AFD_0000, AFD_0010, AFD_0011, AFD_0100, AFD_1000, AFD_1001, AFD_1010, AFD_1011, AFD_1101, AFD_1110, AFD_1111
      flicker_aq: "DISABLED", # accepts DISABLED, ENABLED
      framerate_denominator: 1, # required
      framerate_numerator: 1, # required
      gop_closed_cadence: 1,
      gop_size: 1.0,
      gop_size_units: "FRAMES", # accepts FRAMES, SECONDS
      level: "H265_LEVEL_1", # accepts H265_LEVEL_1, H265_LEVEL_2, H265_LEVEL_2_1, H265_LEVEL_3, H265_LEVEL_3_1, H265_LEVEL_4, H265_LEVEL_4_1, H265_LEVEL_5, H265_LEVEL_5_1, H265_LEVEL_5_2, H265_LEVEL_6, H265_LEVEL_6_1, H265_LEVEL_6_2, H265_LEVEL_AUTO
      look_ahead_rate_control: "HIGH", # accepts HIGH, LOW, MEDIUM
      max_bitrate: 1,
      min_i_interval: 1,
      par_denominator: 1,
      par_numerator: 1,
      profile: "MAIN", # accepts MAIN, MAIN_10BIT
      qvbr_quality_level: 1,
      rate_control_mode: "CBR", # accepts CBR, MULTIPLEX, QVBR
      scan_type: "INTERLACED", # accepts INTERLACED, PROGRESSIVE
      scene_change_detect: "DISABLED", # accepts DISABLED, ENABLED
      slices: 1,
      tier: "HIGH", # accepts HIGH, MAIN
      timecode_insertion: "DISABLED", # accepts DISABLED, PIC_TIMING_SEI
    },
    mpeg_2_settings: {
      adaptive_quantization: "AUTO", # accepts AUTO, HIGH, LOW, MEDIUM, OFF
      afd_signaling: "AUTO", # accepts AUTO, FIXED, NONE
      color_metadata: "IGNORE", # accepts IGNORE, INSERT
      color_space: "AUTO", # accepts AUTO, PASSTHROUGH
      display_aspect_ratio: "DISPLAYRATIO16X9", # accepts DISPLAYRATIO16X9, DISPLAYRATIO4X3
      filter_settings: {
        temporal_filter_settings: {
          post_filter_sharpening: "AUTO", # accepts AUTO, DISABLED, ENABLED
          strength: "AUTO", # accepts AUTO, STRENGTH_1, STRENGTH_2, STRENGTH_3, STRENGTH_4, STRENGTH_5, STRENGTH_6, STRENGTH_7, STRENGTH_8, STRENGTH_9, STRENGTH_10, STRENGTH_11, STRENGTH_12, STRENGTH_13, STRENGTH_14, STRENGTH_15, STRENGTH_16
        },
      },
      fixed_afd: "AFD_0000", # accepts AFD_0000, AFD_0010, AFD_0011, AFD_0100, AFD_1000, AFD_1001, AFD_1010, AFD_1011, AFD_1101, AFD_1110, AFD_1111
      framerate_denominator: 1, # required
      framerate_numerator: 1, # required
      gop_closed_cadence: 1,
      gop_num_b_frames: 1,
      gop_size: 1.0,
      gop_size_units: "FRAMES", # accepts FRAMES, SECONDS
      scan_type: "INTERLACED", # accepts INTERLACED, PROGRESSIVE
      subgop_length: "DYNAMIC", # accepts DYNAMIC, FIXED
      timecode_insertion: "DISABLED", # accepts DISABLED, GOP_TIMECODE
    },
  },
  height: 1,
  name: "__string", # required
  respond_to_afd: "NONE", # accepts NONE, PASSTHROUGH, RESPOND
  scaling_behavior: "DEFAULT", # accepts DEFAULT, STRETCH_TO_OUTPUT
  sharpness: 1,
  width: 1,
}

Video settings for this stream.

Instance Attribute Summary collapse

#codec_settings ⇒ Types::VideoCodecSettings
Video codec settings.
#height ⇒ Integer
Output video height, in pixels.
#name ⇒ String
The name of this VideoDescription.
#respond_to_afd ⇒ String
Indicates how MediaLive will respond to the AFD values that might be in the input video.
#scaling_behavior ⇒ String
STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width).
#sharpness ⇒ Integer
Changes the strength of the anti-alias filter used for scaling.
#width ⇒ Integer
Output video width, in pixels.

Instance Attribute Details

#codec_settings ⇒ `Types::VideoCodecSettings`

Video codec settings.

Returns:

(Types::VideoCodecSettings) —
Video codec settings.

#height ⇒ `Integer`

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.

Returns:

(Integer) —
Output video height, in pixels.

#name ⇒ `String`

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

Returns:

(String) —
The name of this VideoDescription.

#respond_to_afd ⇒ `String`

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

Possible values:

NONE
PASSTHROUGH
RESPOND

Returns:

(String) —
Indicates how MediaLive will respond to the AFD values that might be in the input video.

#scaling_behavior ⇒ `String`

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.

Possible values:

DEFAULT
STRETCH_TO_OUTPUT

Returns:

(String) —
STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width).

#sharpness ⇒ `Integer`

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.

Returns:

(Integer) —
Changes the strength of the anti-alias filter used for scaling.

#width ⇒ `Integer`

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.

Returns:

(Integer) —
Output video width, in pixels.

Class: Aws::MediaLive::Types::VideoDescription

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#codec_settings ⇒ Types::VideoCodecSettings

#height ⇒ Integer

#name ⇒ String

#respond_to_afd ⇒ String

#scaling_behavior ⇒ String

#sharpness ⇒ Integer

#width ⇒ Integer

#codec_settings ⇒ `Types::VideoCodecSettings`

#height ⇒ `Integer`

#name ⇒ `String`

#respond_to_afd ⇒ `String`

#scaling_behavior ⇒ `String`

#sharpness ⇒ `Integer`

#width ⇒ `Integer`