software.amazon.awssdk.services.mediapackage.model

Class HlsPackage

java.lang.Object

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

All Implemented Interfaces:

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

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

An HTTP Live Streaming (HLS) packaging configuration.

See Also:

Serialized Form

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.
AdsOnDeliveryRestrictions	adsOnDeliveryRestrictions() Returns the value of the AdsOnDeliveryRestrictions property for this object.
String	adsOnDeliveryRestrictionsAsString() Returns the value of the AdsOnDeliveryRestrictions property for this object.
List<AdTriggersElement>	adTriggers() Returns the value of the AdTriggers property for this object.
List<String>	adTriggersAsStrings() Returns the value of the AdTriggers property for this object.
static HlsPackage.Builder	builder()
HlsEncryption	encryption() Returns the value of the Encryption property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdTriggers() Returns true if the AdTriggers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
Boolean	includeIframeOnlyStream() When enabled, an I-Frame only stream will be included in the output.
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()
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()
String	toString() Returns a string representation of this object.
Boolean	useAudioRenditionGroup() When enabled, audio streams will be placed in rendition groups in the output.

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

adTriggers

public final List<AdTriggersElement> adTriggers()

Returns the value of the AdTriggers property for this object.

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

You can use hasAdTriggers() to see if a value was sent in this field.

Returns:

The value of the AdTriggers property for this object.

hasAdTriggers

public final boolean hasAdTriggers()

Returns true if the AdTriggers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

adTriggersAsStrings

public final List<String> adTriggersAsStrings()

Returns the value of the AdTriggers property for this object.

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

You can use hasAdTriggers() to see if a value was sent in this field.

Returns:

The value of the AdTriggers property for this object.

adsOnDeliveryRestrictions

public final AdsOnDeliveryRestrictions adsOnDeliveryRestrictions()

Returns the value of the AdsOnDeliveryRestrictions property for this object.

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

Returns:

The value of the AdsOnDeliveryRestrictions property for this object.

See Also:

AdsOnDeliveryRestrictions

adsOnDeliveryRestrictionsAsString

public final String adsOnDeliveryRestrictionsAsString()

Returns the value of the AdsOnDeliveryRestrictions property for this object.

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

Returns:

The value of the AdsOnDeliveryRestrictions property for this object.

See Also:

AdsOnDeliveryRestrictions

encryption

public final HlsEncryption encryption()

Returns the value of the Encryption property for this object.

Returns:

The value of the Encryption property for this object.

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.

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.

segmentDurationSeconds

public final 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 final StreamSelection streamSelection()

Returns the value of the StreamSelection property for this object.

Returns:

The value of the StreamSelection property for this object.

useAudioRenditionGroup

public final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<HlsPackage.Builder,HlsPackage>

builder

public static HlsPackage.Builder builder()

serializableBuilderClass

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