Class Playlist
- java.lang.Object
-
- software.amazon.awssdk.services.elastictranscoder.model.Playlist
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Playlist.Builder,Playlist>
@Generated("software.amazon.awssdk:codegen") public final class Playlist extends Object implements SdkPojo, Serializable, 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) orts(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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePlaylist.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Playlist.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)Stringformat()The format of the output playlist.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasOutputKeys()For responses, this returns true if the service returned a value for the OutputKeys property.HlsContentProtectionhlsContentProtection()The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.Stringname()The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8.List<String>outputKeys()For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.PlayReadyDrmplayReadyDrm()The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.List<SdkField<?>>sdkFields()static Class<? extends Playlist.Builder>serializableBuilderClass()Stringstatus()The status of the job with which the playlist is associated.StringstatusDetail()Information that further explains the status.Playlist.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
name
public final String 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 allNameobjects. If you create more than one master playlist, the values of allNameobjects must be unique.Elastic Transcoder automatically appends the relevant file extension to the file name (
.m3u8forHLSv3andHLSv4playlists, and.ismand.ismcforSmoothplaylists). 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 allNameobjects. If you create more than one master playlist, the values of allNameobjects must be unique.Elastic Transcoder automatically appends the relevant file extension to the file name (
.m3u8forHLSv3andHLSv4playlists, and.ismand.ismcforSmoothplaylists). If you include a file extension inName, the file name will have two extensions.
-
format
public final String 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
public final List<String> 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
HLSor does not have a segment duration set, the name of the output file is a concatenation ofOutputKeyPrefixandOutputs:Key:OutputKeyPrefix
Outputs:Key -
If your output is
HLSv3and 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.tsfiles that include a five-digit sequential counter beginning with 00000:OutputKeyPrefix
Outputs:Key.m3u8OutputKeyPrefix
Outputs:Key00000.ts -
If your output is
HLSv4, has a segment duration set, and is included in anHLSv4playlist, 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
Smoothplaylists, theAudio:Profile,Video:Profile, andVideo:FrameRatetoVideo:KeyframesMaxDistratio 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
HLSor does not have a segment duration set, the name of the output file is a concatenation ofOutputKeyPrefixandOutputs:Key:OutputKeyPrefix
Outputs:Key -
If your output is
HLSv3and 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.tsfiles that include a five-digit sequential counter beginning with 00000:OutputKeyPrefix
Outputs:Key.m3u8OutputKeyPrefix
Outputs:Key00000.ts -
If your output is
HLSv4, has a segment duration set, and is included in anHLSv4playlist, 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
Smoothplaylists, theAudio:Profile,Video:Profile, andVideo:FrameRatetoVideo:KeyframesMaxDistratio must be the same for all outputs. -
-
-
hlsContentProtection
public final HlsContentProtection 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
public final PlayReadyDrm 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
public final String 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
public final String statusDetail()
Information that further explains the status.
- Returns:
- Information that further explains the status.
-
toBuilder
public Playlist.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Playlist.Builder,Playlist>
-
builder
public static Playlist.Builder builder()
-
serializableBuilderClass
public static Class<? extends Playlist.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String 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.
-
-