AWS SDK for C++  1.9.69
AWS SDK for C++
Public Member Functions | List of all members
Aws::ElasticTranscoder::Model::JobOutput Class Reference

#include <JobOutput.h>

Public Member Functions

 JobOutput ()
 
 JobOutput (Aws::Utils::Json::JsonView jsonValue)
 
JobOutputoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
JobOutputWithId (const Aws::String &value)
 
JobOutputWithId (Aws::String &&value)
 
JobOutputWithId (const char *value)
 
const Aws::StringGetKey () const
 
bool KeyHasBeenSet () const
 
void SetKey (const Aws::String &value)
 
void SetKey (Aws::String &&value)
 
void SetKey (const char *value)
 
JobOutputWithKey (const Aws::String &value)
 
JobOutputWithKey (Aws::String &&value)
 
JobOutputWithKey (const char *value)
 
const Aws::StringGetThumbnailPattern () const
 
bool ThumbnailPatternHasBeenSet () const
 
void SetThumbnailPattern (const Aws::String &value)
 
void SetThumbnailPattern (Aws::String &&value)
 
void SetThumbnailPattern (const char *value)
 
JobOutputWithThumbnailPattern (const Aws::String &value)
 
JobOutputWithThumbnailPattern (Aws::String &&value)
 
JobOutputWithThumbnailPattern (const char *value)
 
const EncryptionGetThumbnailEncryption () const
 
bool ThumbnailEncryptionHasBeenSet () const
 
void SetThumbnailEncryption (const Encryption &value)
 
void SetThumbnailEncryption (Encryption &&value)
 
JobOutputWithThumbnailEncryption (const Encryption &value)
 
JobOutputWithThumbnailEncryption (Encryption &&value)
 
const Aws::StringGetRotate () const
 
bool RotateHasBeenSet () const
 
void SetRotate (const Aws::String &value)
 
void SetRotate (Aws::String &&value)
 
void SetRotate (const char *value)
 
JobOutputWithRotate (const Aws::String &value)
 
JobOutputWithRotate (Aws::String &&value)
 
JobOutputWithRotate (const char *value)
 
const Aws::StringGetPresetId () const
 
bool PresetIdHasBeenSet () const
 
void SetPresetId (const Aws::String &value)
 
void SetPresetId (Aws::String &&value)
 
void SetPresetId (const char *value)
 
JobOutputWithPresetId (const Aws::String &value)
 
JobOutputWithPresetId (Aws::String &&value)
 
JobOutputWithPresetId (const char *value)
 
const Aws::StringGetSegmentDuration () const
 
bool SegmentDurationHasBeenSet () const
 
void SetSegmentDuration (const Aws::String &value)
 
void SetSegmentDuration (Aws::String &&value)
 
void SetSegmentDuration (const char *value)
 
JobOutputWithSegmentDuration (const Aws::String &value)
 
JobOutputWithSegmentDuration (Aws::String &&value)
 
JobOutputWithSegmentDuration (const char *value)
 
const Aws::StringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
JobOutputWithStatus (const Aws::String &value)
 
JobOutputWithStatus (Aws::String &&value)
 
JobOutputWithStatus (const char *value)
 
const Aws::StringGetStatusDetail () const
 
bool StatusDetailHasBeenSet () const
 
void SetStatusDetail (const Aws::String &value)
 
void SetStatusDetail (Aws::String &&value)
 
void SetStatusDetail (const char *value)
 
JobOutputWithStatusDetail (const Aws::String &value)
 
JobOutputWithStatusDetail (Aws::String &&value)
 
JobOutputWithStatusDetail (const char *value)
 
long long GetDuration () const
 
bool DurationHasBeenSet () const
 
void SetDuration (long long value)
 
JobOutputWithDuration (long long value)
 
int GetWidth () const
 
bool WidthHasBeenSet () const
 
void SetWidth (int value)
 
JobOutputWithWidth (int value)
 
int GetHeight () const
 
bool HeightHasBeenSet () const
 
void SetHeight (int value)
 
JobOutputWithHeight (int value)
 
const Aws::StringGetFrameRate () const
 
bool FrameRateHasBeenSet () const
 
void SetFrameRate (const Aws::String &value)
 
void SetFrameRate (Aws::String &&value)
 
void SetFrameRate (const char *value)
 
JobOutputWithFrameRate (const Aws::String &value)
 
JobOutputWithFrameRate (Aws::String &&value)
 
JobOutputWithFrameRate (const char *value)
 
long long GetFileSize () const
 
bool FileSizeHasBeenSet () const
 
void SetFileSize (long long value)
 
JobOutputWithFileSize (long long value)
 
long long GetDurationMillis () const
 
bool DurationMillisHasBeenSet () const
 
void SetDurationMillis (long long value)
 
JobOutputWithDurationMillis (long long value)
 
const Aws::Vector< JobWatermark > & GetWatermarks () const
 
bool WatermarksHasBeenSet () const
 
void SetWatermarks (const Aws::Vector< JobWatermark > &value)
 
void SetWatermarks (Aws::Vector< JobWatermark > &&value)
 
JobOutputWithWatermarks (const Aws::Vector< JobWatermark > &value)
 
JobOutputWithWatermarks (Aws::Vector< JobWatermark > &&value)
 
JobOutputAddWatermarks (const JobWatermark &value)
 
JobOutputAddWatermarks (JobWatermark &&value)
 
const JobAlbumArtGetAlbumArt () const
 
bool AlbumArtHasBeenSet () const
 
void SetAlbumArt (const JobAlbumArt &value)
 
void SetAlbumArt (JobAlbumArt &&value)
 
JobOutputWithAlbumArt (const JobAlbumArt &value)
 
JobOutputWithAlbumArt (JobAlbumArt &&value)
 
const CaptionsGetCaptions () const
 
bool CaptionsHasBeenSet () const
 
void SetCaptions (const Captions &value)
 
void SetCaptions (Captions &&value)
 
JobOutputWithCaptions (const Captions &value)
 
JobOutputWithCaptions (Captions &&value)
 
const EncryptionGetEncryption () const
 
bool EncryptionHasBeenSet () const
 
void SetEncryption (const Encryption &value)
 
void SetEncryption (Encryption &&value)
 
JobOutputWithEncryption (const Encryption &value)
 
JobOutputWithEncryption (Encryption &&value)
 
const Aws::StringGetAppliedColorSpaceConversion () const
 
bool AppliedColorSpaceConversionHasBeenSet () const
 
void SetAppliedColorSpaceConversion (const Aws::String &value)
 
void SetAppliedColorSpaceConversion (Aws::String &&value)
 
void SetAppliedColorSpaceConversion (const char *value)
 
JobOutputWithAppliedColorSpaceConversion (const Aws::String &value)
 
JobOutputWithAppliedColorSpaceConversion (Aws::String &&value)
 
JobOutputWithAppliedColorSpaceConversion (const char *value)
 

Detailed Description

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.

See Also:

AWS API Reference

Definition at line 40 of file JobOutput.h.

Constructor & Destructor Documentation

◆ JobOutput() [1/2]

Aws::ElasticTranscoder::Model::JobOutput::JobOutput ( )

◆ JobOutput() [2/2]

Aws::ElasticTranscoder::Model::JobOutput::JobOutput ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddWatermarks() [1/2]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::AddWatermarks ( const JobWatermark value)
inline

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.

Definition at line 1200 of file JobOutput.h.

◆ AddWatermarks() [2/2]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::AddWatermarks ( JobWatermark &&  value)
inline

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.

Definition at line 1214 of file JobOutput.h.

◆ AlbumArtHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::AlbumArtHasBeenSet ( ) const
inline

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

Definition at line 1225 of file JobOutput.h.

◆ AppliedColorSpaceConversionHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::AppliedColorSpaceConversionHasBeenSet ( ) const
inline

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.

Definition at line 1524 of file JobOutput.h.

◆ CaptionsHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::CaptionsHasBeenSet ( ) const
inline

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.

Definition at line 1316 of file JobOutput.h.

◆ DurationHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::DurationHasBeenSet ( ) const
inline

Duration of the output file, in seconds.

Definition at line 966 of file JobOutput.h.

◆ DurationMillisHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::DurationMillisHasBeenSet ( ) const
inline

Duration of the output file, in milliseconds.

Definition at line 1091 of file JobOutput.h.

◆ EncryptionHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::EncryptionHasBeenSet ( ) const
inline

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.

Definition at line 1473 of file JobOutput.h.

◆ FileSizeHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::FileSizeHasBeenSet ( ) const
inline

File size of the output file, in bytes.

Definition at line 1070 of file JobOutput.h.

◆ FrameRateHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::FrameRateHasBeenSet ( ) const
inline

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

Definition at line 1029 of file JobOutput.h.

◆ GetAlbumArt()

const JobAlbumArt& Aws::ElasticTranscoder::Model::JobOutput::GetAlbumArt ( ) const
inline

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

Definition at line 1220 of file JobOutput.h.

◆ GetAppliedColorSpaceConversion()

const Aws::String& Aws::ElasticTranscoder::Model::JobOutput::GetAppliedColorSpaceConversion ( ) const
inline

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.

Definition at line 1515 of file JobOutput.h.

◆ GetCaptions()

const Captions& Aws::ElasticTranscoder::Model::JobOutput::GetCaptions ( ) const
inline

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.

Definition at line 1281 of file JobOutput.h.

◆ GetDuration()

long long Aws::ElasticTranscoder::Model::JobOutput::GetDuration ( ) const
inline

Duration of the output file, in seconds.

Definition at line 961 of file JobOutput.h.

◆ GetDurationMillis()

long long Aws::ElasticTranscoder::Model::JobOutput::GetDurationMillis ( ) const
inline

Duration of the output file, in milliseconds.

Definition at line 1086 of file JobOutput.h.

◆ GetEncryption()

const Encryption& Aws::ElasticTranscoder::Model::JobOutput::GetEncryption ( ) const
inline

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.

Definition at line 1465 of file JobOutput.h.

◆ GetFileSize()

long long Aws::ElasticTranscoder::Model::JobOutput::GetFileSize ( ) const
inline

File size of the output file, in bytes.

Definition at line 1065 of file JobOutput.h.

◆ GetFrameRate()

const Aws::String& Aws::ElasticTranscoder::Model::JobOutput::GetFrameRate ( ) const
inline

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

Definition at line 1024 of file JobOutput.h.

◆ GetHeight()

int Aws::ElasticTranscoder::Model::JobOutput::GetHeight ( ) const
inline

Height of the output file, in pixels.

Definition at line 1003 of file JobOutput.h.

◆ GetId()

const Aws::String& Aws::ElasticTranscoder::Model::JobOutput::GetId ( ) const
inline

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.

Definition at line 53 of file JobOutput.h.

◆ GetKey()

const Aws::String& Aws::ElasticTranscoder::Model::JobOutput::GetKey ( ) const
inline

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.

Definition at line 103 of file JobOutput.h.

◆ GetPresetId()

const Aws::String& Aws::ElasticTranscoder::Model::JobOutput::GetPresetId ( ) const
inline

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.

Definition at line 506 of file JobOutput.h.

◆ GetRotate()

const Aws::String& Aws::ElasticTranscoder::Model::JobOutput::GetRotate ( ) const
inline

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.

Definition at line 432 of file JobOutput.h.

◆ GetSegmentDuration()

const Aws::String& Aws::ElasticTranscoder::Model::JobOutput::GetSegmentDuration ( ) const
inline

(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.

Definition at line 597 of file JobOutput.h.

◆ GetStatus()

const Aws::String& Aws::ElasticTranscoder::Model::JobOutput::GetStatus ( ) const
inline

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.

Definition at line 760 of file JobOutput.h.

◆ GetStatusDetail()

const Aws::String& Aws::ElasticTranscoder::Model::JobOutput::GetStatusDetail ( ) const
inline

Information that further explains Status.

Definition at line 920 of file JobOutput.h.

◆ GetThumbnailEncryption()

const Encryption& Aws::ElasticTranscoder::Model::JobOutput::GetThumbnailEncryption ( ) const
inline

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

Definition at line 392 of file JobOutput.h.

◆ GetThumbnailPattern()

const Aws::String& Aws::ElasticTranscoder::Model::JobOutput::GetThumbnailPattern ( ) const
inline

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.

Definition at line 182 of file JobOutput.h.

◆ GetWatermarks()

const Aws::Vector<JobWatermark>& Aws::ElasticTranscoder::Model::JobOutput::GetWatermarks ( ) const
inline

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.

Definition at line 1116 of file JobOutput.h.

◆ GetWidth()

int Aws::ElasticTranscoder::Model::JobOutput::GetWidth ( ) const
inline

Specifies the width of the output file in pixels.

Definition at line 982 of file JobOutput.h.

◆ HeightHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::HeightHasBeenSet ( ) const
inline

Height of the output file, in pixels.

Definition at line 1008 of file JobOutput.h.

◆ IdHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::IdHasBeenSet ( ) const
inline

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.

Definition at line 59 of file JobOutput.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ElasticTranscoder::Model::JobOutput::Jsonize ( ) const

◆ KeyHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::KeyHasBeenSet ( ) const
inline

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.

Definition at line 110 of file JobOutput.h.

◆ operator=()

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PresetIdHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::PresetIdHasBeenSet ( ) const
inline

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.

Definition at line 516 of file JobOutput.h.

◆ RotateHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::RotateHasBeenSet ( ) const
inline

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.

Definition at line 441 of file JobOutput.h.

◆ SegmentDurationHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::SegmentDurationHasBeenSet ( ) const
inline

(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.

Definition at line 617 of file JobOutput.h.

◆ SetAlbumArt() [1/2]

void Aws::ElasticTranscoder::Model::JobOutput::SetAlbumArt ( const JobAlbumArt value)
inline

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

Definition at line 1230 of file JobOutput.h.

◆ SetAlbumArt() [2/2]

void Aws::ElasticTranscoder::Model::JobOutput::SetAlbumArt ( JobAlbumArt &&  value)
inline

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

Definition at line 1235 of file JobOutput.h.

◆ SetAppliedColorSpaceConversion() [1/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetAppliedColorSpaceConversion ( Aws::String &&  value)
inline

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.

Definition at line 1542 of file JobOutput.h.

◆ SetAppliedColorSpaceConversion() [2/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetAppliedColorSpaceConversion ( const Aws::String value)
inline

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.

Definition at line 1533 of file JobOutput.h.

◆ SetAppliedColorSpaceConversion() [3/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetAppliedColorSpaceConversion ( const char *  value)
inline

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.

Definition at line 1551 of file JobOutput.h.

◆ SetCaptions() [1/2]

void Aws::ElasticTranscoder::Model::JobOutput::SetCaptions ( Captions &&  value)
inline

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.

Definition at line 1386 of file JobOutput.h.

◆ SetCaptions() [2/2]

void Aws::ElasticTranscoder::Model::JobOutput::SetCaptions ( const Captions value)
inline

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.

Definition at line 1351 of file JobOutput.h.

◆ SetDuration()

void Aws::ElasticTranscoder::Model::JobOutput::SetDuration ( long long  value)
inline

Duration of the output file, in seconds.

Definition at line 971 of file JobOutput.h.

◆ SetDurationMillis()

void Aws::ElasticTranscoder::Model::JobOutput::SetDurationMillis ( long long  value)
inline

Duration of the output file, in milliseconds.

Definition at line 1096 of file JobOutput.h.

◆ SetEncryption() [1/2]

void Aws::ElasticTranscoder::Model::JobOutput::SetEncryption ( const Encryption value)
inline

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.

Definition at line 1481 of file JobOutput.h.

◆ SetEncryption() [2/2]

void Aws::ElasticTranscoder::Model::JobOutput::SetEncryption ( Encryption &&  value)
inline

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.

Definition at line 1489 of file JobOutput.h.

◆ SetFileSize()

void Aws::ElasticTranscoder::Model::JobOutput::SetFileSize ( long long  value)
inline

File size of the output file, in bytes.

Definition at line 1075 of file JobOutput.h.

◆ SetFrameRate() [1/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetFrameRate ( Aws::String &&  value)
inline

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

Definition at line 1039 of file JobOutput.h.

◆ SetFrameRate() [2/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetFrameRate ( const Aws::String value)
inline

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

Definition at line 1034 of file JobOutput.h.

◆ SetFrameRate() [3/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetFrameRate ( const char *  value)
inline

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

Definition at line 1044 of file JobOutput.h.

◆ SetHeight()

void Aws::ElasticTranscoder::Model::JobOutput::SetHeight ( int  value)
inline

Height of the output file, in pixels.

Definition at line 1013 of file JobOutput.h.

◆ SetId() [1/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetId ( Aws::String &&  value)
inline

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.

Definition at line 71 of file JobOutput.h.

◆ SetId() [2/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetId ( const Aws::String value)
inline

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.

Definition at line 65 of file JobOutput.h.

◆ SetId() [3/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetId ( const char *  value)
inline

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.

Definition at line 77 of file JobOutput.h.

◆ SetKey() [1/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetKey ( Aws::String &&  value)
inline

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.

Definition at line 124 of file JobOutput.h.

◆ SetKey() [2/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetKey ( const Aws::String value)
inline

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.

Definition at line 117 of file JobOutput.h.

◆ SetKey() [3/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetKey ( const char *  value)
inline

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.

Definition at line 131 of file JobOutput.h.

◆ SetPresetId() [1/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetPresetId ( Aws::String &&  value)
inline

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.

Definition at line 536 of file JobOutput.h.

◆ SetPresetId() [2/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetPresetId ( const Aws::String value)
inline

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.

Definition at line 526 of file JobOutput.h.

◆ SetPresetId() [3/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetPresetId ( const char *  value)
inline

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.

Definition at line 546 of file JobOutput.h.

◆ SetRotate() [1/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetRotate ( Aws::String &&  value)
inline

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.

Definition at line 459 of file JobOutput.h.

◆ SetRotate() [2/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetRotate ( const Aws::String value)
inline

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.

Definition at line 450 of file JobOutput.h.

◆ SetRotate() [3/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetRotate ( const char *  value)
inline

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.

Definition at line 468 of file JobOutput.h.

◆ SetSegmentDuration() [1/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetSegmentDuration ( Aws::String &&  value)
inline

(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.

Definition at line 657 of file JobOutput.h.

◆ SetSegmentDuration() [2/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetSegmentDuration ( const Aws::String value)
inline

(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.

Definition at line 637 of file JobOutput.h.

◆ SetSegmentDuration() [3/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetSegmentDuration ( const char *  value)
inline

(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.

Definition at line 677 of file JobOutput.h.

◆ SetStatus() [1/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetStatus ( Aws::String &&  value)
inline

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.

Definition at line 826 of file JobOutput.h.

◆ SetStatus() [2/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetStatus ( const Aws::String value)
inline

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.

Definition at line 804 of file JobOutput.h.

◆ SetStatus() [3/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetStatus ( const char *  value)
inline

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.

Definition at line 848 of file JobOutput.h.

◆ SetStatusDetail() [1/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetStatusDetail ( Aws::String &&  value)
inline

Information that further explains Status.

Definition at line 935 of file JobOutput.h.

◆ SetStatusDetail() [2/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetStatusDetail ( const Aws::String value)
inline

Information that further explains Status.

Definition at line 930 of file JobOutput.h.

◆ SetStatusDetail() [3/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetStatusDetail ( const char *  value)
inline

Information that further explains Status.

Definition at line 940 of file JobOutput.h.

◆ SetThumbnailEncryption() [1/2]

void Aws::ElasticTranscoder::Model::JobOutput::SetThumbnailEncryption ( const Encryption value)
inline

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

Definition at line 404 of file JobOutput.h.

◆ SetThumbnailEncryption() [2/2]

void Aws::ElasticTranscoder::Model::JobOutput::SetThumbnailEncryption ( Encryption &&  value)
inline

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

Definition at line 410 of file JobOutput.h.

◆ SetThumbnailPattern() [1/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetThumbnailPattern ( Aws::String &&  value)
inline

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.

Definition at line 269 of file JobOutput.h.

◆ SetThumbnailPattern() [2/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetThumbnailPattern ( const Aws::String value)
inline

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.

Definition at line 240 of file JobOutput.h.

◆ SetThumbnailPattern() [3/3]

void Aws::ElasticTranscoder::Model::JobOutput::SetThumbnailPattern ( const char *  value)
inline

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.

Definition at line 298 of file JobOutput.h.

◆ SetWatermarks() [1/2]

void Aws::ElasticTranscoder::Model::JobOutput::SetWatermarks ( Aws::Vector< JobWatermark > &&  value)
inline

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.

Definition at line 1158 of file JobOutput.h.

◆ SetWatermarks() [2/2]

void Aws::ElasticTranscoder::Model::JobOutput::SetWatermarks ( const Aws::Vector< JobWatermark > &  value)
inline

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.

Definition at line 1144 of file JobOutput.h.

◆ SetWidth()

void Aws::ElasticTranscoder::Model::JobOutput::SetWidth ( int  value)
inline

Specifies the width of the output file in pixels.

Definition at line 992 of file JobOutput.h.

◆ StatusDetailHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::StatusDetailHasBeenSet ( ) const
inline

Information that further explains Status.

Definition at line 925 of file JobOutput.h.

◆ StatusHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::StatusHasBeenSet ( ) const
inline

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.

Definition at line 782 of file JobOutput.h.

◆ ThumbnailEncryptionHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::ThumbnailEncryptionHasBeenSet ( ) const
inline

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

Definition at line 398 of file JobOutput.h.

◆ ThumbnailPatternHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::ThumbnailPatternHasBeenSet ( ) const
inline

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.

Definition at line 211 of file JobOutput.h.

◆ WatermarksHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::WatermarksHasBeenSet ( ) const
inline

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.

Definition at line 1130 of file JobOutput.h.

◆ WidthHasBeenSet()

bool Aws::ElasticTranscoder::Model::JobOutput::WidthHasBeenSet ( ) const
inline

Specifies the width of the output file in pixels.

Definition at line 987 of file JobOutput.h.

◆ WithAlbumArt() [1/2]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithAlbumArt ( const JobAlbumArt value)
inline

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

Definition at line 1240 of file JobOutput.h.

◆ WithAlbumArt() [2/2]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithAlbumArt ( JobAlbumArt &&  value)
inline

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

Definition at line 1245 of file JobOutput.h.

◆ WithAppliedColorSpaceConversion() [1/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithAppliedColorSpaceConversion ( Aws::String &&  value)
inline

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.

Definition at line 1569 of file JobOutput.h.

◆ WithAppliedColorSpaceConversion() [2/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithAppliedColorSpaceConversion ( const Aws::String value)
inline

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.

Definition at line 1560 of file JobOutput.h.

◆ WithAppliedColorSpaceConversion() [3/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithAppliedColorSpaceConversion ( const char *  value)
inline

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.

Definition at line 1578 of file JobOutput.h.

◆ WithCaptions() [1/2]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithCaptions ( Captions &&  value)
inline

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.

Definition at line 1456 of file JobOutput.h.

◆ WithCaptions() [2/2]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithCaptions ( const Captions value)
inline

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.

Definition at line 1421 of file JobOutput.h.

◆ WithDuration()

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithDuration ( long long  value)
inline

Duration of the output file, in seconds.

Definition at line 976 of file JobOutput.h.

◆ WithDurationMillis()

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithDurationMillis ( long long  value)
inline

Duration of the output file, in milliseconds.

Definition at line 1101 of file JobOutput.h.

◆ WithEncryption() [1/2]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithEncryption ( const Encryption value)
inline

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.

Definition at line 1497 of file JobOutput.h.

◆ WithEncryption() [2/2]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithEncryption ( Encryption &&  value)
inline

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.

Definition at line 1505 of file JobOutput.h.

◆ WithFileSize()

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithFileSize ( long long  value)
inline

File size of the output file, in bytes.

Definition at line 1080 of file JobOutput.h.

◆ WithFrameRate() [1/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithFrameRate ( Aws::String &&  value)
inline

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

Definition at line 1054 of file JobOutput.h.

◆ WithFrameRate() [2/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithFrameRate ( const Aws::String value)
inline

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

Definition at line 1049 of file JobOutput.h.

◆ WithFrameRate() [3/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithFrameRate ( const char *  value)
inline

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

Definition at line 1059 of file JobOutput.h.

◆ WithHeight()

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithHeight ( int  value)
inline

Height of the output file, in pixels.

Definition at line 1018 of file JobOutput.h.

◆ WithId() [1/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithId ( Aws::String &&  value)
inline

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.

Definition at line 89 of file JobOutput.h.

◆ WithId() [2/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithId ( const Aws::String value)
inline

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.

Definition at line 83 of file JobOutput.h.

◆ WithId() [3/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithId ( const char *  value)
inline

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.

Definition at line 95 of file JobOutput.h.

◆ WithKey() [1/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithKey ( Aws::String &&  value)
inline

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.

Definition at line 145 of file JobOutput.h.

◆ WithKey() [2/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithKey ( const Aws::String value)
inline

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.

Definition at line 138 of file JobOutput.h.

◆ WithKey() [3/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithKey ( const char *  value)
inline

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.

Definition at line 152 of file JobOutput.h.

◆ WithPresetId() [1/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithPresetId ( Aws::String &&  value)
inline

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.

Definition at line 566 of file JobOutput.h.

◆ WithPresetId() [2/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithPresetId ( const Aws::String value)
inline

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.

Definition at line 556 of file JobOutput.h.

◆ WithPresetId() [3/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithPresetId ( const char *  value)
inline

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.

Definition at line 576 of file JobOutput.h.

◆ WithRotate() [1/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithRotate ( Aws::String &&  value)
inline

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.

Definition at line 486 of file JobOutput.h.

◆ WithRotate() [2/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithRotate ( const Aws::String value)
inline

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.

Definition at line 477 of file JobOutput.h.

◆ WithRotate() [3/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithRotate ( const char *  value)
inline

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.

Definition at line 495 of file JobOutput.h.

◆ WithSegmentDuration() [1/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithSegmentDuration ( Aws::String &&  value)
inline

(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.

Definition at line 717 of file JobOutput.h.

◆ WithSegmentDuration() [2/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithSegmentDuration ( const Aws::String value)
inline

(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.

Definition at line 697 of file JobOutput.h.

◆ WithSegmentDuration() [3/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithSegmentDuration ( const char *  value)
inline

(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.

Definition at line 737 of file JobOutput.h.

◆ WithStatus() [1/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithStatus ( Aws::String &&  value)
inline

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.

Definition at line 892 of file JobOutput.h.

◆ WithStatus() [2/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithStatus ( const Aws::String value)
inline

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.

Definition at line 870 of file JobOutput.h.

◆ WithStatus() [3/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithStatus ( const char *  value)
inline

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.

Definition at line 914 of file JobOutput.h.

◆ WithStatusDetail() [1/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithStatusDetail ( Aws::String &&  value)
inline

Information that further explains Status.

Definition at line 950 of file JobOutput.h.

◆ WithStatusDetail() [2/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithStatusDetail ( const Aws::String value)
inline

Information that further explains Status.

Definition at line 945 of file JobOutput.h.

◆ WithStatusDetail() [3/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithStatusDetail ( const char *  value)
inline

Information that further explains Status.

Definition at line 955 of file JobOutput.h.

◆ WithThumbnailEncryption() [1/2]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithThumbnailEncryption ( const Encryption value)
inline

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

Definition at line 416 of file JobOutput.h.

◆ WithThumbnailEncryption() [2/2]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithThumbnailEncryption ( Encryption &&  value)
inline

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

Definition at line 422 of file JobOutput.h.

◆ WithThumbnailPattern() [1/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithThumbnailPattern ( Aws::String &&  value)
inline

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.

Definition at line 356 of file JobOutput.h.

◆ WithThumbnailPattern() [2/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithThumbnailPattern ( const Aws::String value)
inline

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.

Definition at line 327 of file JobOutput.h.

◆ WithThumbnailPattern() [3/3]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithThumbnailPattern ( const char *  value)
inline

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.

Definition at line 385 of file JobOutput.h.

◆ WithWatermarks() [1/2]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithWatermarks ( Aws::Vector< JobWatermark > &&  value)
inline

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.

Definition at line 1186 of file JobOutput.h.

◆ WithWatermarks() [2/2]

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithWatermarks ( const Aws::Vector< JobWatermark > &  value)
inline

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.

Definition at line 1172 of file JobOutput.h.

◆ WithWidth()

JobOutput& Aws::ElasticTranscoder::Model::JobOutput::WithWidth ( int  value)
inline

Specifies the width of the output file in pixels.

Definition at line 997 of file JobOutput.h.


The documentation for this class was generated from the following file: