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

Class: Aws::ElasticTranscoder::Types::JobInput

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

{
  key: "LongKey",
  frame_rate: "FrameRate",
  resolution: "Resolution",
  aspect_ratio: "AspectRatio",
  interlaced: "Interlaced",
  container: "JobContainer",
  encryption: {
    mode: "EncryptionMode",
    key: "Base64EncodedString",
    key_md_5: "Base64EncodedString",
    initialization_vector: "ZeroTo255String",
  },
  time_span: {
    start_time: "Time",
    duration: "Time",
  },
  input_captions: {
    merge_policy: "CaptionMergePolicy",
    caption_sources: [
      {
        key: "LongKey",
        language: "Key",
        time_offset: "TimeOffset",
        label: "Name",
        encryption: {
          mode: "EncryptionMode",
          key: "Base64EncodedString",
          key_md_5: "Base64EncodedString",
          initialization_vector: "ZeroTo255String",
        },
      },
    ],
  },
  detected_properties: {
    width: 1,
    height: 1,
    frame_rate: "FloatString",
    file_size: 1,
    duration_millis: 1,
  },
}

Information about the file that you're transcoding.

Instance Attribute Summary collapse

Instance Attribute Details

#aspect_ratioString

The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify auto. If you want to specify the aspect ratio for the output file, enter one of the following values:

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

If you specify a value other than auto, Elastic Transcoder disables automatic detection of the aspect ratio.

Returns:

  • (String)


2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2561

class JobInput < Struct.new(
  :key,
  :frame_rate,
  :resolution,
  :aspect_ratio,
  :interlaced,
  :container,
  :encryption,
  :time_span,
  :input_captions,
  :detected_properties)
  include Aws::Structure
end

#containerString

The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify auto. If you want to specify the container type for the input file, enter one of the following values:

3gp, aac, asf, avi, divx, flv, m4a, mkv, mov, mp3, mp4, mpeg, mpeg-ps, mpeg-ts, mxf, ogg, vob, wav, webm

Returns:

  • (String)


2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2561

class JobInput < Struct.new(
  :key,
  :frame_rate,
  :resolution,
  :aspect_ratio,
  :interlaced,
  :container,
  :encryption,
  :time_span,
  :input_captions,
  :detected_properties)
  include Aws::Structure
end

#detected_propertiesTypes::DetectedProperties

The detected properties of the input file.



2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2561

class JobInput < Struct.new(
  :key,
  :frame_rate,
  :resolution,
  :aspect_ratio,
  :interlaced,
  :container,
  :encryption,
  :time_span,
  :input_captions,
  :detected_properties)
  include Aws::Structure
end

#encryptionTypes::Encryption

The encryption settings, if any, that are used for decrypting your input files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file.

Returns:



2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2561

class JobInput < Struct.new(
  :key,
  :frame_rate,
  :resolution,
  :aspect_ratio,
  :interlaced,
  :container,
  :encryption,
  :time_span,
  :input_captions,
  :detected_properties)
  include Aws::Structure
end

#frame_rateString

The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify auto. If you want to specify the frame rate for the input file, enter one of the following values:

10, 15, 23.97, 24, 25, 29.97, 30, 60

If you specify a value other than auto, Elastic Transcoder disables automatic detection of the frame rate.

Returns:

  • (String)


2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2561

class JobInput < Struct.new(
  :key,
  :frame_rate,
  :resolution,
  :aspect_ratio,
  :interlaced,
  :container,
  :encryption,
  :time_span,
  :input_captions,
  :detected_properties)
  include Aws::Structure
end

#input_captionsTypes::InputCaptions

You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:

  • Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.

    Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text

    Valid outputs include: mov-text

    Elastic Transcoder supports a maximum of one embedded format per output.

  • Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.

    Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt

    Valid outputs include: dfxp (first div element only), scc, srt, and webvtt.

If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.

To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.

For more information on embedded files, see the Subtitles Wikipedia page.

For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.



2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2561

class JobInput < Struct.new(
  :key,
  :frame_rate,
  :resolution,
  :aspect_ratio,
  :interlaced,
  :container,
  :encryption,
  :time_span,
  :input_captions,
  :detected_properties)
  include Aws::Structure
end

#interlacedString

Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify auto. If you want to specify whether the input file is interlaced, enter one of the following values:

true, false

If you specify a value other than auto, Elastic Transcoder disables automatic detection of interlacing.

Returns:

  • (String)


2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2561

class JobInput < Struct.new(
  :key,
  :frame_rate,
  :resolution,
  :aspect_ratio,
  :interlaced,
  :container,
  :encryption,
  :time_span,
  :input_captions,
  :detected_properties)
  include Aws::Structure
end

#keyString

The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The InputBucket object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.

If the file name includes a prefix, such as cooking/lasagna.mpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

Returns:

  • (String)


2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2561

class JobInput < Struct.new(
  :key,
  :frame_rate,
  :resolution,
  :aspect_ratio,
  :interlaced,
  :container,
  :encryption,
  :time_span,
  :input_captions,
  :detected_properties)
  include Aws::Structure
end

#resolutionString

This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.

Returns:

  • (String)


2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2561

class JobInput < Struct.new(
  :key,
  :frame_rate,
  :resolution,
  :aspect_ratio,
  :interlaced,
  :container,
  :encryption,
  :time_span,
  :input_captions,
  :detected_properties)
  include Aws::Structure
end

#time_spanTypes::TimeSpan

Settings for clipping an input. Each input can have different clip settings.

Returns:



2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2561

class JobInput < Struct.new(
  :key,
  :frame_rate,
  :resolution,
  :aspect_ratio,
  :interlaced,
  :container,
  :encryption,
  :time_span,
  :input_captions,
  :detected_properties)
  include Aws::Structure
end