Class: Aws::ElasticTranscoder::Types::JobOutput

Inherits:

Struct

Object
Struct
Aws::ElasticTranscoder::Types::JobOutput

show all

Includes:: Structure

Defined in:: lib/aws-sdk-elastictranscoder/types.rb

Overview

Outputs recommended instead.

If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the ‘Output` object lists information about the first output. This duplicates the information that is listed for the first output in the `Outputs` object.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#album_art ⇒ Types::JobAlbumArt

The album art to be associated with the output file, if any.
#applied_color_space_conversion ⇒ String

If Elastic Transcoder used a preset with a ‘ColorSpaceConversionMode` to transcode the output file, the `AppliedColorSpaceConversion` parameter shows the conversion used.
#captions ⇒ Types::Captions

You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another.
#composition ⇒ Array<Types::Clip>

You can create an output file that contains an excerpt from the input file.
#duration ⇒ Integer

Duration of the output file, in seconds.
#duration_millis ⇒ Integer

Duration of the output file, in milliseconds.
#encryption ⇒ Types::Encryption

The encryption settings, if any, that you want Elastic Transcoder to apply to your output files.
#file_size ⇒ Integer

File size of the output file, in bytes.
#frame_rate ⇒ String

Frame rate of the output file, in frames per second.
#height ⇒ Integer

Height of the output file, in pixels.
#id ⇒ String

A sequential counter, starting with 1, that identifies an output among the outputs from the current job.
#key ⇒ String

The name to assign to the transcoded file.
#preset_id ⇒ String

The value of the ‘Id` object for the preset that you want to use for this job.
#rotate ⇒ String

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input.
#segment_duration ⇒ String

(Outputs in Fragmented MP4 or MPEG-TS format only.
#status ⇒ String

The status of one output in a job.
#status_detail ⇒ String

Information that further explains ‘Status`.
#thumbnail_encryption ⇒ Types::Encryption

The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
#thumbnail_pattern ⇒ String

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
#watermarks ⇒ Array<Types::JobWatermark>

Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding.
#width ⇒ Integer

Specifies the width of the output file in pixels.

Instance Attribute Details

#album_art ⇒ `Types::JobAlbumArt`

The album art to be associated with the output file, if any.

Returns:

(Types::JobAlbumArt)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#applied_color_space_conversion ⇒ `String`

If Elastic Transcoder used a preset with a ‘ColorSpaceConversionMode` to transcode the output file, the `AppliedColorSpaceConversion` parameter shows the conversion used. If no `ColorSpaceConversionMode` was defined in the preset, this parameter is not be included in the job response.

Returns:

(String)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#captions ⇒ `Types::Captions`

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.

Returns:

(Types::Captions)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#composition ⇒ `Array<Types::Clip>`

You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.

Returns:

(Array<Types::Clip>)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#duration ⇒ `Integer`

Duration of the output file, in seconds.

Returns:

(Integer)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#duration_millis ⇒ `Integer`

Duration of the output file, in milliseconds.

Returns:

(Integer)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#encryption ⇒ `Types::Encryption`

The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. If you choose to use encryption, you must specify a mode to use. If you choose not to use encryption, Elastic Transcoder writes an unencrypted file to your Amazon S3 bucket.

Returns:

(Types::Encryption)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#file_size ⇒ `Integer`

File size of the output file, in bytes.

Returns:

(Integer)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#frame_rate ⇒ `String`

Frame rate of the output file, in frames per second.

Returns:

(String)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#height ⇒ `Integer`

Height of the output file, in pixels.

Returns:

(Integer)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ `String`

A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1.

Returns:

(String)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#key ⇒ `String`

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the ‘OutputBucket` object in the pipeline that is specified by the pipeline ID.

Returns:

(String)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#preset_id ⇒ `String`

The value of the ‘Id` object for the preset that you want to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding. To use a preset that you created, specify the preset ID that Elastic Transcoder returned in the response when you created the preset. You can also use the Elastic Transcoder system presets, which you can get with `ListPresets`.

Returns:

(String)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#rotate ⇒ `String`

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values:

‘auto`, `0`, `90`, `180`, `270`

The value ‘auto` generally works only if the file that you’re transcoding contains rotation metadata.

Returns:

(String)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#segment_duration ⇒ `String`

(Outputs in Fragmented MP4 or MPEG-TS format only.

If you specify a preset in ‘PresetId` for which the value of `Container` is `fmp4` (Fragmented MP4) or `ts` (MPEG-TS), `SegmentDuration` is the target maximum duration of each segment in seconds. For `HLSv3` format playlists, each media segment is stored in a separate `.ts` file. For `HLSv4`, `MPEG-DASH`, and `Smooth` playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the `SegmentDuration`, though individual segments might be shorter or longer.

The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by ‘SegmentDuration`, the duration of the last segment is the remainder of total length/SegmentDuration.

Elastic Transcoder creates an output-specific playlist for each output ‘HLS` output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the `OutputKeys` of the associated playlist.

Returns:

(String)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The status of one output in a job. If you specified only one output for the job, ‘Outputs:Status` is always the same as `Job:Status`. If you specified more than one output:

‘Job:Status` and `Outputs:Status` for all of the outputs is Submitted until Elastic Transcoder starts to process the first output.
When Elastic Transcoder starts to process the first output, ‘Outputs:Status` for that output and `Job:Status` both change to Progressing. For each output, the value of `Outputs:Status` remains Submitted until Elastic Transcoder starts to process the output.
Job:Status remains Progressing until all of the outputs reach a terminal status, either Complete or Error.
When all of the outputs reach a terminal status, ‘Job:Status` changes to Complete only if `Outputs:Status` for all of the outputs is `Complete`. If `Outputs:Status` for one or more outputs is `Error`, the terminal status for `Job:Status` is also `Error`.

The value of ‘Status` is one of the following: `Submitted`, `Progressing`, `Complete`, `Canceled`, or `Error`.

Returns:

(String)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#status_detail ⇒ `String`

Information that further explains ‘Status`.

Returns:

(String)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#thumbnail_encryption ⇒ `Types::Encryption`

The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.

Returns:

(Types::Encryption)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#thumbnail_pattern ⇒ `String`

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.

If you don’t want Elastic Transcoder to create thumbnails, specify “”.

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:

\{count\} (Required): If you want to create thumbnails, you must include ‘count` in the `ThumbnailPattern` object. Wherever you specify `count`, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file.

If you specify a literal value and/or ‘resolution` but you omit `count`, Elastic Transcoder returns a validation error and does not create the job.
**Literal values (Optional)**: You can specify literal values anywhere in the ‘ThumbnailPattern` object. For example, you can include them as a file name prefix or as a delimiter between `resolution` and `count`.
\{resolution\} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include ‘resolution` in the `ThumbnailPattern` object.

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the ‘PresetID` value of `CreateJobOutput`. Elastic Transcoder also appends the applicable file name extension.

Returns:

(String)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#watermarks ⇒ `Array<Types::JobWatermark>`

Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset that you specify in ‘Preset` for the current output.

Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add covers the first one, the third one covers the second, and the fourth one covers the third.

Returns:

(Array<Types::JobWatermark>)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

#width ⇒ `Integer`

Specifies the width of the output file in pixels.

Returns:

(Integer)

# File 'lib/aws-sdk-elastictranscoder/types.rb', line 2096

class JobOutput < Struct.new(
  :id,
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :status,
  :status_detail,
  :duration,
  :width,
  :height,
  :frame_rate,
  :file_size,
  :duration_millis,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption,
  :applied_color_space_conversion)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::ElasticTranscoder::Types::JobOutput

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#album_art ⇒ Types::JobAlbumArt

#applied_color_space_conversion ⇒ String

#captions ⇒ Types::Captions

#composition ⇒ Array<Types::Clip>

#duration ⇒ Integer

#duration_millis ⇒ Integer

#encryption ⇒ Types::Encryption

#file_size ⇒ Integer

#frame_rate ⇒ String

#height ⇒ Integer

#id ⇒ String

#key ⇒ String

#preset_id ⇒ String

#rotate ⇒ String

#segment_duration ⇒ String

#status ⇒ String

#status_detail ⇒ String

#thumbnail_encryption ⇒ Types::Encryption

#thumbnail_pattern ⇒ String

#watermarks ⇒ Array<Types::JobWatermark>

#width ⇒ Integer

#album_art ⇒ `Types::JobAlbumArt`

#applied_color_space_conversion ⇒ `String`

#captions ⇒ `Types::Captions`

#composition ⇒ `Array<Types::Clip>`

#duration ⇒ `Integer`

#duration_millis ⇒ `Integer`

#encryption ⇒ `Types::Encryption`

#file_size ⇒ `Integer`

#frame_rate ⇒ `String`

#height ⇒ `Integer`

#id ⇒ `String`

#key ⇒ `String`

#preset_id ⇒ `String`

#rotate ⇒ `String`

#segment_duration ⇒ `String`

#status ⇒ `String`

#status_detail ⇒ `String`

#thumbnail_encryption ⇒ `Types::Encryption`

#thumbnail_pattern ⇒ `String`

#watermarks ⇒ `Array<Types::JobWatermark>`

#width ⇒ `Integer`