software.amazon.awssdk.services.elastictranscoder.model

Class CreateJobPlaylist

java.lang.Object

software.amazon.awssdk.services.elastictranscoder.model.CreateJobPlaylist

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CreateJobPlaylist.Builder,CreateJobPlaylist>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateJobPlaylist
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CreateJobPlaylist.Builder,CreateJobPlaylist>

Information about the master playlist.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateJobPlaylist.Builder

Method Summary

Modifier and Type	Method and Description
static CreateJobPlaylist.Builder	builder()
boolean	equals(Object obj)
String	format() The format of the output playlist.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
HlsContentProtection	hlsContentProtection() The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
String	name() 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.
PlayReadyDrm	playReadyDrm() 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 CreateJobPlaylist.Builder>	serializableBuilderClass()
CreateJobPlaylist.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public 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 all Name objects. If you create more than one master playlist, the values of all Name objects must be unique.

Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth playlists). If you include a file extension in Name, 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 all Name objects. If you create more than one master playlist, the values of all Name objects must be unique.

Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth playlists). If you include a file extension in Name, the file name will have two extensions.

format

public String format()

The format of the output playlist. Valid formats include HLSv3, HLSv4, and Smooth.

Returns:

The format of the output playlist. Valid formats include HLSv3, HLSv4, and Smooth.

outputKeys

public 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 HLS or does not have a segment duration set, the name of the output file is a concatenation of OutputKeyPrefix and Outputs:Key:

  OutputKeyPrefixOutputs: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:

  OutputKeyPrefixOutputs:Key.m3u8

  OutputKeyPrefixOutputs:Key00000.ts

• If your output is HLSv4, has a segment duration set, and is included in an HLSv4 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:

  OutputKeyPrefixOutputs:Key_v4.m3u8

  OutputKeyPrefixOutputs:Key_iframe.m3u8

  OutputKeyPrefixOutputs: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, the Audio:Profile, Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio must be the same for all outputs.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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 of OutputKeyPrefix and Outputs:Key:

  OutputKeyPrefixOutputs: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:

  OutputKeyPrefixOutputs:Key.m3u8

  OutputKeyPrefixOutputs:Key00000.ts

• If your output is HLSv4, has a segment duration set, and is included in an HLSv4 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:

  OutputKeyPrefixOutputs:Key_v4.m3u8

  OutputKeyPrefixOutputs:Key_iframe.m3u8

  OutputKeyPrefixOutputs: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, the Audio:Profile, Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio must be the same for all outputs.

hlsContentProtection

public 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 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.

toBuilder

public CreateJobPlaylist.Builder 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 interface ToCopyableBuilder<CreateJobPlaylist.Builder,CreateJobPlaylist>

Returns:

a builder for type T

builder

public static CreateJobPlaylist.Builder builder()

serializableBuilderClass

public static Class<? extends CreateJobPlaylist.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.