/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.elastictranscoder.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* The CreateJobOutput
structure.
*
* 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.
*
* 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.
*
* The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail. *
*/ private Encryption thumbnailEncryption; /** *
* 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.
*
* 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.
*
* (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.
*
* 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. *
*/ private com.amazonaws.internal.SdkInternalList* 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. *
*/ private JobAlbumArt albumArt; /** ** You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come * from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make * up an output file. For the current release, you can only specify settings for a single clip per output file. The * Composition object cannot be null. *
*/ @Deprecated private com.amazonaws.internal.SdkInternalList* 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. *
*/ private Captions captions; /** ** 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. *
*/ private Encryption encryption; /** *
* 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.
*
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.
*/
public void setKey(String key) {
this.key = key;
}
/**
*
* 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.
*
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.
*/
public String getKey() {
return this.key;
}
/**
*
* 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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateJobOutput withKey(String key) {
setKey(key);
return this;
}
/**
* * 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.
*
* 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.
*/
public void setThumbnailPattern(String thumbnailPattern) {
this.thumbnailPattern = thumbnailPattern;
}
/**
*
* 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.
*
* 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.
*/
public String getThumbnailPattern() {
return this.thumbnailPattern;
}
/**
*
* 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.
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateJobOutput withThumbnailPattern(String thumbnailPattern) {
setThumbnailPattern(thumbnailPattern);
return this;
}
/**
*
* The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail. *
* * @param thumbnailEncryption * The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail. */ public void setThumbnailEncryption(Encryption thumbnailEncryption) { this.thumbnailEncryption = thumbnailEncryption; } /** ** The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail. *
* * @return The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail. */ public Encryption getThumbnailEncryption() { return this.thumbnailEncryption; } /** ** The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail. *
* * @param thumbnailEncryption * The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobOutput withThumbnailEncryption(Encryption thumbnailEncryption) { setThumbnailEncryption(thumbnailEncryption); return this; } /** *
* 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.
*
auto
, 0
, 90
,
* 180
, 270
. The value auto
generally works only if the file that
* you're transcoding contains rotation metadata.
*/
public void setRotate(String rotate) {
this.rotate = rotate;
}
/**
*
* 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.
*
auto
, 0
, 90
,
* 180
, 270
. The value auto
generally works only if the file that
* you're transcoding contains rotation metadata.
*/
public String getRotate() {
return this.rotate;
}
/**
*
* 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.
*
auto
, 0
, 90
,
* 180
, 270
. The value auto
generally works only if the file that
* you're transcoding contains rotation metadata.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateJobOutput withRotate(String rotate) {
setRotate(rotate);
return this;
}
/**
*
* 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.
*
Id
of the preset to use for this job. The preset determines the audio, video, and
* thumbnail settings that Elastic Transcoder uses for transcoding.
*/
public void setPresetId(String presetId) {
this.presetId = presetId;
}
/**
*
* 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.
*
Id
of the preset to use for this job. The preset determines the audio, video, and
* thumbnail settings that Elastic Transcoder uses for transcoding.
*/
public String getPresetId() {
return this.presetId;
}
/**
*
* 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.
*
Id
of the preset to use for this job. The preset determines the audio, video, and
* thumbnail settings that Elastic Transcoder uses for transcoding.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateJobOutput withPresetId(String presetId) {
setPresetId(presetId);
return this;
}
/**
* * (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.
*
* (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
* (Outputs in Fragmented MP4 or MPEG-TS format only.
* 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.
*/
public void setSegmentDuration(String segmentDuration) {
this.segmentDuration = segmentDuration;
}
/**
*
* 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.
*
* (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
* (Outputs in Fragmented MP4 or MPEG-TS format only.
* 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.
*/
public String getSegmentDuration() {
return this.segmentDuration;
}
/**
*
* 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.
*
* (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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateJobOutput withSegmentDuration(String segmentDuration) {
setSegmentDuration(segmentDuration);
return this;
}
/**
*
* 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. *
* * @return 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. */ public java.util.List* 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. *
* * @param watermarks * 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. */ public void setWatermarks(java.util.Collection* 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. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setWatermarks(java.util.Collection)} or {@link #withWatermarks(java.util.Collection)} if you want to * override the existing values. *
* * @param watermarks * 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobOutput withWatermarks(JobWatermark... watermarks) { if (this.watermarks == null) { setWatermarks(new com.amazonaws.internal.SdkInternalList* 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. *
* * @param watermarks * 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobOutput withWatermarks(java.util.Collection* 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. *
* * @param albumArt * 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. */ public void setAlbumArt(JobAlbumArt albumArt) { this.albumArt = albumArt; } /** ** 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. *
* * @return 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. */ public JobAlbumArt getAlbumArt() { return this.albumArt; } /** ** 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. *
* * @param albumArt * 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobOutput withAlbumArt(JobAlbumArt albumArt) { setAlbumArt(albumArt); return this; } /** ** You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come * from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make * up an output file. For the current release, you can only specify settings for a single clip per output file. The * Composition object cannot be null. *
* * @return You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, * can come from the beginning, middle, or end of the file. The Composition object contains settings for the * clips that make up an output file. For the current release, you can only specify settings for a single * clip per output file. The Composition object cannot be null. */ @Deprecated public java.util.List* You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come * from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make * up an output file. For the current release, you can only specify settings for a single clip per output file. The * Composition object cannot be null. *
* * @param composition * You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, * can come from the beginning, middle, or end of the file. The Composition object contains settings for the * clips that make up an output file. For the current release, you can only specify settings for a single * clip per output file. The Composition object cannot be null. */ @Deprecated public void setComposition(java.util.Collection* You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come * from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make * up an output file. For the current release, you can only specify settings for a single clip per output file. The * Composition object cannot be null. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setComposition(java.util.Collection)} or {@link #withComposition(java.util.Collection)} if you want to * override the existing values. *
* * @param composition * You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, * can come from the beginning, middle, or end of the file. The Composition object contains settings for the * clips that make up an output file. For the current release, you can only specify settings for a single * clip per output file. The Composition object cannot be null. * @return Returns a reference to this object so that method calls can be chained together. */ @Deprecated public CreateJobOutput withComposition(Clip... composition) { if (this.composition == null) { setComposition(new com.amazonaws.internal.SdkInternalList* You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come * from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make * up an output file. For the current release, you can only specify settings for a single clip per output file. The * Composition object cannot be null. *
* * @param composition * You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, * can come from the beginning, middle, or end of the file. The Composition object contains settings for the * clips that make up an output file. For the current release, you can only specify settings for a single * clip per output file. The Composition object cannot be null. * @return Returns a reference to this object so that method calls can be chained together. */ @Deprecated public CreateJobOutput withComposition(java.util.Collection* 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. *
* * @param captions * You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All * captions must be in UTF-8. Elastic Transcoder supports two types of captions: ** Embedded: Embedded captions are included in the same file as the audio and video. Elastic * Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per * file. *
*
* Valid input values include: CEA-608 (EIA-608
, first non-empty channel only),
* CEA-708 (EIA-708
, first non-empty channel only), and mov-text
*
* Valid outputs include: mov-text
*
* Elastic Transcoder supports a maximum of one embedded format per output. *
** Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. * Sidecar captions require a player that is capable of understanding the relationship between the video file * and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of * 20 sidecar captions per file. *
*
* Valid input values include: dfxp
(first div element only), ebu-tt
,
* scc
, smpt
, srt
, ttml
(first div element only), and
* webvtt
*
* Valid outputs include: dfxp
(first div element only), scc
, srt
, and
* webvtt
.
*
* If you want ttml or smpte-tt compatible captions, specify dfxp as your output format. *
** Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a * valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not * preserve text formatting (for example, italics) during the transcoding process. *
*
* To remove captions or leave the captions empty, set Captions
to null. To pass through
* existing captions unchanged, set the MergePolicy
to MergeRetain
, and pass in a
* null CaptionSources
array.
*
* For more information on embedded files, see the Subtitles Wikipedia page. *
** For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia * pages. */ public void setCaptions(Captions captions) { this.captions = captions; } /** *
* You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All * captions must be in UTF-8. Elastic Transcoder supports two types of captions: *
** Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder * supports only one embedded caption per language, to a maximum of 300 embedded captions per file. *
*
* Valid input values include: CEA-608 (EIA-608
, first non-empty channel only),
* CEA-708 (EIA-708
, first non-empty channel only), and mov-text
*
* Valid outputs include: mov-text
*
* Elastic Transcoder supports a maximum of one embedded format per output. *
** Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar * captions require a player that is capable of understanding the relationship between the video file and the * sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar * captions per file. *
*
* Valid input values include: dfxp
(first div element only), ebu-tt
, scc
,
* smpt
, srt
, ttml
(first div element only), and webvtt
*
* Valid outputs include: dfxp
(first div element only), scc
, srt
, and
* webvtt
.
*
* If you want ttml or smpte-tt compatible captions, specify dfxp as your output format. *
** Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid * input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text * formatting (for example, italics) during the transcoding process. *
*
* To remove captions or leave the captions empty, set Captions
to null. To pass through existing
* captions unchanged, set the MergePolicy
to MergeRetain
, and pass in a null
* CaptionSources
array.
*
* For more information on embedded files, see the Subtitles Wikipedia page. *
** For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages. *
* * @return 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. */ public Captions getCaptions() { return this.captions; } /** *
* You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All * captions must be in UTF-8. Elastic Transcoder supports two types of captions: *
** Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder * supports only one embedded caption per language, to a maximum of 300 embedded captions per file. *
*
* Valid input values include: CEA-608 (EIA-608
, first non-empty channel only),
* CEA-708 (EIA-708
, first non-empty channel only), and mov-text
*
* Valid outputs include: mov-text
*
* Elastic Transcoder supports a maximum of one embedded format per output. *
** Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar * captions require a player that is capable of understanding the relationship between the video file and the * sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar * captions per file. *
*
* Valid input values include: dfxp
(first div element only), ebu-tt
, scc
,
* smpt
, srt
, ttml
(first div element only), and webvtt
*
* Valid outputs include: dfxp
(first div element only), scc
, srt
, and
* webvtt
.
*
* If you want ttml or smpte-tt compatible captions, specify dfxp as your output format. *
** Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid * input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text * formatting (for example, italics) during the transcoding process. *
*
* To remove captions or leave the captions empty, set Captions
to null. To pass through existing
* captions unchanged, set the MergePolicy
to MergeRetain
, and pass in a null
* CaptionSources
array.
*
* For more information on embedded files, see the Subtitles Wikipedia page. *
** For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages. *
* * @param captions * You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All * captions must be in UTF-8. Elastic Transcoder supports two types of captions: ** Embedded: Embedded captions are included in the same file as the audio and video. Elastic * Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per * file. *
*
* Valid input values include: CEA-608 (EIA-608
, first non-empty channel only),
* CEA-708 (EIA-708
, first non-empty channel only), and mov-text
*
* Valid outputs include: mov-text
*
* Elastic Transcoder supports a maximum of one embedded format per output. *
** Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. * Sidecar captions require a player that is capable of understanding the relationship between the video file * and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of * 20 sidecar captions per file. *
*
* Valid input values include: dfxp
(first div element only), ebu-tt
,
* scc
, smpt
, srt
, ttml
(first div element only), and
* webvtt
*
* Valid outputs include: dfxp
(first div element only), scc
, srt
, and
* webvtt
.
*
* If you want ttml or smpte-tt compatible captions, specify dfxp as your output format. *
** Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a * valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not * preserve text formatting (for example, italics) during the transcoding process. *
*
* To remove captions or leave the captions empty, set Captions
to null. To pass through
* existing captions unchanged, set the MergePolicy
to MergeRetain
, and pass in a
* null CaptionSources
array.
*
* For more information on embedded files, see the Subtitles Wikipedia page. *
** For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia * pages. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobOutput withCaptions(Captions captions) { setCaptions(captions); return this; } /** *
* 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. *
* * @param encryption * You can specify encryption settings for any output files that you want to use for a transcoding job. This * includes the output file and any watermarks, thumbnails, album art, or captions that you want to use. You * must specify encryption settings for each file individually. */ public void setEncryption(Encryption encryption) { this.encryption = encryption; } /** ** You can specify encryption settings for any output files that you want to use for a transcoding job. This * includes the output file and any watermarks, thumbnails, album art, or captions that you want to use. You must * specify encryption settings for each file individually. *
* * @return 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. */ public Encryption getEncryption() { return this.encryption; } /** ** You can specify encryption settings for any output files that you want to use for a transcoding job. This * includes the output file and any watermarks, thumbnails, album art, or captions that you want to use. You must * specify encryption settings for each file individually. *
* * @param encryption * You can specify encryption settings for any output files that you want to use for a transcoding job. This * includes the output file and any watermarks, thumbnails, album art, or captions that you want to use. You * must specify encryption settings for each file individually. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobOutput withEncryption(Encryption encryption) { setEncryption(encryption); return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getKey() != null) sb.append("Key: ").append(getKey()).append(","); if (getThumbnailPattern() != null) sb.append("ThumbnailPattern: ").append(getThumbnailPattern()).append(","); if (getThumbnailEncryption() != null) sb.append("ThumbnailEncryption: ").append(getThumbnailEncryption()).append(","); if (getRotate() != null) sb.append("Rotate: ").append(getRotate()).append(","); if (getPresetId() != null) sb.append("PresetId: ").append(getPresetId()).append(","); if (getSegmentDuration() != null) sb.append("SegmentDuration: ").append(getSegmentDuration()).append(","); if (getWatermarks() != null) sb.append("Watermarks: ").append(getWatermarks()).append(","); if (getAlbumArt() != null) sb.append("AlbumArt: ").append(getAlbumArt()).append(","); if (getComposition() != null) sb.append("Composition: ").append(getComposition()).append(","); if (getCaptions() != null) sb.append("Captions: ").append(getCaptions()).append(","); if (getEncryption() != null) sb.append("Encryption: ").append(getEncryption()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateJobOutput == false) return false; CreateJobOutput other = (CreateJobOutput) obj; if (other.getKey() == null ^ this.getKey() == null) return false; if (other.getKey() != null && other.getKey().equals(this.getKey()) == false) return false; if (other.getThumbnailPattern() == null ^ this.getThumbnailPattern() == null) return false; if (other.getThumbnailPattern() != null && other.getThumbnailPattern().equals(this.getThumbnailPattern()) == false) return false; if (other.getThumbnailEncryption() == null ^ this.getThumbnailEncryption() == null) return false; if (other.getThumbnailEncryption() != null && other.getThumbnailEncryption().equals(this.getThumbnailEncryption()) == false) return false; if (other.getRotate() == null ^ this.getRotate() == null) return false; if (other.getRotate() != null && other.getRotate().equals(this.getRotate()) == false) return false; if (other.getPresetId() == null ^ this.getPresetId() == null) return false; if (other.getPresetId() != null && other.getPresetId().equals(this.getPresetId()) == false) return false; if (other.getSegmentDuration() == null ^ this.getSegmentDuration() == null) return false; if (other.getSegmentDuration() != null && other.getSegmentDuration().equals(this.getSegmentDuration()) == false) return false; if (other.getWatermarks() == null ^ this.getWatermarks() == null) return false; if (other.getWatermarks() != null && other.getWatermarks().equals(this.getWatermarks()) == false) return false; if (other.getAlbumArt() == null ^ this.getAlbumArt() == null) return false; if (other.getAlbumArt() != null && other.getAlbumArt().equals(this.getAlbumArt()) == false) return false; if (other.getComposition() == null ^ this.getComposition() == null) return false; if (other.getComposition() != null && other.getComposition().equals(this.getComposition()) == false) return false; if (other.getCaptions() == null ^ this.getCaptions() == null) return false; if (other.getCaptions() != null && other.getCaptions().equals(this.getCaptions()) == false) return false; if (other.getEncryption() == null ^ this.getEncryption() == null) return false; if (other.getEncryption() != null && other.getEncryption().equals(this.getEncryption()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getKey() == null) ? 0 : getKey().hashCode()); hashCode = prime * hashCode + ((getThumbnailPattern() == null) ? 0 : getThumbnailPattern().hashCode()); hashCode = prime * hashCode + ((getThumbnailEncryption() == null) ? 0 : getThumbnailEncryption().hashCode()); hashCode = prime * hashCode + ((getRotate() == null) ? 0 : getRotate().hashCode()); hashCode = prime * hashCode + ((getPresetId() == null) ? 0 : getPresetId().hashCode()); hashCode = prime * hashCode + ((getSegmentDuration() == null) ? 0 : getSegmentDuration().hashCode()); hashCode = prime * hashCode + ((getWatermarks() == null) ? 0 : getWatermarks().hashCode()); hashCode = prime * hashCode + ((getAlbumArt() == null) ? 0 : getAlbumArt().hashCode()); hashCode = prime * hashCode + ((getComposition() == null) ? 0 : getComposition().hashCode()); hashCode = prime * hashCode + ((getCaptions() == null) ? 0 : getCaptions().hashCode()); hashCode = prime * hashCode + ((getEncryption() == null) ? 0 : getEncryption().hashCode()); return hashCode; } @Override public CreateJobOutput clone() { try { return (CreateJobOutput) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.elastictranscoder.model.transform.CreateJobOutputMarshaller.getInstance().marshall(this, protocolMarshaller); } }