com.amazonaws.services.mediapackage.model

Class HlsManifest

java.lang.Object

com.amazonaws.services.mediapackage.model.HlsManifest

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HlsManifest
extends Object
implements Serializable, Cloneable, StructuredPojo

A HTTP Live Streaming (HLS) manifest configuration.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
HlsManifest()

Method Summary

Modifier and Type	Method and Description
HlsManifest	clone()
boolean	equals(Object obj)
String	getAdMarkers() This setting controls how ad markers are included in the packaged OriginEndpoint.
String	getId() The ID of the manifest.
Boolean	getIncludeIframeOnlyStream() When enabled, an I-Frame only stream will be included in the output.
String	getManifestName() An optional short string appended to the end of the OriginEndpoint URL.
String	getPlaylistType() The HTTP Live Streaming (HLS) playlist type.
Integer	getPlaylistWindowSeconds() Time window (in seconds) contained in each parent manifest.
Integer	getProgramDateTimeIntervalSeconds() The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests.
String	getUrl() The URL of the packaged OriginEndpoint for consumption.
int	hashCode()
Boolean	isIncludeIframeOnlyStream() When enabled, an I-Frame only stream will be included in the output.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAdMarkers(String adMarkers) This setting controls how ad markers are included in the packaged OriginEndpoint.
void	setId(String id) The ID of the manifest.
void	setIncludeIframeOnlyStream(Boolean includeIframeOnlyStream) When enabled, an I-Frame only stream will be included in the output.
void	setManifestName(String manifestName) An optional short string appended to the end of the OriginEndpoint URL.
void	setPlaylistType(String playlistType) The HTTP Live Streaming (HLS) playlist type.
void	setPlaylistWindowSeconds(Integer playlistWindowSeconds) Time window (in seconds) contained in each parent manifest.
void	setProgramDateTimeIntervalSeconds(Integer programDateTimeIntervalSeconds) The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests.
void	setUrl(String url) The URL of the packaged OriginEndpoint for consumption.
String	toString() Returns a string representation of this object.
HlsManifest	withAdMarkers(AdMarkers adMarkers) This setting controls how ad markers are included in the packaged OriginEndpoint.
HlsManifest	withAdMarkers(String adMarkers) This setting controls how ad markers are included in the packaged OriginEndpoint.
HlsManifest	withId(String id) The ID of the manifest.
HlsManifest	withIncludeIframeOnlyStream(Boolean includeIframeOnlyStream) When enabled, an I-Frame only stream will be included in the output.
HlsManifest	withManifestName(String manifestName) An optional short string appended to the end of the OriginEndpoint URL.
HlsManifest	withPlaylistType(PlaylistType playlistType) The HTTP Live Streaming (HLS) playlist type.
HlsManifest	withPlaylistType(String playlistType) The HTTP Live Streaming (HLS) playlist type.
HlsManifest	withPlaylistWindowSeconds(Integer playlistWindowSeconds) Time window (in seconds) contained in each parent manifest.
HlsManifest	withProgramDateTimeIntervalSeconds(Integer programDateTimeIntervalSeconds) The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests.
HlsManifest	withUrl(String url) The URL of the packaged OriginEndpoint for consumption.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HlsManifest

public HlsManifest()

Method Detail

setAdMarkers

public void setAdMarkers(String adMarkers)

This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.

Parameters:

adMarkers - This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.

See Also:

AdMarkers

getAdMarkers

public String getAdMarkers()

This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.

Returns:

This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.

See Also:

AdMarkers

withAdMarkers

public HlsManifest withAdMarkers(String adMarkers)

This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.

Parameters:

adMarkers - This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.

Returns:

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

See Also:

AdMarkers

withAdMarkers

public HlsManifest withAdMarkers(AdMarkers adMarkers)

This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.

Parameters:

adMarkers - This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.

Returns:

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

See Also:

AdMarkers

setId

public void setId(String id)

The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.

Parameters:

id - The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.

getId

public String getId()

The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.

Returns:

The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.

withId

public HlsManifest withId(String id)

The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.

Parameters:

id - The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.

Returns:

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

setIncludeIframeOnlyStream

public void setIncludeIframeOnlyStream(Boolean includeIframeOnlyStream)

When enabled, an I-Frame only stream will be included in the output.

Parameters:

includeIframeOnlyStream - When enabled, an I-Frame only stream will be included in the output.

getIncludeIframeOnlyStream

public Boolean getIncludeIframeOnlyStream()

When enabled, an I-Frame only stream will be included in the output.

Returns:

When enabled, an I-Frame only stream will be included in the output.

withIncludeIframeOnlyStream

public HlsManifest withIncludeIframeOnlyStream(Boolean includeIframeOnlyStream)

When enabled, an I-Frame only stream will be included in the output.

Parameters:

includeIframeOnlyStream - When enabled, an I-Frame only stream will be included in the output.

Returns:

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

isIncludeIframeOnlyStream

public Boolean isIncludeIframeOnlyStream()

When enabled, an I-Frame only stream will be included in the output.

Returns:

When enabled, an I-Frame only stream will be included in the output.

setManifestName

public void setManifestName(String manifestName)

An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.

Parameters:

manifestName - An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.

getManifestName

public String getManifestName()

An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.

Returns:

An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.

withManifestName

public HlsManifest withManifestName(String manifestName)

An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.

Parameters:

manifestName - An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.

Returns:

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

setPlaylistType

public void setPlaylistType(String playlistType)

The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.

Parameters:

playlistType - The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.

See Also:

PlaylistType

getPlaylistType

public String getPlaylistType()

The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.

Returns:

The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.

See Also:

PlaylistType

withPlaylistType

public HlsManifest withPlaylistType(String playlistType)

The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.

Parameters:

playlistType - The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.

Returns:

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

See Also:

PlaylistType

withPlaylistType

public HlsManifest withPlaylistType(PlaylistType playlistType)

The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.

Parameters:

playlistType - The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.

Returns:

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

See Also:

PlaylistType

setPlaylistWindowSeconds

public void setPlaylistWindowSeconds(Integer playlistWindowSeconds)

Time window (in seconds) contained in each parent manifest.

Parameters:

playlistWindowSeconds - Time window (in seconds) contained in each parent manifest.

getPlaylistWindowSeconds

public Integer getPlaylistWindowSeconds()

Time window (in seconds) contained in each parent manifest.

Returns:

Time window (in seconds) contained in each parent manifest.

withPlaylistWindowSeconds

public HlsManifest withPlaylistWindowSeconds(Integer playlistWindowSeconds)

Time window (in seconds) contained in each parent manifest.

Parameters:

playlistWindowSeconds - Time window (in seconds) contained in each parent manifest.

Returns:

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

setProgramDateTimeIntervalSeconds

public void setProgramDateTimeIntervalSeconds(Integer programDateTimeIntervalSeconds)

The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.

Parameters:

programDateTimeIntervalSeconds - The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.

getProgramDateTimeIntervalSeconds

public Integer getProgramDateTimeIntervalSeconds()

The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.

Returns:

The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.

withProgramDateTimeIntervalSeconds

public HlsManifest withProgramDateTimeIntervalSeconds(Integer programDateTimeIntervalSeconds)

The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.

Parameters:

programDateTimeIntervalSeconds - The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.

Returns:

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

setUrl

public void setUrl(String url)

The URL of the packaged OriginEndpoint for consumption.

Parameters:

url - The URL of the packaged OriginEndpoint for consumption.

getUrl

public String getUrl()

The URL of the packaged OriginEndpoint for consumption.

Returns:

The URL of the packaged OriginEndpoint for consumption.

withUrl

public HlsManifest withUrl(String url)

The URL of the packaged OriginEndpoint for consumption.

Parameters:

url - The URL of the packaged OriginEndpoint for consumption.

Returns:

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

toString

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public HlsManifest clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.