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

Class: Aws::MediaConvert::Types::InsertableImage

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

{
  duration: 1,
  fade_in: 1,
  fade_out: 1,
  height: 1,
  image_inserter_input: "__string",
  image_x: 1,
  image_y: 1,
  layer: 1,
  opacity: 1,
  start_time: "__string",
  width: 1,
}

Settings for Insertable Image

Instance Attribute Summary collapse

Instance Attribute Details

#durationInteger

Use Duration (Duration) to set the time, in milliseconds, for the image to remain on the output video.

Returns:

  • (Integer)


6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6313

class InsertableImage < Struct.new(
  :duration,
  :fade_in,
  :fade_out,
  :height,
  :image_inserter_input,
  :image_x,
  :image_y,
  :layer,
  :opacity,
  :start_time,
  :width)
  include Aws::Structure
end

#fade_inInteger

Use Fade in (FadeIut) to set the length, in milliseconds, of the inserted image fade in. If you don't specify a value for Fade in, the image will appear abruptly at the Start time.

Returns:

  • (Integer)


6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6313

class InsertableImage < Struct.new(
  :duration,
  :fade_in,
  :fade_out,
  :height,
  :image_inserter_input,
  :image_x,
  :image_y,
  :layer,
  :opacity,
  :start_time,
  :width)
  include Aws::Structure
end

#fade_outInteger

Use Fade out (FadeOut) to set the length, in milliseconds, of the inserted image fade out. If you don't specify a value for Fade out, the image will disappear abruptly at the end of the inserted image duration.

Returns:

  • (Integer)


6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6313

class InsertableImage < Struct.new(
  :duration,
  :fade_in,
  :fade_out,
  :height,
  :image_inserter_input,
  :image_x,
  :image_y,
  :layer,
  :opacity,
  :start_time,
  :width)
  include Aws::Structure
end

#heightInteger

Specify the Height (Height) of the inserted image. Use a value that is less than or equal to the video resolution height. Leave this setting blank to use the native height of the image.

Returns:

  • (Integer)


6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6313

class InsertableImage < Struct.new(
  :duration,
  :fade_in,
  :fade_out,
  :height,
  :image_inserter_input,
  :image_x,
  :image_y,
  :layer,
  :opacity,
  :start_time,
  :width)
  include Aws::Structure
end

#image_inserter_inputString

Use Image location (imageInserterInput) to specify the Amazon S3 location of the image to be inserted into the output. Use a 32 bit BMP, PNG, or TGA file that fits inside the video frame.

Returns:

  • (String)


6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6313

class InsertableImage < Struct.new(
  :duration,
  :fade_in,
  :fade_out,
  :height,
  :image_inserter_input,
  :image_x,
  :image_y,
  :layer,
  :opacity,
  :start_time,
  :width)
  include Aws::Structure
end

#image_xInteger

Use Left (ImageX) to set the distance, in pixels, between the inserted image and the left edge of the frame. Required for BMP, PNG and TGA input.

Returns:

  • (Integer)


6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6313

class InsertableImage < Struct.new(
  :duration,
  :fade_in,
  :fade_out,
  :height,
  :image_inserter_input,
  :image_x,
  :image_y,
  :layer,
  :opacity,
  :start_time,
  :width)
  include Aws::Structure
end

#image_yInteger

Use Top (ImageY) to set the distance, in pixels, between the inserted image and the top edge of the video frame. Required for BMP, PNG and TGA input.

Returns:

  • (Integer)


6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6313

class InsertableImage < Struct.new(
  :duration,
  :fade_in,
  :fade_out,
  :height,
  :image_inserter_input,
  :image_x,
  :image_y,
  :layer,
  :opacity,
  :start_time,
  :width)
  include Aws::Structure
end

#layerInteger

Use Layer (Layer) to specify how overlapping inserted images appear. Images with higher values of layer appear on top of images with lower values of layer.

Returns:

  • (Integer)


6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6313

class InsertableImage < Struct.new(
  :duration,
  :fade_in,
  :fade_out,
  :height,
  :image_inserter_input,
  :image_x,
  :image_y,
  :layer,
  :opacity,
  :start_time,
  :width)
  include Aws::Structure
end

#opacityInteger

Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.

Returns:

  • (Integer)


6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6313

class InsertableImage < Struct.new(
  :duration,
  :fade_in,
  :fade_out,
  :height,
  :image_inserter_input,
  :image_x,
  :image_y,
  :layer,
  :opacity,
  :start_time,
  :width)
  include Aws::Structure
end

#start_timeString

Use Start time (StartTime) to specify the video timecode when the image is inserted in the output. This must be in timecode format (HH:MM:SS:FF)

Returns:

  • (String)


6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6313

class InsertableImage < Struct.new(
  :duration,
  :fade_in,
  :fade_out,
  :height,
  :image_inserter_input,
  :image_x,
  :image_y,
  :layer,
  :opacity,
  :start_time,
  :width)
  include Aws::Structure
end

#widthInteger

Specify the Width (Width) of the inserted image. Use a value that is less than or equal to the video resolution width. Leave this setting blank to use the native width of the image.

Returns:

  • (Integer)


6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6313

class InsertableImage < Struct.new(
  :duration,
  :fade_in,
  :fade_out,
  :height,
  :image_inserter_input,
  :image_x,
  :image_y,
  :layer,
  :opacity,
  :start_time,
  :width)
  include Aws::Structure
end