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

Class: Aws::MediaConvert::Types::TimecodeConfig

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

{
  anchor: "__stringPattern010920405090509092",
  source: "EMBEDDED", # accepts EMBEDDED, ZEROBASED, SPECIFIEDSTART
  start: "__stringPattern010920405090509092",
  timestamp_offset: "__stringPattern0940191020191209301",
}

These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping.

Instance Attribute Summary collapse

Instance Attribute Details

#anchorString

If you use an editing platform that relies on an anchor timecode, use Anchor Timecode (Anchor) to specify a timecode that will match the input video frame to the output video frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or (HH:MM:SS;FF). This setting ignores framerate conversion. System behavior for Anchor Timecode varies depending on your setting for Source (TimecodeSource). * If Source (TimecodeSource) is set to Specified Start (SPECIFIEDSTART), the first input frame is the specified value in Start Timecode (Start). Anchor Timecode (Anchor) and Start Timecode (Start) are used calculate output timecode. * If Source (TimecodeSource) is set to Start at 0 (ZEROBASED) the first frame is 00:00:00:00. * If Source (TimecodeSource) is set to Embedded (EMBEDDED), the first frame is the timecode value on the first input frame of the input.

Returns:

  • (String)


12322
12323
12324
12325
12326
12327
12328
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12322

class TimecodeConfig < Struct.new(
  :anchor,
  :source,
  :start,
  :timestamp_offset)
  include Aws::Structure
end

#sourceString

Use Source (TimecodeSource) to set how timecodes are handled within this job. To make sure that your video, audio, captions, and markers are synchronized and that time-based features, such as image inserter, work correctly, choose the Timecode source option that matches your assets. All timecodes are in a 24-hour format with frame number (HH:MM:SS:FF). * Embedded (EMBEDDED) - Use the timecode that is in the input video. If no embedded timecode is in the source, the service will use Start at 0 (ZEROBASED) instead. * Start at 0 (ZEROBASED) - Set the timecode of the initial frame to 00:00:00:00. * Specified Start (SPECIFIEDSTART) - Set the timecode of the initial frame to a value other than zero. You use Start timecode (Start) to provide this value.

Returns:

  • (String)


12322
12323
12324
12325
12326
12327
12328
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12322

class TimecodeConfig < Struct.new(
  :anchor,
  :source,
  :start,
  :timestamp_offset)
  include Aws::Structure
end

#startString

Only use when you set Source (TimecodeSource) to Specified start (SPECIFIEDSTART). Use Start timecode (Start) to specify the timecode for the initial frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or (HH:MM:SS;FF).

Returns:

  • (String)


12322
12323
12324
12325
12326
12327
12328
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12322

class TimecodeConfig < Struct.new(
  :anchor,
  :source,
  :start,
  :timestamp_offset)
  include Aws::Structure
end

#timestamp_offsetString

Only applies to outputs that support program-date-time stamp. Use Timestamp offset (TimestampOffset) to overwrite the timecode date without affecting the time and frame number. Provide the new date as a string in the format "yyyy-mm-dd". To use Time stamp offset, you must also enable Insert program-date-time (InsertProgramDateTime) in the output settings. For example, if the date part of your timecodes is 2002-1-25 and you want to change it to one year later, set Timestamp offset (TimestampOffset) to 2003-1-25.

Returns:

  • (String)


12322
12323
12324
12325
12326
12327
12328
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12322

class TimecodeConfig < Struct.new(
  :anchor,
  :source,
  :start,
  :timestamp_offset)
  include Aws::Structure
end