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

Class: Aws::MediaConvert::Types::VideoCodecSettings

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

Overview

Note:

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

{
  codec: "FRAME_CAPTURE", # accepts FRAME_CAPTURE, H_264, H_265, MPEG2, PRORES
  frame_capture_settings: {
    framerate_denominator: 1,
    framerate_numerator: 1,
    max_captures: 1,
    quality: 1,
  },
  h264_settings: {
    adaptive_quantization: "OFF", # accepts OFF, LOW, MEDIUM, HIGH, HIGHER, MAX
    bitrate: 1,
    codec_level: "AUTO", # accepts AUTO, LEVEL_1, LEVEL_1_1, LEVEL_1_2, LEVEL_1_3, LEVEL_2, LEVEL_2_1, LEVEL_2_2, LEVEL_3, LEVEL_3_1, LEVEL_3_2, LEVEL_4, LEVEL_4_1, LEVEL_4_2, LEVEL_5, LEVEL_5_1, LEVEL_5_2
    codec_profile: "BASELINE", # accepts BASELINE, HIGH, HIGH_10BIT, HIGH_422, HIGH_422_10BIT, MAIN
    dynamic_sub_gop: "ADAPTIVE", # accepts ADAPTIVE, STATIC
    entropy_encoding: "CABAC", # accepts CABAC, CAVLC
    field_encoding: "PAFF", # accepts PAFF, FORCE_FIELD
    flicker_adaptive_quantization: "DISABLED", # accepts DISABLED, ENABLED
    framerate_control: "INITIALIZE_FROM_SOURCE", # accepts INITIALIZE_FROM_SOURCE, SPECIFIED
    framerate_conversion_algorithm: "DUPLICATE_DROP", # accepts DUPLICATE_DROP, INTERPOLATE
    framerate_denominator: 1,
    framerate_numerator: 1,
    gop_b_reference: "DISABLED", # accepts DISABLED, ENABLED
    gop_closed_cadence: 1,
    gop_size: 1.0,
    gop_size_units: "FRAMES", # accepts FRAMES, SECONDS
    hrd_buffer_initial_fill_percentage: 1,
    hrd_buffer_size: 1,
    interlace_mode: "PROGRESSIVE", # accepts PROGRESSIVE, TOP_FIELD, BOTTOM_FIELD, FOLLOW_TOP_FIELD, FOLLOW_BOTTOM_FIELD
    max_bitrate: 1,
    min_i_interval: 1,
    number_b_frames_between_reference_frames: 1,
    number_reference_frames: 1,
    par_control: "INITIALIZE_FROM_SOURCE", # accepts INITIALIZE_FROM_SOURCE, SPECIFIED
    par_denominator: 1,
    par_numerator: 1,
    quality_tuning_level: "SINGLE_PASS", # accepts SINGLE_PASS, SINGLE_PASS_HQ, MULTI_PASS_HQ
    qvbr_settings: {
      max_average_bitrate: 1,
      qvbr_quality_level: 1,
    },
    rate_control_mode: "VBR", # accepts VBR, CBR, QVBR
    repeat_pps: "DISABLED", # accepts DISABLED, ENABLED
    scene_change_detect: "DISABLED", # accepts DISABLED, ENABLED, TRANSITION_DETECTION
    slices: 1,
    slow_pal: "DISABLED", # accepts DISABLED, ENABLED
    softness: 1,
    spatial_adaptive_quantization: "DISABLED", # accepts DISABLED, ENABLED
    syntax: "DEFAULT", # accepts DEFAULT, RP2027
    telecine: "NONE", # accepts NONE, SOFT, HARD
    temporal_adaptive_quantization: "DISABLED", # accepts DISABLED, ENABLED
    unregistered_sei_timecode: "DISABLED", # accepts DISABLED, ENABLED
  },
  h265_settings: {
    adaptive_quantization: "OFF", # accepts OFF, LOW, MEDIUM, HIGH, HIGHER, MAX
    alternate_transfer_function_sei: "DISABLED", # accepts DISABLED, ENABLED
    bitrate: 1,
    codec_level: "AUTO", # accepts AUTO, LEVEL_1, LEVEL_2, LEVEL_2_1, LEVEL_3, LEVEL_3_1, LEVEL_4, LEVEL_4_1, LEVEL_5, LEVEL_5_1, LEVEL_5_2, LEVEL_6, LEVEL_6_1, LEVEL_6_2
    codec_profile: "MAIN_MAIN", # accepts MAIN_MAIN, MAIN_HIGH, MAIN10_MAIN, MAIN10_HIGH, MAIN_422_8BIT_MAIN, MAIN_422_8BIT_HIGH, MAIN_422_10BIT_MAIN, MAIN_422_10BIT_HIGH
    dynamic_sub_gop: "ADAPTIVE", # accepts ADAPTIVE, STATIC
    flicker_adaptive_quantization: "DISABLED", # accepts DISABLED, ENABLED
    framerate_control: "INITIALIZE_FROM_SOURCE", # accepts INITIALIZE_FROM_SOURCE, SPECIFIED
    framerate_conversion_algorithm: "DUPLICATE_DROP", # accepts DUPLICATE_DROP, INTERPOLATE
    framerate_denominator: 1,
    framerate_numerator: 1,
    gop_b_reference: "DISABLED", # accepts DISABLED, ENABLED
    gop_closed_cadence: 1,
    gop_size: 1.0,
    gop_size_units: "FRAMES", # accepts FRAMES, SECONDS
    hrd_buffer_initial_fill_percentage: 1,
    hrd_buffer_size: 1,
    interlace_mode: "PROGRESSIVE", # accepts PROGRESSIVE, TOP_FIELD, BOTTOM_FIELD, FOLLOW_TOP_FIELD, FOLLOW_BOTTOM_FIELD
    max_bitrate: 1,
    min_i_interval: 1,
    number_b_frames_between_reference_frames: 1,
    number_reference_frames: 1,
    par_control: "INITIALIZE_FROM_SOURCE", # accepts INITIALIZE_FROM_SOURCE, SPECIFIED
    par_denominator: 1,
    par_numerator: 1,
    quality_tuning_level: "SINGLE_PASS", # accepts SINGLE_PASS, SINGLE_PASS_HQ, MULTI_PASS_HQ
    qvbr_settings: {
      max_average_bitrate: 1,
      qvbr_quality_level: 1,
    },
    rate_control_mode: "VBR", # accepts VBR, CBR, QVBR
    sample_adaptive_offset_filter_mode: "DEFAULT", # accepts DEFAULT, ADAPTIVE, OFF
    scene_change_detect: "DISABLED", # accepts DISABLED, ENABLED, TRANSITION_DETECTION
    slices: 1,
    slow_pal: "DISABLED", # accepts DISABLED, ENABLED
    spatial_adaptive_quantization: "DISABLED", # accepts DISABLED, ENABLED
    telecine: "NONE", # accepts NONE, SOFT, HARD
    temporal_adaptive_quantization: "DISABLED", # accepts DISABLED, ENABLED
    temporal_ids: "DISABLED", # accepts DISABLED, ENABLED
    tiles: "DISABLED", # accepts DISABLED, ENABLED
    unregistered_sei_timecode: "DISABLED", # accepts DISABLED, ENABLED
    write_mp_4_packaging_type: "HVC1", # accepts HVC1, HEV1
  },
  mpeg_2_settings: {
    adaptive_quantization: "OFF", # accepts OFF, LOW, MEDIUM, HIGH
    bitrate: 1,
    codec_level: "AUTO", # accepts AUTO, LOW, MAIN, HIGH1440, HIGH
    codec_profile: "MAIN", # accepts MAIN, PROFILE_422
    dynamic_sub_gop: "ADAPTIVE", # accepts ADAPTIVE, STATIC
    framerate_control: "INITIALIZE_FROM_SOURCE", # accepts INITIALIZE_FROM_SOURCE, SPECIFIED
    framerate_conversion_algorithm: "DUPLICATE_DROP", # accepts DUPLICATE_DROP, INTERPOLATE
    framerate_denominator: 1,
    framerate_numerator: 1,
    gop_closed_cadence: 1,
    gop_size: 1.0,
    gop_size_units: "FRAMES", # accepts FRAMES, SECONDS
    hrd_buffer_initial_fill_percentage: 1,
    hrd_buffer_size: 1,
    interlace_mode: "PROGRESSIVE", # accepts PROGRESSIVE, TOP_FIELD, BOTTOM_FIELD, FOLLOW_TOP_FIELD, FOLLOW_BOTTOM_FIELD
    intra_dc_precision: "AUTO", # accepts AUTO, INTRA_DC_PRECISION_8, INTRA_DC_PRECISION_9, INTRA_DC_PRECISION_10, INTRA_DC_PRECISION_11
    max_bitrate: 1,
    min_i_interval: 1,
    number_b_frames_between_reference_frames: 1,
    par_control: "INITIALIZE_FROM_SOURCE", # accepts INITIALIZE_FROM_SOURCE, SPECIFIED
    par_denominator: 1,
    par_numerator: 1,
    quality_tuning_level: "SINGLE_PASS", # accepts SINGLE_PASS, MULTI_PASS
    rate_control_mode: "VBR", # accepts VBR, CBR
    scene_change_detect: "DISABLED", # accepts DISABLED, ENABLED
    slow_pal: "DISABLED", # accepts DISABLED, ENABLED
    softness: 1,
    spatial_adaptive_quantization: "DISABLED", # accepts DISABLED, ENABLED
    syntax: "DEFAULT", # accepts DEFAULT, D_10
    telecine: "NONE", # accepts NONE, SOFT, HARD
    temporal_adaptive_quantization: "DISABLED", # accepts DISABLED, ENABLED
  },
  prores_settings: {
    codec_profile: "APPLE_PRORES_422", # accepts APPLE_PRORES_422, APPLE_PRORES_422_HQ, APPLE_PRORES_422_LT, APPLE_PRORES_422_PROXY
    framerate_control: "INITIALIZE_FROM_SOURCE", # accepts INITIALIZE_FROM_SOURCE, SPECIFIED
    framerate_conversion_algorithm: "DUPLICATE_DROP", # accepts DUPLICATE_DROP, INTERPOLATE
    framerate_denominator: 1,
    framerate_numerator: 1,
    interlace_mode: "PROGRESSIVE", # accepts PROGRESSIVE, TOP_FIELD, BOTTOM_FIELD, FOLLOW_TOP_FIELD, FOLLOW_BOTTOM_FIELD
    par_control: "INITIALIZE_FROM_SOURCE", # accepts INITIALIZE_FROM_SOURCE, SPECIFIED
    par_denominator: 1,
    par_numerator: 1,
    slow_pal: "DISABLED", # accepts DISABLED, ENABLED
    telecine: "NONE", # accepts NONE, HARD
  },
}

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. * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * FRAME_CAPTURE, FrameCaptureSettings

Instance Attribute Summary collapse

Instance Attribute Details

#codecString

Specifies the video codec. This must be equal to one of the enum values defined by the object VideoCodec.

Returns:

  • (String)


17349
17350
17351
17352
17353
17354
17355
17356
17357
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 17349

class VideoCodecSettings < Struct.new(
  :codec,
  :frame_capture_settings,
  :h264_settings,
  :h265_settings,
  :mpeg_2_settings,
  :prores_settings)
  include Aws::Structure
end

#frame_capture_settingsTypes::FrameCaptureSettings

Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE.



17349
17350
17351
17352
17353
17354
17355
17356
17357
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 17349

class VideoCodecSettings < Struct.new(
  :codec,
  :frame_capture_settings,
  :h264_settings,
  :h265_settings,
  :mpeg_2_settings,
  :prores_settings)
  include Aws::Structure
end

#h264_settingsTypes::H264Settings

Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value H_264.

Returns:



17349
17350
17351
17352
17353
17354
17355
17356
17357
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 17349

class VideoCodecSettings < Struct.new(
  :codec,
  :frame_capture_settings,
  :h264_settings,
  :h265_settings,
  :mpeg_2_settings,
  :prores_settings)
  include Aws::Structure
end

#h265_settingsTypes::H265Settings

Settings for H265 codec

Returns:



17349
17350
17351
17352
17353
17354
17355
17356
17357
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 17349

class VideoCodecSettings < Struct.new(
  :codec,
  :frame_capture_settings,
  :h264_settings,
  :h265_settings,
  :mpeg_2_settings,
  :prores_settings)
  include Aws::Structure
end

#mpeg_2_settingsTypes::Mpeg2Settings

Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value MPEG2.



17349
17350
17351
17352
17353
17354
17355
17356
17357
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 17349

class VideoCodecSettings < Struct.new(
  :codec,
  :frame_capture_settings,
  :h264_settings,
  :h265_settings,
  :mpeg_2_settings,
  :prores_settings)
  include Aws::Structure
end

#prores_settingsTypes::ProresSettings

Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value PRORES.



17349
17350
17351
17352
17353
17354
17355
17356
17357
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 17349

class VideoCodecSettings < Struct.new(
  :codec,
  :frame_capture_settings,
  :h264_settings,
  :h265_settings,
  :mpeg_2_settings,
  :prores_settings)
  include Aws::Structure
end