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

Class: Aws::ElasticTranscoder::Types::CreatePresetRequest

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

{
  name: "Name", # required
  description: "Description",
  container: "PresetContainer", # required
  video: {
    codec: "VideoCodec",
    codec_options: {
      "CodecOption" => "CodecOption",
    },
    keyframes_max_dist: "KeyframesMaxDist",
    fixed_gop: "FixedGOP",
    bit_rate: "VideoBitRate",
    frame_rate: "FrameRate",
    max_frame_rate: "MaxFrameRate",
    resolution: "Resolution",
    aspect_ratio: "AspectRatio",
    max_width: "DigitsOrAuto",
    max_height: "DigitsOrAuto",
    display_aspect_ratio: "AspectRatio",
    sizing_policy: "SizingPolicy",
    padding_policy: "PaddingPolicy",
    watermarks: [
      {
        id: "PresetWatermarkId",
        max_width: "PixelsOrPercent",
        max_height: "PixelsOrPercent",
        sizing_policy: "WatermarkSizingPolicy",
        horizontal_align: "HorizontalAlign",
        horizontal_offset: "PixelsOrPercent",
        vertical_align: "VerticalAlign",
        vertical_offset: "PixelsOrPercent",
        opacity: "Opacity",
        target: "Target",
      },
    ],
  },
  audio: {
    codec: "AudioCodec",
    sample_rate: "AudioSampleRate",
    bit_rate: "AudioBitRate",
    channels: "AudioChannels",
    audio_packing_mode: "AudioPackingMode",
    codec_options: {
      profile: "AudioCodecProfile",
      bit_depth: "AudioBitDepth",
      bit_order: "AudioBitOrder",
      signed: "AudioSigned",
    },
  },
  thumbnails: {
    format: "JpgOrPng",
    interval: "Digits",
    resolution: "ThumbnailResolution",
    aspect_ratio: "AspectRatio",
    max_width: "DigitsOrAuto",
    max_height: "DigitsOrAuto",
    sizing_policy: "SizingPolicy",
    padding_policy: "PaddingPolicy",
  },
}

The CreatePresetRequest structure.

Instance Attribute Summary collapse

Instance Attribute Details

#audioTypes::AudioParameters

A section of the request body that specifies the audio parameters.



1856
1857
1858
1859
1860
1861
1862
1863
1864
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 1856

class CreatePresetRequest < Struct.new(
  :name,
  :description,
  :container,
  :video,
  :audio,
  :thumbnails)
  include Aws::Structure
end

#containerString

The container type for the output file. Valid values include flac, flv, fmp4, gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm.

Returns:

  • (String)


1856
1857
1858
1859
1860
1861
1862
1863
1864
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 1856

class CreatePresetRequest < Struct.new(
  :name,
  :description,
  :container,
  :video,
  :audio,
  :thumbnails)
  include Aws::Structure
end

#descriptionString

A description of the preset.

Returns:

  • (String)


1856
1857
1858
1859
1860
1861
1862
1863
1864
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 1856

class CreatePresetRequest < Struct.new(
  :name,
  :description,
  :container,
  :video,
  :audio,
  :thumbnails)
  include Aws::Structure
end

#nameString

The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Returns:

  • (String)


1856
1857
1858
1859
1860
1861
1862
1863
1864
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 1856

class CreatePresetRequest < Struct.new(
  :name,
  :description,
  :container,
  :video,
  :audio,
  :thumbnails)
  include Aws::Structure
end

#thumbnailsTypes::Thumbnails

A section of the request body that specifies the thumbnail parameters, if any.

Returns:



1856
1857
1858
1859
1860
1861
1862
1863
1864
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 1856

class CreatePresetRequest < Struct.new(
  :name,
  :description,
  :container,
  :video,
  :audio,
  :thumbnails)
  include Aws::Structure
end

#videoTypes::VideoParameters

A section of the request body that specifies the video parameters.



1856
1857
1858
1859
1860
1861
1862
1863
1864
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 1856

class CreatePresetRequest < Struct.new(
  :name,
  :description,
  :container,
  :video,
  :audio,
  :thumbnails)
  include Aws::Structure
end