Class JobOutput
- All Implemented Interfaces:
Serializable
,Cloneable
Output
object lists information about the
first output. This duplicates the information that is listed for the first
output in the Outputs
object.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The album art to be associated with the output file, if any.If Elastic Transcoder used a preset with aColorSpaceConversionMode
to transcode the output file, theAppliedColorSpaceConversion
parameter shows the conversion used.You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another.You can create an output file that contains an excerpt from the input file.Duration of the output file, in seconds.Duration of the output file, in milliseconds.The encryption settings, if any, that you want Elastic Transcoder to apply to your output files.File size of the output file, in bytes.Frame rate of the output file, in frames per second.Height of the output file, in pixels.getId()
A sequential counter, starting with 1, that identifies an output among the outputs from the current job.getKey()
The name to assign to the transcoded file.The value of theId
object for the preset that you want to use for this job.The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input.(Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset inPresetId
for which the value ofContainer
isfmp4
(Fragmented MP4) orts
(MPEG-TS),SegmentDuration
is the target maximum duration of each segment in seconds.The status of one output in a job.Information that further explainsStatus
.The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding.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
(String appliedColorSpaceConversion) If Elastic Transcoder used a preset with aColorSpaceConversionMode
to transcode the output file, theAppliedColorSpaceConversion
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
(Collection<Clip> composition) You can create an output file that contains an excerpt from the input file.void
setDuration
(Long duration) Duration of the output file, in seconds.void
setDurationMillis
(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
(Long fileSize) File size of the output file, in bytes.void
setFrameRate
(String frameRate) Frame rate of the output file, in frames per second.void
Height of the output file, in pixels.void
A sequential counter, starting with 1, that identifies an output among the outputs from the current job.void
The name to assign to the transcoded file.void
setPresetId
(String presetId) The value of theId
object for the preset that you want to use for this job.void
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input.void
setSegmentDuration
(String segmentDuration) (Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset inPresetId
for which the value ofContainer
isfmp4
(Fragmented MP4) orts
(MPEG-TS),SegmentDuration
is the target maximum duration of each segment in seconds.void
The status of one output in a job.void
setStatusDetail
(String statusDetail) Information that further explainsStatus
.void
setThumbnailEncryption
(Encryption thumbnailEncryption) The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.void
setThumbnailPattern
(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
(Collection<JobWatermark> watermarks) Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding.void
Specifies the width of the output file in pixels.toString()
Returns a string representation of this object; useful for testing and debugging.withAlbumArt
(JobAlbumArt albumArt) The album art to be associated with the output file, if any.withAppliedColorSpaceConversion
(String appliedColorSpaceConversion) If Elastic Transcoder used a preset with aColorSpaceConversionMode
to transcode the output file, theAppliedColorSpaceConversion
parameter shows the conversion used.withCaptions
(Captions captions) You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another.withComposition
(Clip... composition) You can create an output file that contains an excerpt from the input file.withComposition
(Collection<Clip> composition) You can create an output file that contains an excerpt from the input file.withDuration
(Long duration) Duration of the output file, in seconds.withDurationMillis
(Long durationMillis) Duration of the output file, in milliseconds.withEncryption
(Encryption encryption) The encryption settings, if any, that you want Elastic Transcoder to apply to your output files.withFileSize
(Long fileSize) File size of the output file, in bytes.withFrameRate
(String frameRate) Frame rate of the output file, in frames per second.withHeight
(Integer height) Height of the output file, in pixels.A sequential counter, starting with 1, that identifies an output among the outputs from the current job.The name to assign to the transcoded file.withPresetId
(String presetId) The value of theId
object for the preset that you want to use for this job.withRotate
(String rotate) The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input.withSegmentDuration
(String segmentDuration) (Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset inPresetId
for which the value ofContainer
isfmp4
(Fragmented MP4) orts
(MPEG-TS),SegmentDuration
is the target maximum duration of each segment in seconds.withStatus
(String status) The status of one output in a job.withStatusDetail
(String statusDetail) Information that further explainsStatus
.withThumbnailEncryption
(Encryption thumbnailEncryption) The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.withThumbnailPattern
(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.withWatermarks
(JobWatermark... watermarks) Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding.withWatermarks
(Collection<JobWatermark> watermarks) Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding.Specifies the width of the output file in pixels.
-
Constructor Details
-
JobOutput
public JobOutput()
-
-
Method Details
-
setId
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.
- Parameters:
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.
-
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.
- Returns:
- 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.
-
withId
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setKey
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.- Parameters:
key
- The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by theOutputBucket
object in the pipeline that is specified by the pipeline ID.
-
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.- Returns:
- 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.
-
withKey
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.- Parameters:
key
- The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by theOutputBucket
object in the pipeline that is specified by the pipeline ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setThumbnailPattern
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 theThumbnailPattern
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 theThumbnailPattern
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 ofCreateJobOutput
. Elastic Transcoder also appends the applicable file name extension.- Parameters:
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 theThumbnailPattern
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 theThumbnailPattern
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 ofCreateJobOutput
. Elastic Transcoder also appends the applicable file name extension.-
-
-
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 theThumbnailPattern
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 theThumbnailPattern
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 ofCreateJobOutput
. Elastic Transcoder also appends the applicable file name extension.- Returns:
- 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 theThumbnailPattern
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 theThumbnailPattern
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 ofCreateJobOutput
. Elastic Transcoder also appends the applicable file name extension. -
-
-
withThumbnailPattern
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 theThumbnailPattern
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 theThumbnailPattern
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 ofCreateJobOutput
. Elastic Transcoder also appends the applicable file name extension.- Parameters:
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 theThumbnailPattern
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 theThumbnailPattern
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 ofCreateJobOutput
. Elastic Transcoder also appends the applicable file name extension.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
setThumbnailEncryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
- Parameters:
thumbnailEncryption
- The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
-
getThumbnailEncryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
- Returns:
- The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
-
withThumbnailEncryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
- Parameters:
thumbnailEncryption
- The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setRotate
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.- Parameters:
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.
-
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.- Returns:
- 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.
-
withRotate
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPresetId
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 withListPresets
.- Parameters:
presetId
- The value of theId
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 withListPresets
.
-
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 withListPresets
.- Returns:
- 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 withListPresets
.
-
withPresetId
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 withListPresets
.- Parameters:
presetId
- The value of theId
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 withListPresets
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSegmentDuration
(Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset inPresetId
for which the value ofContainer
isfmp4
(Fragmented MP4) orts
(MPEG-TS),SegmentDuration
is the target maximum duration of each segment in seconds. ForHLSv3
format playlists, each media segment is stored in a separate.ts
file. ForHLSv4
andSmooth
playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of theSegmentDuration
, 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 theOutputKeys
of the associated playlist.- Parameters:
segmentDuration
- (Outputs in Fragmented MP4 or MPEG-TS format only.If you specify a preset inPresetId
for which the value ofContainer
isfmp4
(Fragmented MP4) orts
(MPEG-TS),SegmentDuration
is the target maximum duration of each segment in seconds. ForHLSv3
format playlists, each media segment is stored in a separate.ts
file. ForHLSv4
andSmooth
playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of theSegmentDuration
, 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 theOutputKeys
-
getSegmentDuration
(Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset inPresetId
for which the value ofContainer
isfmp4
(Fragmented MP4) orts
(MPEG-TS),SegmentDuration
is the target maximum duration of each segment in seconds. ForHLSv3
format playlists, each media segment is stored in a separate.ts
file. ForHLSv4
andSmooth
playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of theSegmentDuration
, 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 theOutputKeys
of the associated playlist.- Returns:
- (Outputs in Fragmented MP4 or MPEG-TS format only.If
you specify a preset in
PresetId
for which the value ofContainer
isfmp4
(Fragmented MP4) orts
(MPEG-TS),SegmentDuration
is the target maximum duration of each segment in seconds. ForHLSv3
format playlists, each media segment is stored in a separate.ts
file. ForHLSv4
andSmooth
playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of theSegmentDuration
, 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 theOutputKeys
-
withSegmentDuration
(Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset inPresetId
for which the value ofContainer
isfmp4
(Fragmented MP4) orts
(MPEG-TS),SegmentDuration
is the target maximum duration of each segment in seconds. ForHLSv3
format playlists, each media segment is stored in a separate.ts
file. ForHLSv4
andSmooth
playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of theSegmentDuration
, 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 theOutputKeys
of the associated playlist.- Parameters:
segmentDuration
- (Outputs in Fragmented MP4 or MPEG-TS format only.If you specify a preset inPresetId
for which the value ofContainer
isfmp4
(Fragmented MP4) orts
(MPEG-TS),SegmentDuration
is the target maximum duration of each segment in seconds. ForHLSv3
format playlists, each media segment is stored in a separate.ts
file. ForHLSv4
andSmooth
playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of theSegmentDuration
, 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 theOutputKeys
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStatus
The status of one output in a job. If you specified only one output for the job,
Outputs:Status
is always the same asJob:Status
. If you specified more than one output:-
Job:Status
andOutputs:Status
for all of the outputs is Submitted until Elastic Transcoder starts to process the first output. - When Elastic Transcoder starts to process the first output,
Outputs:Status
for that output andJob:Status
both change to Progressing. For each output, the value ofOutputs:Status
remains Submitted until Elastic Transcoder starts to process the output. - Job:Status remains Progressing until all of the outputs reach a terminal status, either Complete or Error.
- When all of the outputs reach a terminal status,
Job:Status
changes to Complete only ifOutputs:Status
for all of the outputs isComplete
. IfOutputs:Status
for one or more outputs isError
, the terminal status forJob:Status
is alsoError
.
Status
is one of the following:Submitted
,Progressing
,Complete
,Canceled
, orError
.- Parameters:
status
- The status of one output in a job. If you specified only one output for the job,Outputs:Status
is always the same asJob:Status
. If you specified more than one output:-
Job:Status
andOutputs:Status
for all of the outputs is Submitted until Elastic Transcoder starts to process the first output. - When Elastic Transcoder starts to process the first output,
Outputs:Status
for that output andJob:Status
both change to Progressing. For each output, the value ofOutputs:Status
remains Submitted until Elastic Transcoder starts to process the output. - Job:Status remains Progressing until all of the outputs reach a terminal status, either Complete or Error.
- When all of the outputs reach a terminal status,
Job:Status
changes to Complete only ifOutputs:Status
for all of the outputs isComplete
. IfOutputs:Status
for one or more outputs isError
, the terminal status forJob:Status
is alsoError
.
Status
is one of the following:Submitted
,Progressing
,Complete
,Canceled
, orError
.-
-
-
getStatus
The status of one output in a job. If you specified only one output for the job,
Outputs:Status
is always the same asJob:Status
. If you specified more than one output:-
Job:Status
andOutputs:Status
for all of the outputs is Submitted until Elastic Transcoder starts to process the first output. - When Elastic Transcoder starts to process the first output,
Outputs:Status
for that output andJob:Status
both change to Progressing. For each output, the value ofOutputs:Status
remains Submitted until Elastic Transcoder starts to process the output. - Job:Status remains Progressing until all of the outputs reach a terminal status, either Complete or Error.
- When all of the outputs reach a terminal status,
Job:Status
changes to Complete only ifOutputs:Status
for all of the outputs isComplete
. IfOutputs:Status
for one or more outputs isError
, the terminal status forJob:Status
is alsoError
.
Status
is one of the following:Submitted
,Progressing
,Complete
,Canceled
, orError
.- Returns:
- The status of one output in a job. If you specified only one
output for the job,
Outputs:Status
is always the same asJob:Status
. If you specified more than one output:-
Job:Status
andOutputs:Status
for all of the outputs is Submitted until Elastic Transcoder starts to process the first output. - When Elastic Transcoder starts to process the first output,
Outputs:Status
for that output andJob:Status
both change to Progressing. For each output, the value ofOutputs:Status
remains Submitted until Elastic Transcoder starts to process the output. - Job:Status remains Progressing until all of the outputs reach a terminal status, either Complete or Error.
- When all of the outputs reach a terminal status,
Job:Status
changes to Complete only ifOutputs:Status
for all of the outputs isComplete
. IfOutputs:Status
for one or more outputs isError
, the terminal status forJob:Status
is alsoError
.
Status
is one of the following:Submitted
,Progressing
,Complete
,Canceled
, orError
. -
-
-
withStatus
The status of one output in a job. If you specified only one output for the job,
Outputs:Status
is always the same asJob:Status
. If you specified more than one output:-
Job:Status
andOutputs:Status
for all of the outputs is Submitted until Elastic Transcoder starts to process the first output. - When Elastic Transcoder starts to process the first output,
Outputs:Status
for that output andJob:Status
both change to Progressing. For each output, the value ofOutputs:Status
remains Submitted until Elastic Transcoder starts to process the output. - Job:Status remains Progressing until all of the outputs reach a terminal status, either Complete or Error.
- When all of the outputs reach a terminal status,
Job:Status
changes to Complete only ifOutputs:Status
for all of the outputs isComplete
. IfOutputs:Status
for one or more outputs isError
, the terminal status forJob:Status
is alsoError
.
Status
is one of the following:Submitted
,Progressing
,Complete
,Canceled
, orError
.- Parameters:
status
- The status of one output in a job. If you specified only one output for the job,Outputs:Status
is always the same asJob:Status
. If you specified more than one output:-
Job:Status
andOutputs:Status
for all of the outputs is Submitted until Elastic Transcoder starts to process the first output. - When Elastic Transcoder starts to process the first output,
Outputs:Status
for that output andJob:Status
both change to Progressing. For each output, the value ofOutputs:Status
remains Submitted until Elastic Transcoder starts to process the output. - Job:Status remains Progressing until all of the outputs reach a terminal status, either Complete or Error.
- When all of the outputs reach a terminal status,
Job:Status
changes to Complete only ifOutputs:Status
for all of the outputs isComplete
. IfOutputs:Status
for one or more outputs isError
, the terminal status forJob:Status
is alsoError
.
Status
is one of the following:Submitted
,Progressing
,Complete
,Canceled
, orError
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
setStatusDetail
Information that further explains
Status
.- Parameters:
statusDetail
- Information that further explainsStatus
.
-
getStatusDetail
Information that further explains
Status
.- Returns:
- Information that further explains
Status
.
-
withStatusDetail
Information that further explains
Status
.- Parameters:
statusDetail
- Information that further explainsStatus
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDuration
Duration of the output file, in seconds.
- Parameters:
duration
- Duration of the output file, in seconds.
-
getDuration
Duration of the output file, in seconds.
- Returns:
- Duration of the output file, in seconds.
-
withDuration
Duration of the output file, in seconds.
- Parameters:
duration
- Duration of the output file, in seconds.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setWidth
Specifies the width of the output file in pixels.
- Parameters:
width
- Specifies the width of the output file in pixels.
-
getWidth
Specifies the width of the output file in pixels.
- Returns:
- Specifies the width of the output file in pixels.
-
withWidth
Specifies the width of the output file in pixels.
- Parameters:
width
- Specifies the width of the output file in pixels.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setHeight
Height of the output file, in pixels.
- Parameters:
height
- Height of the output file, in pixels.
-
getHeight
Height of the output file, in pixels.
- Returns:
- Height of the output file, in pixels.
-
withHeight
Height of the output file, in pixels.
- Parameters:
height
- Height of the output file, in pixels.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setFrameRate
Frame rate of the output file, in frames per second.
- Parameters:
frameRate
- Frame rate of the output file, in frames per second.
-
getFrameRate
Frame rate of the output file, in frames per second.
- Returns:
- Frame rate of the output file, in frames per second.
-
withFrameRate
Frame rate of the output file, in frames per second.
- Parameters:
frameRate
- Frame rate of the output file, in frames per second.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setFileSize
File size of the output file, in bytes.
- Parameters:
fileSize
- File size of the output file, in bytes.
-
getFileSize
File size of the output file, in bytes.
- Returns:
- File size of the output file, in bytes.
-
withFileSize
File size of the output file, in bytes.
- Parameters:
fileSize
- File size of the output file, in bytes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDurationMillis
Duration of the output file, in milliseconds.
- Parameters:
durationMillis
- Duration of the output file, in milliseconds.
-
getDurationMillis
Duration of the output file, in milliseconds.
- Returns:
- Duration of the output file, in milliseconds.
-
withDurationMillis
Duration of the output file, in milliseconds.
- Parameters:
durationMillis
- Duration of the output file, in milliseconds.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Returns:
- 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.
-
setWatermarks
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.
- Parameters:
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 inPreset
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.
-
withWatermarks
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)
orwithWatermarks(java.util.Collection)
if you want to override the existing values.- Parameters:
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 inPreset
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withWatermarks
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.
- Parameters:
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 inPreset
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAlbumArt
The album art to be associated with the output file, if any.
- Parameters:
albumArt
- The album art to be associated with the output file, if any.
-
getAlbumArt
The album art to be associated with the output file, if any.
- Returns:
- The album art to be associated with the output file, if any.
-
withAlbumArt
The album art to be associated with the output file, if any.
- Parameters:
albumArt
- The album art to be associated with the output file, if any.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Returns:
- 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.
-
setComposition
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.
- Parameters:
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.
-
withComposition
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)
orwithComposition(java.util.Collection)
if you want to override the existing values.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withComposition
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCaptions
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), andmov-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), andwebvtt
Valid outputs include:
dfxp
(first div element only),scc
,srt
, andwebvtt
.
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 theMergePolicy
toMergeRetain
, and pass in a nullCaptionSources
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.
- Parameters:
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), andmov-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), andwebvtt
Valid outputs include:
dfxp
(first div element only),scc
,srt
, andwebvtt
.
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 theMergePolicy
toMergeRetain
, and pass in a nullCaptionSources
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.
-
-
-
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), andmov-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), andwebvtt
Valid outputs include:
dfxp
(first div element only),scc
,srt
, andwebvtt
.
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 theMergePolicy
toMergeRetain
, and pass in a nullCaptionSources
array.For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
- Returns:
- 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), andmov-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), andwebvtt
Valid outputs include:
dfxp
(first div element only),scc
,srt
, andwebvtt
.
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 theMergePolicy
toMergeRetain
, and pass in a nullCaptionSources
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.
-
-
-
withCaptions
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), andmov-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), andwebvtt
Valid outputs include:
dfxp
(first div element only),scc
,srt
, andwebvtt
.
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 theMergePolicy
toMergeRetain
, and pass in a nullCaptionSources
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.
- Parameters:
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), andmov-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), andwebvtt
Valid outputs include:
dfxp
(first div element only),scc
,srt
, andwebvtt
.
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 theMergePolicy
toMergeRetain
, and pass in a nullCaptionSources
array.For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
setEncryption
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.
- Parameters:
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.
-
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.
- Returns:
- 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.
-
withEncryption
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAppliedColorSpaceConversion
If Elastic Transcoder used a preset with a
ColorSpaceConversionMode
to transcode the output file, theAppliedColorSpaceConversion
parameter shows the conversion used. If noColorSpaceConversionMode
was defined in the preset, this parameter will not be included in the job response.- Parameters:
appliedColorSpaceConversion
- If Elastic Transcoder used a preset with aColorSpaceConversionMode
to transcode the output file, theAppliedColorSpaceConversion
parameter shows the conversion used. If noColorSpaceConversionMode
was defined in the preset, this parameter will not be included in the job response.
-
getAppliedColorSpaceConversion
If Elastic Transcoder used a preset with a
ColorSpaceConversionMode
to transcode the output file, theAppliedColorSpaceConversion
parameter shows the conversion used. If noColorSpaceConversionMode
was defined in the preset, this parameter will not be included in the job response.- Returns:
- If Elastic Transcoder used a preset with a
ColorSpaceConversionMode
to transcode the output file, theAppliedColorSpaceConversion
parameter shows the conversion used. If noColorSpaceConversionMode
was defined in the preset, this parameter will not be included in the job response.
-
withAppliedColorSpaceConversion
If Elastic Transcoder used a preset with a
ColorSpaceConversionMode
to transcode the output file, theAppliedColorSpaceConversion
parameter shows the conversion used. If noColorSpaceConversionMode
was defined in the preset, this parameter will not be included in the job response.- Parameters:
appliedColorSpaceConversion
- If Elastic Transcoder used a preset with aColorSpaceConversionMode
to transcode the output file, theAppliedColorSpaceConversion
parameter shows the conversion used. If noColorSpaceConversionMode
was defined in the preset, this parameter will not be included in the job response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-