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

#include <CreateJobOutput.h>

Public Member Functions

 CreateJobOutput ()
 
 CreateJobOutput (Aws::Utils::Json::JsonView jsonValue)
 
CreateJobOutputoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetKey () const
 
bool KeyHasBeenSet () const
 
void SetKey (const Aws::String &value)
 
void SetKey (Aws::String &&value)
 
void SetKey (const char *value)
 
CreateJobOutputWithKey (const Aws::String &value)
 
CreateJobOutputWithKey (Aws::String &&value)
 
CreateJobOutputWithKey (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)
 
CreateJobOutputWithThumbnailPattern (const Aws::String &value)
 
CreateJobOutputWithThumbnailPattern (Aws::String &&value)
 
CreateJobOutputWithThumbnailPattern (const char *value)
 
const EncryptionGetThumbnailEncryption () const
 
bool ThumbnailEncryptionHasBeenSet () const
 
void SetThumbnailEncryption (const Encryption &value)
 
void SetThumbnailEncryption (Encryption &&value)
 
CreateJobOutputWithThumbnailEncryption (const Encryption &value)
 
CreateJobOutputWithThumbnailEncryption (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)
 
CreateJobOutputWithRotate (const Aws::String &value)
 
CreateJobOutputWithRotate (Aws::String &&value)
 
CreateJobOutputWithRotate (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)
 
CreateJobOutputWithPresetId (const Aws::String &value)
 
CreateJobOutputWithPresetId (Aws::String &&value)
 
CreateJobOutputWithPresetId (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)
 
CreateJobOutputWithSegmentDuration (const Aws::String &value)
 
CreateJobOutputWithSegmentDuration (Aws::String &&value)
 
CreateJobOutputWithSegmentDuration (const char *value)
 
const Aws::Vector< JobWatermark > & GetWatermarks () const
 
bool WatermarksHasBeenSet () const
 
void SetWatermarks (const Aws::Vector< JobWatermark > &value)
 
void SetWatermarks (Aws::Vector< JobWatermark > &&value)
 
CreateJobOutputWithWatermarks (const Aws::Vector< JobWatermark > &value)
 
CreateJobOutputWithWatermarks (Aws::Vector< JobWatermark > &&value)
 
CreateJobOutputAddWatermarks (const JobWatermark &value)
 
CreateJobOutputAddWatermarks (JobWatermark &&value)
 
const JobAlbumArtGetAlbumArt () const
 
bool AlbumArtHasBeenSet () const
 
void SetAlbumArt (const JobAlbumArt &value)
 
void SetAlbumArt (JobAlbumArt &&value)
 
CreateJobOutputWithAlbumArt (const JobAlbumArt &value)
 
CreateJobOutputWithAlbumArt (JobAlbumArt &&value)
 
const CaptionsGetCaptions () const
 
bool CaptionsHasBeenSet () const
 
void SetCaptions (const Captions &value)
 
void SetCaptions (Captions &&value)
 
CreateJobOutputWithCaptions (const Captions &value)
 
CreateJobOutputWithCaptions (Captions &&value)
 
const EncryptionGetEncryption () const
 
bool EncryptionHasBeenSet () const
 
void SetEncryption (const Encryption &value)
 
void SetEncryption (Encryption &&value)
 
CreateJobOutputWithEncryption (const Encryption &value)
 
CreateJobOutputWithEncryption (Encryption &&value)
 

Detailed Description

The CreateJobOutput structure.

See Also:

AWS API Reference

Definition at line 36 of file CreateJobOutput.h.

Constructor & Destructor Documentation

◆ CreateJobOutput() [1/2]

Aws::ElasticTranscoder::Model::CreateJobOutput::CreateJobOutput ( )

◆ CreateJobOutput() [2/2]

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

Member Function Documentation

◆ AddWatermarks() [1/2]

CreateJobOutput& Aws::ElasticTranscoder::Model::CreateJobOutput::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 for the current output.

Definition at line 725 of file CreateJobOutput.h.

◆ AddWatermarks() [2/2]

CreateJobOutput& Aws::ElasticTranscoder::Model::CreateJobOutput::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 for the current output.

Definition at line 733 of file CreateJobOutput.h.

◆ AlbumArtHasBeenSet()

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

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.

Definition at line 750 of file CreateJobOutput.h.

◆ CaptionsHasBeenSet()

bool Aws::ElasticTranscoder::Model::CreateJobOutput::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 853 of file CreateJobOutput.h.

◆ EncryptionHasBeenSet()

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

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.

Definition at line 1010 of file CreateJobOutput.h.

◆ GetAlbumArt()

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

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.

Definition at line 742 of file CreateJobOutput.h.

◆ GetCaptions()

const Captions& Aws::ElasticTranscoder::Model::CreateJobOutput::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 818 of file CreateJobOutput.h.

◆ GetEncryption()

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

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.

Definition at line 1002 of file CreateJobOutput.h.

◆ GetKey()

const Aws::String& Aws::ElasticTranscoder::Model::CreateJobOutput::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. If a file with the specified name already exists in the output bucket, the job fails.

Definition at line 51 of file CreateJobOutput.h.

◆ GetPresetId()

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

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.

Definition at line 458 of file CreateJobOutput.h.

◆ GetRotate()

const Aws::String& Aws::ElasticTranscoder::Model::CreateJobOutput::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 387 of file CreateJobOutput.h.

◆ GetSegmentDuration()

const Aws::String& Aws::ElasticTranscoder::Model::CreateJobOutput::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 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 528 of file CreateJobOutput.h.

◆ GetThumbnailEncryption()

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

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

Definition at line 347 of file CreateJobOutput.h.

◆ GetThumbnailPattern()

const Aws::String& Aws::ElasticTranscoder::Model::CreateJobOutput::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 137 of file CreateJobOutput.h.

◆ GetWatermarks()

const Aws::Vector<JobWatermark>& Aws::ElasticTranscoder::Model::CreateJobOutput::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 for the current output.

Definition at line 677 of file CreateJobOutput.h.

◆ Jsonize()

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

◆ KeyHasBeenSet()

bool Aws::ElasticTranscoder::Model::CreateJobOutput::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. If a file with the specified name already exists in the output bucket, the job fails.

Definition at line 59 of file CreateJobOutput.h.

◆ operator=()

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

◆ PresetIdHasBeenSet()

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

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.

Definition at line 465 of file CreateJobOutput.h.

◆ RotateHasBeenSet()

bool Aws::ElasticTranscoder::Model::CreateJobOutput::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 396 of file CreateJobOutput.h.

◆ SegmentDurationHasBeenSet()

bool Aws::ElasticTranscoder::Model::CreateJobOutput::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 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 548 of file CreateJobOutput.h.

◆ SetAlbumArt() [1/2]

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

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.

Definition at line 758 of file CreateJobOutput.h.

◆ SetAlbumArt() [2/2]

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

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.

Definition at line 766 of file CreateJobOutput.h.

◆ SetCaptions() [1/2]

void Aws::ElasticTranscoder::Model::CreateJobOutput::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 923 of file CreateJobOutput.h.

◆ SetCaptions() [2/2]

void Aws::ElasticTranscoder::Model::CreateJobOutput::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 888 of file CreateJobOutput.h.

◆ SetEncryption() [1/2]

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

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.

Definition at line 1018 of file CreateJobOutput.h.

◆ SetEncryption() [2/2]

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

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.

Definition at line 1026 of file CreateJobOutput.h.

◆ SetKey() [1/3]

void Aws::ElasticTranscoder::Model::CreateJobOutput::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. If a file with the specified name already exists in the output bucket, the job fails.

Definition at line 75 of file CreateJobOutput.h.

◆ SetKey() [2/3]

void Aws::ElasticTranscoder::Model::CreateJobOutput::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. If a file with the specified name already exists in the output bucket, the job fails.

Definition at line 67 of file CreateJobOutput.h.

◆ SetKey() [3/3]

void Aws::ElasticTranscoder::Model::CreateJobOutput::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. If a file with the specified name already exists in the output bucket, the job fails.

Definition at line 83 of file CreateJobOutput.h.

◆ SetPresetId() [1/3]

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

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.

Definition at line 479 of file CreateJobOutput.h.

◆ SetPresetId() [2/3]

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

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.

Definition at line 472 of file CreateJobOutput.h.

◆ SetPresetId() [3/3]

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

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.

Definition at line 486 of file CreateJobOutput.h.

◆ SetRotate() [1/3]

void Aws::ElasticTranscoder::Model::CreateJobOutput::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 414 of file CreateJobOutput.h.

◆ SetRotate() [2/3]

void Aws::ElasticTranscoder::Model::CreateJobOutput::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 405 of file CreateJobOutput.h.

◆ SetRotate() [3/3]

void Aws::ElasticTranscoder::Model::CreateJobOutput::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 423 of file CreateJobOutput.h.

◆ SetSegmentDuration() [1/3]

void Aws::ElasticTranscoder::Model::CreateJobOutput::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 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 588 of file CreateJobOutput.h.

◆ SetSegmentDuration() [2/3]

void Aws::ElasticTranscoder::Model::CreateJobOutput::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 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 568 of file CreateJobOutput.h.

◆ SetSegmentDuration() [3/3]

void Aws::ElasticTranscoder::Model::CreateJobOutput::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 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 608 of file CreateJobOutput.h.

◆ SetThumbnailEncryption() [1/2]

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

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

Definition at line 359 of file CreateJobOutput.h.

◆ SetThumbnailEncryption() [2/2]

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

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

Definition at line 365 of file CreateJobOutput.h.

◆ SetThumbnailPattern() [1/3]

void Aws::ElasticTranscoder::Model::CreateJobOutput::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 224 of file CreateJobOutput.h.

◆ SetThumbnailPattern() [2/3]

void Aws::ElasticTranscoder::Model::CreateJobOutput::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 195 of file CreateJobOutput.h.

◆ SetThumbnailPattern() [3/3]

void Aws::ElasticTranscoder::Model::CreateJobOutput::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 253 of file CreateJobOutput.h.

◆ SetWatermarks() [1/2]

void Aws::ElasticTranscoder::Model::CreateJobOutput::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 for the current output.

Definition at line 701 of file CreateJobOutput.h.

◆ SetWatermarks() [2/2]

void Aws::ElasticTranscoder::Model::CreateJobOutput::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 for the current output.

Definition at line 693 of file CreateJobOutput.h.

◆ ThumbnailEncryptionHasBeenSet()

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

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

Definition at line 353 of file CreateJobOutput.h.

◆ ThumbnailPatternHasBeenSet()

bool Aws::ElasticTranscoder::Model::CreateJobOutput::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 166 of file CreateJobOutput.h.

◆ WatermarksHasBeenSet()

bool Aws::ElasticTranscoder::Model::CreateJobOutput::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 for the current output.

Definition at line 685 of file CreateJobOutput.h.

◆ WithAlbumArt() [1/2]

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

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.

Definition at line 774 of file CreateJobOutput.h.

◆ WithAlbumArt() [2/2]

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

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.

Definition at line 782 of file CreateJobOutput.h.

◆ WithCaptions() [1/2]

CreateJobOutput& Aws::ElasticTranscoder::Model::CreateJobOutput::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 993 of file CreateJobOutput.h.

◆ WithCaptions() [2/2]

CreateJobOutput& Aws::ElasticTranscoder::Model::CreateJobOutput::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 958 of file CreateJobOutput.h.

◆ WithEncryption() [1/2]

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

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.

Definition at line 1034 of file CreateJobOutput.h.

◆ WithEncryption() [2/2]

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

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.

Definition at line 1042 of file CreateJobOutput.h.

◆ WithKey() [1/3]

CreateJobOutput& Aws::ElasticTranscoder::Model::CreateJobOutput::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. If a file with the specified name already exists in the output bucket, the job fails.

Definition at line 99 of file CreateJobOutput.h.

◆ WithKey() [2/3]

CreateJobOutput& Aws::ElasticTranscoder::Model::CreateJobOutput::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. If a file with the specified name already exists in the output bucket, the job fails.

Definition at line 91 of file CreateJobOutput.h.

◆ WithKey() [3/3]

CreateJobOutput& Aws::ElasticTranscoder::Model::CreateJobOutput::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. If a file with the specified name already exists in the output bucket, the job fails.

Definition at line 107 of file CreateJobOutput.h.

◆ WithPresetId() [1/3]

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

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.

Definition at line 500 of file CreateJobOutput.h.

◆ WithPresetId() [2/3]

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

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.

Definition at line 493 of file CreateJobOutput.h.

◆ WithPresetId() [3/3]

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

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.

Definition at line 507 of file CreateJobOutput.h.

◆ WithRotate() [1/3]

CreateJobOutput& Aws::ElasticTranscoder::Model::CreateJobOutput::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 441 of file CreateJobOutput.h.

◆ WithRotate() [2/3]

CreateJobOutput& Aws::ElasticTranscoder::Model::CreateJobOutput::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 432 of file CreateJobOutput.h.

◆ WithRotate() [3/3]

CreateJobOutput& Aws::ElasticTranscoder::Model::CreateJobOutput::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 450 of file CreateJobOutput.h.

◆ WithSegmentDuration() [1/3]

CreateJobOutput& Aws::ElasticTranscoder::Model::CreateJobOutput::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 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 648 of file CreateJobOutput.h.

◆ WithSegmentDuration() [2/3]

CreateJobOutput& Aws::ElasticTranscoder::Model::CreateJobOutput::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 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 628 of file CreateJobOutput.h.

◆ WithSegmentDuration() [3/3]

CreateJobOutput& Aws::ElasticTranscoder::Model::CreateJobOutput::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 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 668 of file CreateJobOutput.h.

◆ WithThumbnailEncryption() [1/2]

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

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

Definition at line 371 of file CreateJobOutput.h.

◆ WithThumbnailEncryption() [2/2]

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

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

Definition at line 377 of file CreateJobOutput.h.

◆ WithThumbnailPattern() [1/3]

CreateJobOutput& Aws::ElasticTranscoder::Model::CreateJobOutput::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 311 of file CreateJobOutput.h.

◆ WithThumbnailPattern() [2/3]

CreateJobOutput& Aws::ElasticTranscoder::Model::CreateJobOutput::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 282 of file CreateJobOutput.h.

◆ WithThumbnailPattern() [3/3]

CreateJobOutput& Aws::ElasticTranscoder::Model::CreateJobOutput::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 340 of file CreateJobOutput.h.

◆ WithWatermarks() [1/2]

CreateJobOutput& Aws::ElasticTranscoder::Model::CreateJobOutput::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 for the current output.

Definition at line 717 of file CreateJobOutput.h.

◆ WithWatermarks() [2/2]

CreateJobOutput& Aws::ElasticTranscoder::Model::CreateJobOutput::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 for the current output.

Definition at line 709 of file CreateJobOutput.h.


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