software.amazon.awssdk.services.mediapackage.model

Class HlsPackage

java.lang.Object

software.amazon.awssdk.services.mediapackage.model.HlsPackage

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<HlsPackage.Builder,HlsPackage>

@Generated(value="software.amazon.awssdk:codegen")
public class HlsPackage
extends Object
implements StructuredPojo, ToCopyableBuilder<HlsPackage.Builder,HlsPackage>

An HTTP Live Streaming (HLS) packaging configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HlsPackage.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 HlsPackage.Builder	builder()
HlsEncryption	encryption() Returns the value of the Encryption property for this object.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	includeIframeOnlyStream() 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.
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.
Integer	segmentDurationSeconds() Duration (in seconds) of each fragment.
static Class<? extends HlsPackage.Builder>	serializableBuilderClass()
StreamSelection	streamSelection() Returns the value of the StreamSelection property for this object.
HlsPackage.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Boolean	useAudioRenditionGroup() When enabled, audio streams will be placed in rendition groups in the output.

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

adMarkers

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

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.

See Also:

AdMarkers

adMarkersAsString

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

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.

See Also:

AdMarkers

encryption

public HlsEncryption encryption()

Returns the value of the Encryption property for this object.

Returns:

The value of the Encryption property for this object.

includeIframeOnlyStream

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

playlistType

public 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 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 Integer playlistWindowSeconds()

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

Returns:

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

programDateTimeIntervalSeconds

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

segmentDurationSeconds

public Integer segmentDurationSeconds()

Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.

Returns:

Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.

streamSelection

public StreamSelection streamSelection()

Returns the value of the StreamSelection property for this object.

Returns:

The value of the StreamSelection property for this object.

useAudioRenditionGroup

public Boolean useAudioRenditionGroup()

When enabled, audio streams will be placed in rendition groups in the output.

Returns:

When enabled, audio streams will be placed in rendition groups in the output.

toBuilder

public HlsPackage.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<HlsPackage.Builder,HlsPackage>

Returns:

a builder for type T

builder

public static HlsPackage.Builder builder()

serializableBuilderClass

public static Class<? extends HlsPackage.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)

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.