Interface Playlist.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Playlist.Builder,
,Playlist> SdkBuilder<Playlist.Builder,
,Playlist> SdkPojo
- Enclosing class:
Playlist
-
Method Summary
Modifier and TypeMethodDescriptionThe format of the output playlist.default Playlist.Builder
hlsContentProtection
(Consumer<HlsContentProtection.Builder> hlsContentProtection) The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.hlsContentProtection
(HlsContentProtection hlsContentProtection) The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8.outputKeys
(String... outputKeys) For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.outputKeys
(Collection<String> outputKeys) For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.default Playlist.Builder
playReadyDrm
(Consumer<PlayReadyDrm.Builder> playReadyDrm) The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.playReadyDrm
(PlayReadyDrm playReadyDrm) The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.The status of the job with which the playlist is associated.statusDetail
(String statusDetail) Information that further explains the status.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
-
name
The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a
/
character, the section of the name before the last/
must be identical for allName
objects. If you create more than one master playlist, the values of allName
objects must be unique.Elastic Transcoder automatically appends the relevant file extension to the file name (
.m3u8
forHLSv3
andHLSv4
playlists, and.ism
and.ismc
forSmooth
playlists). If you include a file extension inName
, the file name will have two extensions.- Parameters:
name
- The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a/
character, the section of the name before the last/
must be identical for allName
objects. If you create more than one master playlist, the values of allName
objects must be unique.Elastic Transcoder automatically appends the relevant file extension to the file name (
.m3u8
forHLSv3
andHLSv4
playlists, and.ism
and.ismc
forSmooth
playlists). If you include a file extension inName
, the file name will have two extensions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
format
The format of the output playlist. Valid formats include
HLSv3
,HLSv4
, andSmooth
.- Parameters:
format
- The format of the output playlist. Valid formats includeHLSv3
,HLSv4
, andSmooth
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputKeys
For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.
-
If your output is not
HLS
or does not have a segment duration set, the name of the output file is a concatenation ofOutputKeyPrefix
andOutputs:Key
:OutputKeyPrefix
Outputs:Key
-
If your output is
HLSv3
and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of.m3u8
, and a series of.ts
files that include a five-digit sequential counter beginning with 00000:OutputKeyPrefix
Outputs:Key
.m3u8OutputKeyPrefix
Outputs:Key
00000.ts -
If your output is
HLSv4
, has a segment duration set, and is included in anHLSv4
playlist, Elastic Transcoder creates an output playlist file with a file extension of_v4.m3u8
. If the output is video, Elastic Transcoder also creates an output file with an extension of_iframe.m3u8
:OutputKeyPrefix
Outputs:Key
_v4.m3u8OutputKeyPrefix
Outputs:Key
_iframe.m3u8OutputKeyPrefix
Outputs:Key
.ts
Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.
If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For
Smooth
playlists, theAudio:Profile
,Video:Profile
, andVideo:FrameRate
toVideo:KeyframesMaxDist
ratio must be the same for all outputs.- Parameters:
outputKeys
- For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.-
If your output is not
HLS
or does not have a segment duration set, the name of the output file is a concatenation ofOutputKeyPrefix
andOutputs:Key
:OutputKeyPrefix
Outputs:Key
-
If your output is
HLSv3
and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of.m3u8
, and a series of.ts
files that include a five-digit sequential counter beginning with 00000:OutputKeyPrefix
Outputs:Key
.m3u8OutputKeyPrefix
Outputs:Key
00000.ts -
If your output is
HLSv4
, has a segment duration set, and is included in anHLSv4
playlist, Elastic Transcoder creates an output playlist file with a file extension of_v4.m3u8
. If the output is video, Elastic Transcoder also creates an output file with an extension of_iframe.m3u8
:OutputKeyPrefix
Outputs:Key
_v4.m3u8OutputKeyPrefix
Outputs:Key
_iframe.m3u8OutputKeyPrefix
Outputs:Key
.ts
Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.
If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For
Smooth
playlists, theAudio:Profile
,Video:Profile
, andVideo:FrameRate
toVideo:KeyframesMaxDist
ratio must be the same for all outputs.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
outputKeys
For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.
-
If your output is not
HLS
or does not have a segment duration set, the name of the output file is a concatenation ofOutputKeyPrefix
andOutputs:Key
:OutputKeyPrefix
Outputs:Key
-
If your output is
HLSv3
and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of.m3u8
, and a series of.ts
files that include a five-digit sequential counter beginning with 00000:OutputKeyPrefix
Outputs:Key
.m3u8OutputKeyPrefix
Outputs:Key
00000.ts -
If your output is
HLSv4
, has a segment duration set, and is included in anHLSv4
playlist, Elastic Transcoder creates an output playlist file with a file extension of_v4.m3u8
. If the output is video, Elastic Transcoder also creates an output file with an extension of_iframe.m3u8
:OutputKeyPrefix
Outputs:Key
_v4.m3u8OutputKeyPrefix
Outputs:Key
_iframe.m3u8OutputKeyPrefix
Outputs:Key
.ts
Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.
If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For
Smooth
playlists, theAudio:Profile
,Video:Profile
, andVideo:FrameRate
toVideo:KeyframesMaxDist
ratio must be the same for all outputs.- Parameters:
outputKeys
- For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.-
If your output is not
HLS
or does not have a segment duration set, the name of the output file is a concatenation ofOutputKeyPrefix
andOutputs:Key
:OutputKeyPrefix
Outputs:Key
-
If your output is
HLSv3
and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of.m3u8
, and a series of.ts
files that include a five-digit sequential counter beginning with 00000:OutputKeyPrefix
Outputs:Key
.m3u8OutputKeyPrefix
Outputs:Key
00000.ts -
If your output is
HLSv4
, has a segment duration set, and is included in anHLSv4
playlist, Elastic Transcoder creates an output playlist file with a file extension of_v4.m3u8
. If the output is video, Elastic Transcoder also creates an output file with an extension of_iframe.m3u8
:OutputKeyPrefix
Outputs:Key
_v4.m3u8OutputKeyPrefix
Outputs:Key
_iframe.m3u8OutputKeyPrefix
Outputs:Key
.ts
Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.
If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For
Smooth
playlists, theAudio:Profile
,Video:Profile
, andVideo:FrameRate
toVideo:KeyframesMaxDist
ratio must be the same for all outputs.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
hlsContentProtection
The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
- Parameters:
hlsContentProtection
- The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hlsContentProtection
default Playlist.Builder hlsContentProtection(Consumer<HlsContentProtection.Builder> hlsContentProtection) The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
This is a convenience method that creates an instance of theHlsContentProtection.Builder
avoiding the need to create one manually viaHlsContentProtection.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohlsContentProtection(HlsContentProtection)
.- Parameters:
hlsContentProtection
- a consumer that will call methods onHlsContentProtection.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
playReadyDrm
The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
- Parameters:
playReadyDrm
- The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
playReadyDrm
The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
This is a convenience method that creates an instance of thePlayReadyDrm.Builder
avoiding the need to create one manually viaPlayReadyDrm.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toplayReadyDrm(PlayReadyDrm)
.- Parameters:
playReadyDrm
- a consumer that will call methods onPlayReadyDrm.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the job with which the playlist is associated.
- Parameters:
status
- The status of the job with which the playlist is associated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statusDetail
Information that further explains the status.
- Parameters:
statusDetail
- Information that further explains the status.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-