Interface JobOutput.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<JobOutput.Builder,
,JobOutput> SdkBuilder<JobOutput.Builder,
,JobOutput> SdkPojo
- Enclosing class:
JobOutput
-
Method Summary
Modifier and TypeMethodDescriptiondefault JobOutput.Builder
albumArt
(Consumer<JobAlbumArt.Builder> albumArt) The album art to be associated with the output file, if any.albumArt
(JobAlbumArt albumArt) The album art to be associated with the output file, if any.appliedColorSpaceConversion
(String appliedColorSpaceConversion) If Elastic Transcoder used a preset with aColorSpaceConversionMode
to transcode the output file, theAppliedColorSpaceConversion
parameter shows the conversion used.default JobOutput.Builder
captions
(Consumer<Captions.Builder> captions) You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another.You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another.composition
(Collection<Clip> composition) Deprecated.composition
(Consumer<Clip.Builder>... composition) Deprecated.composition
(Clip... composition) Deprecated.Duration of the output file, in seconds.durationMillis
(Long durationMillis) Duration of the output file, in milliseconds.default JobOutput.Builder
encryption
(Consumer<Encryption.Builder> encryption) The encryption settings, if any, that you want Elastic Transcoder to apply to your output files.encryption
(Encryption encryption) 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.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.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.segmentDuration
(String segmentDuration) The status of one output in a job.statusDetail
(String statusDetail) Information that further explainsStatus
.default JobOutput.Builder
thumbnailEncryption
(Consumer<Encryption.Builder> thumbnailEncryption) The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.thumbnailEncryption
(Encryption thumbnailEncryption) The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.thumbnailPattern
(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.watermarks
(Collection<JobWatermark> watermarks) Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding.watermarks
(Consumer<JobWatermark.Builder>... watermarks) Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding.watermarks
(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.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
- 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.
-
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.- 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.
-
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.- 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.
-
-
thumbnailEncryption
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.
-
thumbnailEncryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
This is a convenience method that creates an instance of theEncryption.Builder
avoiding the need to create one manually viaEncryption.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tothumbnailEncryption(Encryption)
.- Parameters:
thumbnailEncryption
- a consumer that will call methods onEncryption.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- 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.
-
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 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.
-
segmentDuration
(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
,MPEG-DASH
, 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 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
,MPEG-DASH
, 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:
- Returns a reference to this object so that method calls can be chained together.
-
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
.
The value of
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
.
The value of
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.
-
-
statusDetail
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.
-
duration
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.
-
width
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.
-
height
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.
-
frameRate
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.
-
fileSize
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.
-
durationMillis
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.
-
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 covers the first one, the third one covers the second, and the fourth one covers 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 covers the first one, the third one covers the second, and the fourth one covers the third.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 covers the first one, the third one covers the second, and the fourth one covers 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 covers the first one, the third one covers the second, and the fourth one covers the third.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 covers the first one, the third one covers the second, and the fourth one covers the third.
This is a convenience method that creates an instance of theJobWatermark.Builder
avoiding the need to create one manually viaJobWatermark.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed towatermarks(List<JobWatermark>)
.- Parameters:
watermarks
- a consumer that will call methods onJobWatermark.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
albumArt
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.
-
albumArt
The album art to be associated with the output file, if any.
This is a convenience method that creates an instance of theJobAlbumArt.Builder
avoiding the need to create one manually viaJobAlbumArt.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toalbumArt(JobAlbumArt)
.- Parameters:
albumArt
- a consumer that will call methods onJobAlbumArt.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
composition
Deprecated.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.
-
composition
Deprecated.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.
-
composition
Deprecated.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.
This is a convenience method that creates an instance of theClip.Builder
avoiding the need to create one manually viaClip.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocomposition(List<Clip>)
.- Parameters:
composition
- a consumer that will call methods onClip.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 writes 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 writes an unencrypted file to your Amazon S3 bucket.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 writes an unencrypted file to your Amazon S3 bucket.
This is a convenience method that creates an instance of theEncryption.Builder
avoiding the need to create one manually viaEncryption.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toencryption(Encryption)
.- Parameters:
encryption
- a consumer that will call methods onEncryption.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
appliedColorSpaceConversion
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 is 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 is not be included in the job response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-