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

Class: Aws::MediaConvert::Types::MotionImageInserter

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

{
  framerate: {
    framerate_denominator: 1,
    framerate_numerator: 1,
  },
  input: "__stringMin14Max1285PatternS3Mov09Png",
  insertion_mode: "MOV", # accepts MOV, PNG
  offset: {
    image_x: 1,
    image_y: 1,
  },
  playback: "ONCE", # accepts ONCE, REPEAT
  start_time: "__stringMin11Max11Pattern01D20305D205D",
}

Overlay motion graphics on top of your video at the time that you specify.

Instance Attribute Summary collapse

Instance Attribute Details

#framerateTypes::MotionImageInsertionFramerate

If your motion graphic asset is a .mov file, keep this setting unspecified. If your motion graphic asset is a series of .png files, specify the frame rate of the overlay in frames per second, as a fraction. For example, specify 24 fps as 24/1. Make sure that the number of images in your series matches the frame rate and your intended overlay duration. For example, if you want a 30-second overlay at 30 fps, you should have 900 .png images. This overlay frame rate doesn't need to match the frame rate of the underlying video.



11598
11599
11600
11601
11602
11603
11604
11605
11606
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 11598

class MotionImageInserter < Struct.new(
  :framerate,
  :input,
  :insertion_mode,
  :offset,
  :playback,
  :start_time)
  include Aws::Structure
end

#inputString

Specify the .mov file or series of .png files that you want to overlay on your video. For .png files, provide the file name of the first file in the series. Make sure that the names of the .png files end with sequential numbers that specify the order that they are played in. For example, overlay_000.png, overlay_001.png, overlay_002.png, and so on. The sequence must start at zero, and each image file name must have the same number of digits. Pad your initial file names with enough zeros to complete the sequence. For example, if the first image is overlay_0.png, there can be only 10 images in the sequence, with the last image being overlay_9.png. But if the first image is overlay_00.png, there can be 100 images in the sequence.

Returns:

  • (String)


11598
11599
11600
11601
11602
11603
11604
11605
11606
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 11598

class MotionImageInserter < Struct.new(
  :framerate,
  :input,
  :insertion_mode,
  :offset,
  :playback,
  :start_time)
  include Aws::Structure
end

#insertion_modeString

Choose the type of motion graphic asset that you are providing for your overlay. You can choose either a .mov file or a series of .png files.

Returns:

  • (String)


11598
11599
11600
11601
11602
11603
11604
11605
11606
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 11598

class MotionImageInserter < Struct.new(
  :framerate,
  :input,
  :insertion_mode,
  :offset,
  :playback,
  :start_time)
  include Aws::Structure
end

#offsetTypes::MotionImageInsertionOffset

Use Offset to specify the placement of your motion graphic overlay on the video frame. Specify in pixels, from the upper-left corner of the frame. If you don't specify an offset, the service scales your overlay to the full size of the frame. Otherwise, the service inserts the overlay at its native resolution and scales the size up or down with any video scaling.



11598
11599
11600
11601
11602
11603
11604
11605
11606
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 11598

class MotionImageInserter < Struct.new(
  :framerate,
  :input,
  :insertion_mode,
  :offset,
  :playback,
  :start_time)
  include Aws::Structure
end

#playbackString

Specify whether your motion graphic overlay repeats on a loop or plays only once.

Returns:

  • (String)


11598
11599
11600
11601
11602
11603
11604
11605
11606
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 11598

class MotionImageInserter < Struct.new(
  :framerate,
  :input,
  :insertion_mode,
  :offset,
  :playback,
  :start_time)
  include Aws::Structure
end

#start_timeString

Specify when the motion overlay begins. Use timecode format (HH:MM:SS:FF or HH:MM:SS;FF). Make sure that the timecode you provide here takes into account how you have set up your timecode configuration under both job settings and input settings. The simplest way to do that is to set both to start at 0. If you need to set up your job to follow timecodes embedded in your source that don't start at zero, make sure that you specify a start time that is after the first embedded timecode. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/setting-up-timecode.html Find job-wide and input timecode configuration settings in your JSON job settings specification at settings>timecodeConfig>source and settings>inputs>timecodeSource.

Returns:

  • (String)


11598
11599
11600
11601
11602
11603
11604
11605
11606
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 11598

class MotionImageInserter < Struct.new(
  :framerate,
  :input,
  :insertion_mode,
  :offset,
  :playback,
  :start_time)
  include Aws::Structure
end