Class: Aws::MediaConvert::Types::AutomatedAbrRule

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 AutomatedAbrRule data as a hash:

{
  allowed_renditions: [
    {
      height: 1,
      required: "ENABLED", # accepts ENABLED, DISABLED
      width: 1,
    },
  ],
  force_include_renditions: [
    {
      height: 1,
      width: 1,
    },
  ],
  min_bottom_rendition_size: {
    height: 1,
    width: 1,
  },
  min_top_rendition_size: {
    height: 1,
    width: 1,
  },
  type: "MIN_TOP_RENDITION_SIZE", # accepts MIN_TOP_RENDITION_SIZE, MIN_BOTTOM_RENDITION_SIZE, FORCE_INCLUDE_RENDITIONS, ALLOWED_RENDITIONS
}

Specify one or more Automated ABR rule types. Note: Force include and Allowed renditions are mutually exclusive.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_renditionsArray<Types::AllowedRenditionSize>

When customer adds the allowed renditions rule for auto ABR ladder, they are required to add at leat one rendition to allowedRenditions list

Returns:



1255
1256
1257
1258
1259
1260
1261
1262
1263
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1255

class AutomatedAbrRule < Struct.new(
  :allowed_renditions,
  :force_include_renditions,
  :min_bottom_rendition_size,
  :min_top_rendition_size,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#force_include_renditionsArray<Types::ForceIncludeRenditionSize>

When customer adds the force include renditions rule for auto ABR ladder, they are required to add at leat one rendition to forceIncludeRenditions list



1255
1256
1257
1258
1259
1260
1261
1262
1263
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1255

class AutomatedAbrRule < Struct.new(
  :allowed_renditions,
  :force_include_renditions,
  :min_bottom_rendition_size,
  :min_top_rendition_size,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#min_bottom_rendition_sizeTypes::MinBottomRenditionSize

Use Min bottom rendition size to specify a minimum size for the lowest resolution in your ABR stack. * The lowest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 640x360 the lowest resolution in your ABR stack will be equal to or greater than to 640x360. * If you specify a Min top rendition size rule, the value that you specify for Min bottom rendition size must be less than, or equal to, Min top rendition size.



1255
1256
1257
1258
1259
1260
1261
1262
1263
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1255

class AutomatedAbrRule < Struct.new(
  :allowed_renditions,
  :force_include_renditions,
  :min_bottom_rendition_size,
  :min_top_rendition_size,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#min_top_rendition_sizeTypes::MinTopRenditionSize

Use Min top rendition size to specify a minimum size for the highest resolution in your ABR stack. * The highest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 1280x720 the highest resolution in your ABR stack will be equal to or greater than 1280x720. * If you specify a value for Max resolution, the value that you specify for Min top rendition size must be less than, or equal to, Max resolution.



1255
1256
1257
1258
1259
1260
1261
1262
1263
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1255

class AutomatedAbrRule < Struct.new(
  :allowed_renditions,
  :force_include_renditions,
  :min_bottom_rendition_size,
  :min_top_rendition_size,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

Use Min top rendition size to specify a minimum size for the highest resolution in your ABR stack. * The highest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 1280x720 the highest resolution in your ABR stack will be equal to or greater than 1280x720. * If you specify a value for Max resolution, the value that you specify for Min top rendition size must be less than, or equal to, Max resolution. Use Min bottom rendition size to specify a minimum size for the lowest resolution in your ABR stack. * The lowest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 640x360 the lowest resolution in your ABR stack will be equal to or greater than to 640x360. * If you specify a Min top rendition size rule, the value that you specify for Min bottom rendition size must be less than, or equal to, Min top rendition size. Use Force include renditions to specify one or more resolutions to include your ABR stack. * (Recommended) To optimize automated ABR, specify as few resolutions as possible. * (Required) The number of resolutions that you specify must be equal to, or less than, the Max renditions setting. * If you specify a Min top rendition size rule, specify at least one resolution that is equal to, or greater than, Min top rendition size. * If you specify a Min bottom rendition size rule, only specify resolutions that are equal to, or greater than, Min bottom rendition size. * If you specify a Force include renditions rule, do not specify a separate rule for Allowed renditions. * Note: The ABR stack may include other resolutions that you do not specify here, depending on the Max renditions setting. Use Allowed renditions to specify a list of possible resolutions in your ABR stack. * (Required) The number of resolutions that you specify must be equal to, or greater than, the Max renditions setting. * MediaConvert will create an ABR stack exclusively from the list of resolutions that you specify. * Some resolutions in the Allowed renditions list may not be included, however you can force a resolution to be included by setting Required to ENABLED. * You must specify at least one resolution that is greater than or equal to any resolutions that you specify in Min top rendition size or Min bottom rendition size. * If you specify Allowed renditions, you must not specify a separate rule for Force include renditions.

Returns:

  • (String)


1255
1256
1257
1258
1259
1260
1261
1262
1263
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1255

class AutomatedAbrRule < Struct.new(
  :allowed_renditions,
  :force_include_renditions,
  :min_bottom_rendition_size,
  :min_top_rendition_size,
  :type)
  SENSITIVE = []
  include Aws::Structure
end