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

Class: Aws::ElasticTranscoder::Types::Thumbnails

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

Overview

Note:

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

{
  format: "JpgOrPng",
  interval: "Digits",
  resolution: "ThumbnailResolution",
  aspect_ratio: "AspectRatio",
  max_width: "DigitsOrAuto",
  max_height: "DigitsOrAuto",
  sizing_policy: "SizingPolicy",
  padding_policy: "PaddingPolicy",
}

Thumbnails for videos.

Instance Attribute Summary collapse

Instance Attribute Details

#aspect_ratioString

To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.

The aspect ratio of thumbnails. Valid values include:

auto, 1:1, 4:3, 3:2, 16:9

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file.

Returns:

  • (String)


4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 4220

class Thumbnails < Struct.new(
  :format,
  :interval,
  :resolution,
  :aspect_ratio,
  :max_width,
  :max_height,
  :sizing_policy,
  :padding_policy)
  include Aws::Structure
end

#formatString

The format of thumbnails, if any. Valid values are jpg and png.

You specify whether you want Elastic Transcoder to create thumbnails when you create a job.

Returns:

  • (String)


4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 4220

class Thumbnails < Struct.new(
  :format,
  :interval,
  :resolution,
  :aspect_ratio,
  :max_width,
  :max_height,
  :sizing_policy,
  :padding_policy)
  include Aws::Structure
end

#intervalString

The approximate number of seconds between thumbnails. Specify an integer value.

Returns:

  • (String)


4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 4220

class Thumbnails < Struct.new(
  :format,
  :interval,
  :resolution,
  :aspect_ratio,
  :max_width,
  :max_height,
  :sizing_policy,
  :padding_policy)
  include Aws::Structure
end

#max_heightString

The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072.

Returns:

  • (String)


4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 4220

class Thumbnails < Struct.new(
  :format,
  :interval,
  :resolution,
  :aspect_ratio,
  :max_width,
  :max_height,
  :sizing_policy,
  :padding_policy)
  include Aws::Structure
end

#max_widthString

The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096.

Returns:

  • (String)


4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 4220

class Thumbnails < Struct.new(
  :format,
  :interval,
  :resolution,
  :aspect_ratio,
  :max_width,
  :max_height,
  :sizing_policy,
  :padding_policy)
  include Aws::Structure
end

#padding_policyString

When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnail MaxWidth and MaxHeight settings.

Returns:

  • (String)


4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 4220

class Thumbnails < Struct.new(
  :format,
  :interval,
  :resolution,
  :aspect_ratio,
  :max_width,
  :max_height,
  :sizing_policy,
  :padding_policy)
  include Aws::Structure
end

#resolutionString

To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.

The width and height of thumbnail files in pixels. Specify a value in the format width x height where both values are even integers. The values cannot exceed the width and height that you specified in the Video:Resolution object.

Returns:

  • (String)


4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 4220

class Thumbnails < Struct.new(
  :format,
  :interval,
  :resolution,
  :aspect_ratio,
  :max_width,
  :max_height,
  :sizing_policy,
  :padding_policy)
  include Aws::Structure
end

#sizing_policyString

Specify one of the following values to control scaling of thumbnails:

  • Fit: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding the other value.

  • Fill: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings and matches or exceeds the other value. Elastic Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum value.

  • Stretch: Elastic Transcoder stretches thumbnails to match the values that you specified for thumbnail MaxWidth and MaxHeight settings. If the relative proportions of the input video and thumbnails are different, the thumbnails will be distorted.

  • Keep: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds the values that you specified for thumbnail MaxWidth and MaxHeight settings, Elastic Transcoder crops the thumbnails.

  • ShrinkToFit: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of thumbnail MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.

  • ShrinkToFill: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.

Returns:

  • (String)


4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 4220

class Thumbnails < Struct.new(
  :format,
  :interval,
  :resolution,
  :aspect_ratio,
  :max_width,
  :max_height,
  :sizing_policy,
  :padding_policy)
  include Aws::Structure
end