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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb

Overview

Note:

When making an API call, you may pass VideoDescription data as a hash:

{
  codec_settings: {
    frame_capture_settings: {
      capture_interval: 1, # required
    },
    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
      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_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
      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: {
        },
      },
      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, QVBR
      scan_type: "PROGRESSIVE", # accepts PROGRESSIVE
      scene_change_detect: "DISABLED", # accepts DISABLED, ENABLED
      slices: 1,
      tier: "HIGH", # accepts HIGH, MAIN
      timecode_insertion: "DISABLED", # accepts DISABLED, PIC_TIMING_SEI
    },
  },
  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

Instance Attribute Details

#codec_settingsTypes::VideoCodecSettings

Video codec settings.



13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 13966

class VideoDescription < Struct.new(
  :codec_settings,
  :height,
  :name,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :width)
  include Aws::Structure
end

#heightInteger

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)


13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 13966

class VideoDescription < Struct.new(
  :codec_settings,
  :height,
  :name,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :width)
  include Aws::Structure
end

#nameString

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)


13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 13966

class VideoDescription < Struct.new(
  :codec_settings,
  :height,
  :name,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :width)
  include Aws::Structure
end

#respond_to_afdString

Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.

Returns:

  • (String)


13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 13966

class VideoDescription < Struct.new(
  :codec_settings,
  :height,
  :name,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :width)
  include Aws::Structure
end

#scaling_behaviorString

STRETCHTOOUTPUT 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.

Returns:

  • (String)


13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 13966

class VideoDescription < Struct.new(
  :codec_settings,
  :height,
  :name,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :width)
  include Aws::Structure
end

#sharpnessInteger

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)


13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 13966

class VideoDescription < Struct.new(
  :codec_settings,
  :height,
  :name,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :width)
  include Aws::Structure
end

#widthInteger

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)


13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 13966

class VideoDescription < Struct.new(
  :codec_settings,
  :height,
  :name,
  :respond_to_afd,
  :scaling_behavior,
  :sharpness,
  :width)
  include Aws::Structure
end