com.amazonaws.services.elastictranscoder.model

Class CreateJobPlaylist

java.lang.Object

com.amazonaws.services.elastictranscoder.model.CreateJobPlaylist

All Implemented Interfaces:

Serializable

public class CreateJobPlaylist
extends Object
implements Serializable

Information about the master playlist.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateJobPlaylist()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getFormat() The format of the output playlist.
String	getName() The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8.
List<String>	getOutputKeys() For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.
int	hashCode()
void	setFormat(String format) The format of the output playlist.
void	setName(String name) 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.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateJobPlaylist	withFormat(String format) The format of the output playlist.
CreateJobPlaylist	withName(String name) The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8.
CreateJobPlaylist	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.
CreateJobPlaylist	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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateJobPlaylist

public CreateJobPlaylist()

Method Detail

getName

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

Note: 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.

Constraints:
Length: 1 - 255

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.

Note: 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.

setName

public void setName(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.

Note: 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.

Constraints:
Length: 1 - 255

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

Note: 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.

withName

public CreateJobPlaylist withName(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.

Note: 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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255

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

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

A reference to this updated object so that method calls can be chained together.

getFormat

public String getFormat()

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

Constraints:
Pattern: (^HLSv3$)|(^HLSv4$)|(^Smooth$)

Returns:

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

setFormat

public void setFormat(String format)

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

Constraints:
Pattern: (^HLSv3$)|(^HLSv4$)|(^Smooth$)

Parameters:

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

withFormat

public CreateJobPlaylist withFormat(String format)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: (^HLSv3$)|(^HLSv4$)|(^Smooth$)

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getOutputKeys

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

Constraints:
Length: 0 - 30

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.

setOutputKeys

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

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

Constraints:
Length: 0 - 30

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

withOutputKeys

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

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 30

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

Returns:

A reference to this updated object so that method calls can be chained together.

withOutputKeys

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

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 30

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object