software.amazon.awssdk.services.mediapackage.model

Class HlsManifest

java.lang.Object

software.amazon.awssdk.services.mediapackage.model.HlsManifest

All Implemented Interfaces:

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

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

A HTTP Live Streaming (HLS) manifest configuration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HlsManifest.Builder

Method Summary

Modifier and Type	Method and Description
AdMarkers	adMarkers() This setting controls how ad markers are included in the packaged OriginEndpoint.
String	adMarkersAsString() This setting controls how ad markers are included in the packaged OriginEndpoint.
static HlsManifest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The ID of the manifest.
Boolean	includeIframeOnlyStream() When enabled, an I-Frame only stream will be included in the output.
String	manifestName() An optional short string appended to the end of the OriginEndpoint URL.
PlaylistType	playlistType() The HTTP Live Streaming (HLS) playlist type.
String	playlistTypeAsString() The HTTP Live Streaming (HLS) playlist type.
Integer	playlistWindowSeconds() Time window (in seconds) contained in each parent manifest.
Integer	programDateTimeIntervalSeconds() The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests.
List<SdkField<?>>	sdkFields()
static Class<? extends HlsManifest.Builder>	serializableBuilderClass()
HlsManifest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	url() The URL of the packaged OriginEndpoint for consumption.

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

adMarkers

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

If the service returns an enum value that is not available in the current SDK version, adMarkers will return AdMarkers.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from adMarkersAsString().

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

adMarkersAsString

public final String adMarkersAsString()

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.

If the service returns an enum value that is not available in the current SDK version, adMarkers will return AdMarkers.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from adMarkersAsString().

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

id

public final String id()

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.

includeIframeOnlyStream

public final Boolean includeIframeOnlyStream()

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.

manifestName

public final String manifestName()

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.

playlistType

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

If the service returns an enum value that is not available in the current SDK version, playlistType will return PlaylistType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from playlistTypeAsString().

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

playlistTypeAsString

public final String playlistTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, playlistType will return PlaylistType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from playlistTypeAsString().

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

playlistWindowSeconds

public final Integer playlistWindowSeconds()

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

Returns:

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

programDateTimeIntervalSeconds

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

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.

url

public final String url()

The URL of the packaged OriginEndpoint for consumption.

Returns:

The URL of the packaged OriginEndpoint for consumption.

toBuilder

public HlsManifest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HlsManifest.Builder,HlsManifest>

builder

public static HlsManifest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo