public class JobOutput
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Output
object lists information about the
first output. This duplicates the information that is listed for the first
output in the Outputs
object.
Modifier and Type | Field and Description |
---|---|
private JobAlbumArt |
albumArt
The album art to be associated with the output file, if any.
|
private java.lang.String |
appliedColorSpaceConversion
If Elastic Transcoder used a preset with a
ColorSpaceConversionMode to transcode the output file, the
AppliedColorSpaceConversion parameter shows the conversion
used. |
private Captions |
captions
You can configure Elastic Transcoder to transcode captions, or subtitles,
from one format to another.
|
private SdkInternalList<Clip> |
composition
You can create an output file that contains an excerpt from the input
file.
|
private java.lang.Long |
duration
Duration of the output file, in seconds.
|
private java.lang.Long |
durationMillis
Duration of the output file, in milliseconds.
|
private Encryption |
encryption
The encryption settings, if any, that you want Elastic Transcoder to
apply to your output files.
|
private java.lang.Long |
fileSize
File size of the output file, in bytes.
|
private java.lang.String |
frameRate
Frame rate of the output file, in frames per second.
|
private java.lang.Integer |
height
Height of the output file, in pixels.
|
private java.lang.String |
id
A sequential counter, starting with 1, that identifies an output among
the outputs from the current job.
|
private java.lang.String |
key
The name to assign to the transcoded file.
|
private java.lang.String |
presetId
The value of the
Id object for the preset that you want to
use for this job. |
private java.lang.String |
rotate
The number of degrees clockwise by which you want Elastic Transcoder to
rotate the output relative to the input.
|
private java.lang.String |
segmentDuration
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. |
private java.lang.String |
status
The status of one output in a job.
|
private java.lang.String |
statusDetail
Information that further explains
Status . |
private Encryption |
thumbnailEncryption
The encryption settings, if any, that you want Elastic Transcoder to
apply to your thumbnail.
|
private java.lang.String |
thumbnailPattern
Whether you want Elastic Transcoder to create thumbnails for your videos
and, if so, how you want Elastic Transcoder to name the files.
|
private SdkInternalList<JobWatermark> |
watermarks
Information about the watermarks that you want Elastic Transcoder to add
to the video during transcoding.
|
private java.lang.Integer |
width
Specifies the width of the output file in pixels.
|
Constructor and Description |
---|
JobOutput() |
Modifier and Type | Method and Description |
---|---|
JobOutput |
clone() |
boolean |
equals(java.lang.Object obj) |
JobAlbumArt |
getAlbumArt()
The album art to be associated with the output file, if any.
|
java.lang.String |
getAppliedColorSpaceConversion()
If Elastic Transcoder used a preset with a
ColorSpaceConversionMode to transcode the output file, the
AppliedColorSpaceConversion parameter shows the conversion
used. |
Captions |
getCaptions()
You can configure Elastic Transcoder to transcode captions, or subtitles,
from one format to another.
|
java.util.List<Clip> |
getComposition()
You can create an output file that contains an excerpt from the input
file.
|
java.lang.Long |
getDuration()
Duration of the output file, in seconds.
|
java.lang.Long |
getDurationMillis()
Duration of the output file, in milliseconds.
|
Encryption |
getEncryption()
The encryption settings, if any, that you want Elastic Transcoder to
apply to your output files.
|
java.lang.Long |
getFileSize()
File size of the output file, in bytes.
|
java.lang.String |
getFrameRate()
Frame rate of the output file, in frames per second.
|
java.lang.Integer |
getHeight()
Height of the output file, in pixels.
|
java.lang.String |
getId()
A sequential counter, starting with 1, that identifies an output among
the outputs from the current job.
|
java.lang.String |
getKey()
The name to assign to the transcoded file.
|
java.lang.String |
getPresetId()
The value of the
Id object for the preset that you want to
use for this job. |
java.lang.String |
getRotate()
The number of degrees clockwise by which you want Elastic Transcoder to
rotate the output relative to the input.
|
java.lang.String |
getSegmentDuration()
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. |
java.lang.String |
getStatus()
The status of one output in a job.
|
java.lang.String |
getStatusDetail()
Information that further explains
Status . |
Encryption |
getThumbnailEncryption()
The encryption settings, if any, that you want Elastic Transcoder to
apply to your thumbnail.
|
java.lang.String |
getThumbnailPattern()
Whether you want Elastic Transcoder to create thumbnails for your videos
and, if so, how you want Elastic Transcoder to name the files.
|
java.util.List<JobWatermark> |
getWatermarks()
Information about the watermarks that you want Elastic Transcoder to add
to the video during transcoding.
|
java.lang.Integer |
getWidth()
Specifies the width of the output file in pixels.
|
int |
hashCode() |
void |
setAlbumArt(JobAlbumArt albumArt)
The album art to be associated with the output file, if any.
|
void |
setAppliedColorSpaceConversion(java.lang.String appliedColorSpaceConversion)
If Elastic Transcoder used a preset with a
ColorSpaceConversionMode to transcode the output file, the
AppliedColorSpaceConversion parameter shows the conversion
used. |
void |
setCaptions(Captions captions)
You can configure Elastic Transcoder to transcode captions, or subtitles,
from one format to another.
|
void |
setComposition(java.util.Collection<Clip> composition)
You can create an output file that contains an excerpt from the input
file.
|
void |
setDuration(java.lang.Long duration)
Duration of the output file, in seconds.
|
void |
setDurationMillis(java.lang.Long durationMillis)
Duration of the output file, in milliseconds.
|
void |
setEncryption(Encryption encryption)
The encryption settings, if any, that you want Elastic Transcoder to
apply to your output files.
|
void |
setFileSize(java.lang.Long fileSize)
File size of the output file, in bytes.
|
void |
setFrameRate(java.lang.String frameRate)
Frame rate of the output file, in frames per second.
|
void |
setHeight(java.lang.Integer height)
Height of the output file, in pixels.
|
void |
setId(java.lang.String id)
A sequential counter, starting with 1, that identifies an output among
the outputs from the current job.
|
void |
setKey(java.lang.String key)
The name to assign to the transcoded file.
|
void |
setPresetId(java.lang.String presetId)
The value of the
Id object for the preset that you want to
use for this job. |
void |
setRotate(java.lang.String rotate)
The number of degrees clockwise by which you want Elastic Transcoder to
rotate the output relative to the input.
|
void |
setSegmentDuration(java.lang.String segmentDuration)
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. |
void |
setStatus(java.lang.String status)
The status of one output in a job.
|
void |
setStatusDetail(java.lang.String statusDetail)
Information that further explains
Status . |
void |
setThumbnailEncryption(Encryption thumbnailEncryption)
The encryption settings, if any, that you want Elastic Transcoder to
apply to your thumbnail.
|
void |
setThumbnailPattern(java.lang.String thumbnailPattern)
Whether you want Elastic Transcoder to create thumbnails for your videos
and, if so, how you want Elastic Transcoder to name the files.
|
void |
setWatermarks(java.util.Collection<JobWatermark> watermarks)
Information about the watermarks that you want Elastic Transcoder to add
to the video during transcoding.
|
void |
setWidth(java.lang.Integer width)
Specifies the width of the output file in pixels.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
JobOutput |
withAlbumArt(JobAlbumArt albumArt)
The album art to be associated with the output file, if any.
|
JobOutput |
withAppliedColorSpaceConversion(java.lang.String appliedColorSpaceConversion)
If Elastic Transcoder used a preset with a
ColorSpaceConversionMode to transcode the output file, the
AppliedColorSpaceConversion parameter shows the conversion
used. |
JobOutput |
withCaptions(Captions captions)
You can configure Elastic Transcoder to transcode captions, or subtitles,
from one format to another.
|
JobOutput |
withComposition(Clip... composition)
You can create an output file that contains an excerpt from the input
file.
|
JobOutput |
withComposition(java.util.Collection<Clip> composition)
You can create an output file that contains an excerpt from the input
file.
|
JobOutput |
withDuration(java.lang.Long duration)
Duration of the output file, in seconds.
|
JobOutput |
withDurationMillis(java.lang.Long durationMillis)
Duration of the output file, in milliseconds.
|
JobOutput |
withEncryption(Encryption encryption)
The encryption settings, if any, that you want Elastic Transcoder to
apply to your output files.
|
JobOutput |
withFileSize(java.lang.Long fileSize)
File size of the output file, in bytes.
|
JobOutput |
withFrameRate(java.lang.String frameRate)
Frame rate of the output file, in frames per second.
|
JobOutput |
withHeight(java.lang.Integer height)
Height of the output file, in pixels.
|
JobOutput |
withId(java.lang.String id)
A sequential counter, starting with 1, that identifies an output among
the outputs from the current job.
|
JobOutput |
withKey(java.lang.String key)
The name to assign to the transcoded file.
|
JobOutput |
withPresetId(java.lang.String presetId)
The value of the
Id object for the preset that you want to
use for this job. |
JobOutput |
withRotate(java.lang.String rotate)
The number of degrees clockwise by which you want Elastic Transcoder to
rotate the output relative to the input.
|
JobOutput |
withSegmentDuration(java.lang.String segmentDuration)
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. |
JobOutput |
withStatus(java.lang.String status)
The status of one output in a job.
|
JobOutput |
withStatusDetail(java.lang.String statusDetail)
Information that further explains
Status . |
JobOutput |
withThumbnailEncryption(Encryption thumbnailEncryption)
The encryption settings, if any, that you want Elastic Transcoder to
apply to your thumbnail.
|
JobOutput |
withThumbnailPattern(java.lang.String thumbnailPattern)
Whether you want Elastic Transcoder to create thumbnails for your videos
and, if so, how you want Elastic Transcoder to name the files.
|
JobOutput |
withWatermarks(java.util.Collection<JobWatermark> watermarks)
Information about the watermarks that you want Elastic Transcoder to add
to the video during transcoding.
|
JobOutput |
withWatermarks(JobWatermark... watermarks)
Information about the watermarks that you want Elastic Transcoder to add
to the video during transcoding.
|
JobOutput |
withWidth(java.lang.Integer width)
Specifies the width of the output file in pixels.
|
private java.lang.String id
A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1.
private java.lang.String 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.
private java.lang.String 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.
{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.
private Encryption thumbnailEncryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
private java.lang.String 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.
private java.lang.String presetId
The value of the Id
object for the preset that you want to
use for this job. The preset determines the audio, video, and thumbnail
settings that Elastic Transcoder uses for transcoding. To use a preset
that you created, specify the preset ID that Elastic Transcoder returned
in the response when you created the preset. You can also use the Elastic
Transcoder system presets, which you can get with
ListPresets
.
private java.lang.String segmentDuration
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.
private java.lang.String status
The status of one output in a job. If you specified only one output for
the job, Outputs:Status
is always the same as
Job:Status
. If you specified more than one output:
Job:Status
and Outputs:Status
for all of
the outputs is Submitted until Elastic Transcoder starts to process the
first output.Outputs:Status
for that output and Job:Status
both change to Progressing. For each output, the value of
Outputs:Status
remains Submitted until Elastic Transcoder
starts to process the output.Job:Status
changes to Complete only if
Outputs:Status
for all of the outputs is
Complete
. If Outputs:Status
for one or more
outputs is Error
, the terminal status for
Job:Status
is also Error
.Status
is one of the following:
Submitted
, Progressing
, Complete
,
Canceled
, or Error
.
private java.lang.String statusDetail
Information that further explains Status
.
private java.lang.Long duration
Duration of the output file, in seconds.
private java.lang.Integer width
Specifies the width of the output file in pixels.
private java.lang.Integer height
Height of the output file, in pixels.
private java.lang.String frameRate
Frame rate of the output file, in frames per second.
private java.lang.Long fileSize
File size of the output file, in bytes.
private java.lang.Long durationMillis
Duration of the output file, in milliseconds.
private SdkInternalList<JobWatermark> 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 that you specify in Preset
for the current output.
Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add will cover the first one, the third one will cover the second, and the fourth one will cover the third.
private JobAlbumArt albumArt
The album art to be associated with the output file, if any.
private SdkInternalList<Clip> 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.
private 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.
private Encryption encryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. If you choose to use encryption, you must specify a mode to use. If you choose not to use encryption, Elastic Transcoder will write an unencrypted file to your Amazon S3 bucket.
private java.lang.String appliedColorSpaceConversion
If Elastic Transcoder used a preset with a
ColorSpaceConversionMode
to transcode the output file, the
AppliedColorSpaceConversion
parameter shows the conversion
used. If no ColorSpaceConversionMode
was defined in the
preset, this parameter will not be included in the job response.
public void setId(java.lang.String id)
A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1.
id
- A sequential counter, starting with 1, that identifies an output
among the outputs from the current job. In the Output syntax, this
value is always 1.public java.lang.String getId()
A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1.
public JobOutput withId(java.lang.String id)
A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1.
id
- A sequential counter, starting with 1, that identifies an output
among the outputs from the current job. In the Output syntax, this
value is always 1.public void setKey(java.lang.String 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.
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.public java.lang.String getKey()
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.
OutputBucket
object in the pipeline that is
specified by the pipeline ID.public JobOutput withKey(java.lang.String 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.
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.public void setThumbnailPattern(java.lang.String 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.
{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.
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.
{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 java.lang.String getThumbnailPattern()
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.
{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.
{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 JobOutput withThumbnailPattern(java.lang.String 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.
{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.
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.
{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 setThumbnailEncryption(Encryption thumbnailEncryption)
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
thumbnailEncryption
- The encryption settings, if any, that you want Elastic Transcoder
to apply to your thumbnail.public Encryption getThumbnailEncryption()
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
public JobOutput withThumbnailEncryption(Encryption thumbnailEncryption)
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
thumbnailEncryption
- The encryption settings, if any, that you want Elastic Transcoder
to apply to your thumbnail.public void setRotate(java.lang.String 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.
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.
public java.lang.String getRotate()
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 JobOutput withRotate(java.lang.String 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.
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.
public void setPresetId(java.lang.String presetId)
The value of the Id
object for the preset that you want to
use for this job. The preset determines the audio, video, and thumbnail
settings that Elastic Transcoder uses for transcoding. To use a preset
that you created, specify the preset ID that Elastic Transcoder returned
in the response when you created the preset. You can also use the Elastic
Transcoder system presets, which you can get with
ListPresets
.
presetId
- The value of the Id
object for the preset that you
want to use for this job. The preset determines the audio, video,
and thumbnail settings that Elastic Transcoder uses for
transcoding. To use a preset that you created, specify the preset
ID that Elastic Transcoder returned in the response when you
created the preset. You can also use the Elastic Transcoder system
presets, which you can get with ListPresets
.public java.lang.String getPresetId()
The value of the Id
object for the preset that you want to
use for this job. The preset determines the audio, video, and thumbnail
settings that Elastic Transcoder uses for transcoding. To use a preset
that you created, specify the preset ID that Elastic Transcoder returned
in the response when you created the preset. You can also use the Elastic
Transcoder system presets, which you can get with
ListPresets
.
Id
object for the preset that you
want to use for this job. The preset determines the audio, video,
and thumbnail settings that Elastic Transcoder uses for
transcoding. To use a preset that you created, specify the preset
ID that Elastic Transcoder returned in the response when you
created the preset. You can also use the Elastic Transcoder
system presets, which you can get with ListPresets
.public JobOutput withPresetId(java.lang.String presetId)
The value of the Id
object for the preset that you want to
use for this job. The preset determines the audio, video, and thumbnail
settings that Elastic Transcoder uses for transcoding. To use a preset
that you created, specify the preset ID that Elastic Transcoder returned
in the response when you created the preset. You can also use the Elastic
Transcoder system presets, which you can get with
ListPresets
.
presetId
- The value of the Id
object for the preset that you
want to use for this job. The preset determines the audio, video,
and thumbnail settings that Elastic Transcoder uses for
transcoding. To use a preset that you created, specify the preset
ID that Elastic Transcoder returned in the response when you
created the preset. You can also use the Elastic Transcoder system
presets, which you can get with ListPresets
.public void setSegmentDuration(java.lang.String segmentDuration)
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.
segmentDuration
- (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
public java.lang.String getSegmentDuration()
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.
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
public JobOutput withSegmentDuration(java.lang.String segmentDuration)
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.
segmentDuration
- (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
public void setStatus(java.lang.String status)
The status of one output in a job. If you specified only one output for
the job, Outputs:Status
is always the same as
Job:Status
. If you specified more than one output:
Job:Status
and Outputs:Status
for all of
the outputs is Submitted until Elastic Transcoder starts to process the
first output.Outputs:Status
for that output and Job:Status
both change to Progressing. For each output, the value of
Outputs:Status
remains Submitted until Elastic Transcoder
starts to process the output.Job:Status
changes to Complete only if
Outputs:Status
for all of the outputs is
Complete
. If Outputs:Status
for one or more
outputs is Error
, the terminal status for
Job:Status
is also Error
.Status
is one of the following:
Submitted
, Progressing
, Complete
,
Canceled
, or Error
.
status
- The status of one output in a job. If you specified only one
output for the job, Outputs:Status
is always the same
as Job:Status
. If you specified more than one output:
Job:Status
and Outputs:Status
for
all of the outputs is Submitted until Elastic Transcoder starts to
process the first output.Outputs:Status
for that output and
Job:Status
both change to Progressing. For each
output, the value of Outputs:Status
remains Submitted
until Elastic Transcoder starts to process the output.Job:Status
changes to Complete only if
Outputs:Status
for all of the outputs is
Complete
. If Outputs:Status
for one or
more outputs is Error
, the terminal status for
Job:Status
is also Error
.Status
is one of the following:
Submitted
, Progressing
,
Complete
, Canceled
, or
Error
.public java.lang.String getStatus()
The status of one output in a job. If you specified only one output for
the job, Outputs:Status
is always the same as
Job:Status
. If you specified more than one output:
Job:Status
and Outputs:Status
for all of
the outputs is Submitted until Elastic Transcoder starts to process the
first output.Outputs:Status
for that output and Job:Status
both change to Progressing. For each output, the value of
Outputs:Status
remains Submitted until Elastic Transcoder
starts to process the output.Job:Status
changes to Complete only if
Outputs:Status
for all of the outputs is
Complete
. If Outputs:Status
for one or more
outputs is Error
, the terminal status for
Job:Status
is also Error
.Status
is one of the following:
Submitted
, Progressing
, Complete
,
Canceled
, or Error
.
Outputs:Status
is always the
same as Job:Status
. If you specified more than one
output:
Job:Status
and Outputs:Status
for
all of the outputs is Submitted until Elastic Transcoder starts
to process the first output.Outputs:Status
for that output and
Job:Status
both change to Progressing. For each
output, the value of Outputs:Status
remains
Submitted until Elastic Transcoder starts to process the output.Job:Status
changes to Complete only if
Outputs:Status
for all of the outputs is
Complete
. If Outputs:Status
for one or
more outputs is Error
, the terminal status for
Job:Status
is also Error
.Status
is one of the following:
Submitted
, Progressing
,
Complete
, Canceled
, or
Error
.public JobOutput withStatus(java.lang.String status)
The status of one output in a job. If you specified only one output for
the job, Outputs:Status
is always the same as
Job:Status
. If you specified more than one output:
Job:Status
and Outputs:Status
for all of
the outputs is Submitted until Elastic Transcoder starts to process the
first output.Outputs:Status
for that output and Job:Status
both change to Progressing. For each output, the value of
Outputs:Status
remains Submitted until Elastic Transcoder
starts to process the output.Job:Status
changes to Complete only if
Outputs:Status
for all of the outputs is
Complete
. If Outputs:Status
for one or more
outputs is Error
, the terminal status for
Job:Status
is also Error
.Status
is one of the following:
Submitted
, Progressing
, Complete
,
Canceled
, or Error
.
status
- The status of one output in a job. If you specified only one
output for the job, Outputs:Status
is always the same
as Job:Status
. If you specified more than one output:
Job:Status
and Outputs:Status
for
all of the outputs is Submitted until Elastic Transcoder starts to
process the first output.Outputs:Status
for that output and
Job:Status
both change to Progressing. For each
output, the value of Outputs:Status
remains Submitted
until Elastic Transcoder starts to process the output.Job:Status
changes to Complete only if
Outputs:Status
for all of the outputs is
Complete
. If Outputs:Status
for one or
more outputs is Error
, the terminal status for
Job:Status
is also Error
.Status
is one of the following:
Submitted
, Progressing
,
Complete
, Canceled
, or
Error
.public void setStatusDetail(java.lang.String statusDetail)
Information that further explains Status
.
statusDetail
- Information that further explains Status
.public java.lang.String getStatusDetail()
Information that further explains Status
.
Status
.public JobOutput withStatusDetail(java.lang.String statusDetail)
Information that further explains Status
.
statusDetail
- Information that further explains Status
.public void setDuration(java.lang.Long duration)
Duration of the output file, in seconds.
duration
- Duration of the output file, in seconds.public java.lang.Long getDuration()
Duration of the output file, in seconds.
public JobOutput withDuration(java.lang.Long duration)
Duration of the output file, in seconds.
duration
- Duration of the output file, in seconds.public void setWidth(java.lang.Integer width)
Specifies the width of the output file in pixels.
width
- Specifies the width of the output file in pixels.public java.lang.Integer getWidth()
Specifies the width of the output file in pixels.
public JobOutput withWidth(java.lang.Integer width)
Specifies the width of the output file in pixels.
width
- Specifies the width of the output file in pixels.public void setHeight(java.lang.Integer height)
Height of the output file, in pixels.
height
- Height of the output file, in pixels.public java.lang.Integer getHeight()
Height of the output file, in pixels.
public JobOutput withHeight(java.lang.Integer height)
Height of the output file, in pixels.
height
- Height of the output file, in pixels.public void setFrameRate(java.lang.String frameRate)
Frame rate of the output file, in frames per second.
frameRate
- Frame rate of the output file, in frames per second.public java.lang.String getFrameRate()
Frame rate of the output file, in frames per second.
public JobOutput withFrameRate(java.lang.String frameRate)
Frame rate of the output file, in frames per second.
frameRate
- Frame rate of the output file, in frames per second.public void setFileSize(java.lang.Long fileSize)
File size of the output file, in bytes.
fileSize
- File size of the output file, in bytes.public java.lang.Long getFileSize()
File size of the output file, in bytes.
public JobOutput withFileSize(java.lang.Long fileSize)
File size of the output file, in bytes.
fileSize
- File size of the output file, in bytes.public void setDurationMillis(java.lang.Long durationMillis)
Duration of the output file, in milliseconds.
durationMillis
- Duration of the output file, in milliseconds.public java.lang.Long getDurationMillis()
Duration of the output file, in milliseconds.
public JobOutput withDurationMillis(java.lang.Long durationMillis)
Duration of the output file, in milliseconds.
durationMillis
- Duration of the output file, in milliseconds.public java.util.List<JobWatermark> getWatermarks()
Information about the watermarks that you want Elastic Transcoder to add
to the video during transcoding. You can specify up to four watermarks
for each output. Settings for each watermark must be defined in the
preset that you specify in Preset
for the current output.
Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add will cover the first one, the third one will cover the second, and the fourth one will cover the third.
Preset
for the current output.
Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add will cover the first one, the third one will cover the second, and the fourth one will cover the third.
public void setWatermarks(java.util.Collection<JobWatermark> 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 that you specify in Preset
for the current output.
Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add will cover the first one, the third one will cover the second, and the fourth one will cover the third.
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 that you specify in Preset
for
the current output.
Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add will cover the first one, the third one will cover the second, and the fourth one will cover the third.
public JobOutput withWatermarks(JobWatermark... 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 that you specify in Preset
for the current output.
Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add will cover the first one, the third one will cover the second, and the fourth one will cover the third.
NOTE: This method appends the values to the existing list (if
any). Use setWatermarks(java.util.Collection)
or
withWatermarks(java.util.Collection)
if you want to override the
existing values.
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 that you specify in Preset
for
the current output.
Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add will cover the first one, the third one will cover the second, and the fourth one will cover the third.
public JobOutput withWatermarks(java.util.Collection<JobWatermark> 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 that you specify in Preset
for the current output.
Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add will cover the first one, the third one will cover the second, and the fourth one will cover the third.
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 that you specify in Preset
for
the current output.
Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add will cover the first one, the third one will cover the second, and the fourth one will cover the third.
public void setAlbumArt(JobAlbumArt albumArt)
The album art to be associated with the output file, if any.
albumArt
- The album art to be associated with the output file, if any.public JobAlbumArt getAlbumArt()
The album art to be associated with the output file, if any.
public JobOutput withAlbumArt(JobAlbumArt albumArt)
The album art to be associated with the output file, if any.
albumArt
- The album art to be associated with the output file, if any.public java.util.List<Clip> getComposition()
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.
public void setComposition(java.util.Collection<Clip> 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.
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.public JobOutput withComposition(Clip... 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.
NOTE: This method appends the values to the existing list (if
any). Use setComposition(java.util.Collection)
or
withComposition(java.util.Collection)
if you want to override
the existing values.
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.public JobOutput withComposition(java.util.Collection<Clip> 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.
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.public void setCaptions(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.
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 Captions getCaptions()
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.
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 JobOutput withCaptions(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.
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 setEncryption(Encryption encryption)
The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. If you choose to use encryption, you must specify a mode to use. If you choose not to use encryption, Elastic Transcoder will write an unencrypted file to your Amazon S3 bucket.
encryption
- The encryption settings, if any, that you want Elastic Transcoder
to apply to your output files. If you choose to use encryption,
you must specify a mode to use. If you choose not to use
encryption, Elastic Transcoder will write an unencrypted file to
your Amazon S3 bucket.public Encryption getEncryption()
The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. If you choose to use encryption, you must specify a mode to use. If you choose not to use encryption, Elastic Transcoder will write an unencrypted file to your Amazon S3 bucket.
public JobOutput withEncryption(Encryption encryption)
The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. If you choose to use encryption, you must specify a mode to use. If you choose not to use encryption, Elastic Transcoder will write an unencrypted file to your Amazon S3 bucket.
encryption
- The encryption settings, if any, that you want Elastic Transcoder
to apply to your output files. If you choose to use encryption,
you must specify a mode to use. If you choose not to use
encryption, Elastic Transcoder will write an unencrypted file to
your Amazon S3 bucket.public void setAppliedColorSpaceConversion(java.lang.String appliedColorSpaceConversion)
If Elastic Transcoder used a preset with a
ColorSpaceConversionMode
to transcode the output file, the
AppliedColorSpaceConversion
parameter shows the conversion
used. If no ColorSpaceConversionMode
was defined in the
preset, this parameter will not be included in the job response.
appliedColorSpaceConversion
- If Elastic Transcoder used a preset with a
ColorSpaceConversionMode
to transcode the output
file, the AppliedColorSpaceConversion
parameter shows
the conversion used. If no ColorSpaceConversionMode
was defined in the preset, this parameter will not be included in
the job response.public java.lang.String getAppliedColorSpaceConversion()
If Elastic Transcoder used a preset with a
ColorSpaceConversionMode
to transcode the output file, the
AppliedColorSpaceConversion
parameter shows the conversion
used. If no ColorSpaceConversionMode
was defined in the
preset, this parameter will not be included in the job response.
ColorSpaceConversionMode
to transcode the output
file, the AppliedColorSpaceConversion
parameter
shows the conversion used. If no
ColorSpaceConversionMode
was defined in the preset,
this parameter will not be included in the job response.public JobOutput withAppliedColorSpaceConversion(java.lang.String appliedColorSpaceConversion)
If Elastic Transcoder used a preset with a
ColorSpaceConversionMode
to transcode the output file, the
AppliedColorSpaceConversion
parameter shows the conversion
used. If no ColorSpaceConversionMode
was defined in the
preset, this parameter will not be included in the job response.
appliedColorSpaceConversion
- If Elastic Transcoder used a preset with a
ColorSpaceConversionMode
to transcode the output
file, the AppliedColorSpaceConversion
parameter shows
the conversion used. If no ColorSpaceConversionMode
was defined in the preset, this parameter will not be included in
the job response.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public JobOutput clone()
clone
in class java.lang.Object