Class: Aws::ElasticTranscoder::Types::CreateJobOutput

Inherits:

Struct

Object
Struct
Aws::ElasticTranscoder::Types::CreateJobOutput

show all

Includes:: Structure

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

Overview

Note:

When making an API call, you may pass CreateJobOutput data as a hash:

{
  key: "Key",
  thumbnail_pattern: "ThumbnailPattern",
  thumbnail_encryption: {
    mode: "EncryptionMode",
    key: "Base64EncodedString",
    key_md_5: "Base64EncodedString",
    initialization_vector: "ZeroTo255String",
  },
  rotate: "Rotate",
  preset_id: "Id",
  segment_duration: "FloatString",
  watermarks: [
    {
      preset_watermark_id: "PresetWatermarkId",
      input_key: "WatermarkKey",
      encryption: {
        mode: "EncryptionMode",
        key: "Base64EncodedString",
        key_md_5: "Base64EncodedString",
        initialization_vector: "ZeroTo255String",
      },
    },
  ],
  album_art: {
    merge_policy: "MergePolicy",
    artwork: [
      {
        input_key: "WatermarkKey",
        max_width: "DigitsOrAuto",
        max_height: "DigitsOrAuto",
        sizing_policy: "SizingPolicy",
        padding_policy: "PaddingPolicy",
        album_art_format: "JpgOrPng",
        encryption: {
          mode: "EncryptionMode",
          key: "Base64EncodedString",
          key_md_5: "Base64EncodedString",
          initialization_vector: "ZeroTo255String",
        },
      },
    ],
  },
  composition: [
    {
      time_span: {
        start_time: "Time",
        duration: "Time",
      },
    },
  ],
  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",
        },
      },
    ],
    caption_formats: [
      {
        format: "CaptionFormatFormat",
        pattern: "CaptionFormatPattern",
        encryption: {
          mode: "EncryptionMode",
          key: "Base64EncodedString",
          key_md_5: "Base64EncodedString",
          initialization_vector: "ZeroTo255String",
        },
      },
    ],
  },
  encryption: {
    mode: "EncryptionMode",
    key: "Base64EncodedString",
    key_md_5: "Base64EncodedString",
    initialization_vector: "ZeroTo255String",
  },
}

The ‘CreateJobOutput` structure.

Instance Attribute Summary collapse

#album_art ⇒ Types::JobAlbumArt

Information about the album art that you want Elastic Transcoder to add to the file during transcoding.
#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.
#encryption ⇒ Types::Encryption

You can specify encryption settings for any output files that you want to use for a transcoding job.
#key ⇒ String

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

The ‘Id` of the preset 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.
#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.

Instance Attribute Details

#album_art ⇒ `Types::JobAlbumArt`

Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output.

Returns:

(Types::JobAlbumArt)

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

class CreateJobOutput < Struct.new(
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption)
  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 955

class CreateJobOutput < Struct.new(
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption)
  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 955

class CreateJobOutput < Struct.new(
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption)
  include Aws::Structure
end

#encryption ⇒ `Types::Encryption`

You can specify encryption settings for any output files that you want to use for a transcoding job. This includes the output file and any watermarks, thumbnails, album art, or captions that you want to use. You must specify encryption settings for each file individually.

Returns:

(Types::Encryption)

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

class CreateJobOutput < Struct.new(
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption)
  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. If a file with the specified name already exists in the output bucket, the job fails.

Returns:

(String)

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

class CreateJobOutput < Struct.new(
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption)
  include Aws::Structure
end

#preset_id ⇒ `String`

The ‘Id` of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.

Returns:

(String)

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

class CreateJobOutput < Struct.new(
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption)
  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 955

class CreateJobOutput < Struct.new(
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption)
  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` 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 955

class CreateJobOutput < Struct.new(
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption)
  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 955

class CreateJobOutput < Struct.new(
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption)
  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 955

class CreateJobOutput < Struct.new(
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption)
  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 for the current output.

Returns:

(Array<Types::JobWatermark>)

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

class CreateJobOutput < Struct.new(
  :key,
  :thumbnail_pattern,
  :thumbnail_encryption,
  :rotate,
  :preset_id,
  :segment_duration,
  :watermarks,
  :album_art,
  :composition,
  :captions,
  :encryption)
  include Aws::Structure
end

Class: Aws::ElasticTranscoder::Types::CreateJobOutput

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#album_art ⇒ Types::JobAlbumArt

#captions ⇒ Types::Captions

#composition ⇒ Array<Types::Clip>

#encryption ⇒ Types::Encryption

#key ⇒ String

#preset_id ⇒ String

#rotate ⇒ String

#segment_duration ⇒ String

#thumbnail_encryption ⇒ Types::Encryption

#thumbnail_pattern ⇒ String

#watermarks ⇒ Array<Types::JobWatermark>

#album_art ⇒ `Types::JobAlbumArt`

#captions ⇒ `Types::Captions`

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

#encryption ⇒ `Types::Encryption`

#key ⇒ `String`

#preset_id ⇒ `String`

#rotate ⇒ `String`

#segment_duration ⇒ `String`

#thumbnail_encryption ⇒ `Types::Encryption`

#thumbnail_pattern ⇒ `String`

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