Interface CreateJobOutput.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<CreateJobOutput.Builder,
,CreateJobOutput> SdkBuilder<CreateJobOutput.Builder,
,CreateJobOutput> SdkPojo
- Enclosing class:
CreateJobOutput
-
Method Summary
Modifier and TypeMethodDescriptiondefault CreateJobOutput.Builder
albumArt
(Consumer<JobAlbumArt.Builder> albumArt) Information about the album art that you want Elastic Transcoder to add to the file during transcoding.albumArt
(JobAlbumArt albumArt) Information about the album art that you want Elastic Transcoder to add to the file during transcoding.default CreateJobOutput.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.default CreateJobOutput.Builder
encryption
(Consumer<Encryption.Builder> encryption) You can specify encryption settings for any output files that you want to use for a transcoding job.encryption
(Encryption encryption) You can specify encryption settings for any output files that you want to use for a transcoding job.The name to assign to the transcoded file.TheId
of the preset 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) default CreateJobOutput.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.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
-
key
The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the
OutputBucket
object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails.- 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. If a file with the specified name already exists in the output bucket, the job fails.- 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
default CreateJobOutput.Builder thumbnailEncryption(Consumer<Encryption.Builder> 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 valueauto
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 valueauto
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
Id
of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.- Parameters:
presetId
- TheId
of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.- 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
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
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.
-
watermarks
Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output.
- 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 for the current output.- 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 for the current output.
- 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 for the current output.- 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 for the current output.
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
Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output.
- Parameters:
albumArt
- Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
albumArt
Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output.
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
You can specify encryption settings for any output files that you want to use for a transcoding job. This includes the output file and any watermarks, thumbnails, album art, or captions that you want to use. You must specify encryption settings for each file individually.
- Parameters:
encryption
- You can specify encryption settings for any output files that you want to use for a transcoding job. This includes the output file and any watermarks, thumbnails, album art, or captions that you want to use. You must specify encryption settings for each file individually.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryption
You can specify encryption settings for any output files that you want to use for a transcoding job. This includes the output file and any watermarks, thumbnails, album art, or captions that you want to use. You must specify encryption settings for each file individually.
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:
-