Class Playlist
- All Implemented Interfaces:
Serializable
,Cloneable
Use Only for Fragmented MP4 or MPEG-TS Outputs. If you specify a preset for
which the value of Container is fmp4
(Fragmented MP4) or
ts
(MPEG-TS), Playlists contains information about the master
playlists that you want Elastic Transcoder to create. We recommend that you
create only one master playlist per output format. The maximum number of
master playlists in a job is 30.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The format of the output playlist.The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.getName()
The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8.For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.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.Information that further explains the status.int
hashCode()
void
The format of the output playlist.void
setHlsContentProtection
(HlsContentProtection hlsContentProtection) The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.void
The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8.void
setOutputKeys
(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.void
setPlayReadyDrm
(PlayReadyDrm playReadyDrm) The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.void
The status of the job with which the playlist is associated.void
setStatusDetail
(String statusDetail) Information that further explains the status.toString()
Returns a string representation of this object; useful for testing and debugging.withFormat
(String format) The format of the output playlist.withHlsContentProtection
(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.withOutputKeys
(String... outputKeys) For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.withOutputKeys
(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.withPlayReadyDrm
(PlayReadyDrm playReadyDrm) The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.withStatus
(String status) The status of the job with which the playlist is associated.withStatusDetail
(String statusDetail) Information that further explains the status.
-
Constructor Details
-
Playlist
public Playlist()
-
-
Method Details
-
setName
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.Note: 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.Note: 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.
-
getName
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.Note: 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:
- 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.Note: 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.
-
withName
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.Note: 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.Note: 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.
-
setFormat
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
.
-
getFormat
The format of the output playlist. Valid formats include
HLSv3
,HLSv4
, andSmooth
.- Returns:
- The format of the output playlist. Valid formats include
HLSv3
,HLSv4
, andSmooth
.
-
withFormat
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.
-
getOutputKeys
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:
- 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. -
-
-
setOutputKeys
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.-
-
-
withOutputKeys
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.NOTE: This method appends the values to the existing list (if any). Use
setOutputKeys(java.util.Collection)
orwithOutputKeys(java.util.Collection)
if you want to override the existing values.- 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.
-
-
withOutputKeys
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.
-
-
setHlsContentProtection
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.
-
getHlsContentProtection
The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
- Returns:
- The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
-
withHlsContentProtection
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.
-
setPlayReadyDrm
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.
-
getPlayReadyDrm
The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
- Returns:
- The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
-
withPlayReadyDrm
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.
-
setStatus
The status of the job with which the playlist is associated.
- Parameters:
status
- The status of the job with which the playlist is associated.
-
getStatus
The status of the job with which the playlist is associated.
- Returns:
- The status of the job with which the playlist is associated.
-
withStatus
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.
-
setStatusDetail
Information that further explains the status.
- Parameters:
statusDetail
- Information that further explains the status.
-
getStatusDetail
Information that further explains the status.
- Returns:
- Information that further explains the status.
-
withStatusDetail
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.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-