Class Playlist
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Playlist.Builder,
Playlist>
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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Playlist.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
format()
The format of the output playlist.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the OutputKeys property.final HlsContentProtection
The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.final String
name()
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.final PlayReadyDrm
The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.static Class
<? extends Playlist.Builder> final String
status()
The status of the job with which the playlist is associated.final String
Information that further explains the status.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
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.- 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.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.
-
format
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
.
-
hasOutputKeys
public final boolean hasOutputKeys()For responses, this returns true if the service returned a value for the OutputKeys property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasOutputKeys()
method.- 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. -
-
-
hlsContentProtection
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.
-
playReadyDrm
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.
-
status
The status of the job with which the playlist is associated.
- Returns:
- The status of the job with which the playlist is associated.
-
statusDetail
Information that further explains the status.
- Returns:
- Information that further explains the status.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Playlist.Builder,
Playlist> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-