Package software.amazon.awscdk.services.medialive.alpha

Class HlsOutputGroupProps.Builder

java.lang.Object

software.amazon.awscdk.services.medialive.alpha.HlsOutputGroupProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HlsOutputGroupProps>

Enclosing interface:

HlsOutputGroupProps

@Stability(Experimental)
public static final class HlsOutputGroupProps.Builder
extends Object
implements software.amazon.jsii.Builder<HlsOutputGroupProps>

A builder for HlsOutputGroupProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HlsOutputGroupProps.Builder	adMarkers(List<? extends HlsAdMarkers> adMarkers)	Sets the value of HlsOutputGroupProps.getAdMarkers()
HlsOutputGroupProps.Builder	baseUrlContent(String baseUrlContent)	Sets the value of HlsOutputGroupProps.getBaseUrlContent()
HlsOutputGroupProps.Builder	baseUrlContent1(String baseUrlContent1)	Sets the value of HlsOutputGroupProps.getBaseUrlContent1()
HlsOutputGroupProps.Builder	baseUrlManifest(String baseUrlManifest)	Sets the value of HlsOutputGroupProps.getBaseUrlManifest()
HlsOutputGroupProps.Builder	baseUrlManifest1(String baseUrlManifest1)	Sets the value of HlsOutputGroupProps.getBaseUrlManifest1()
HlsOutputGroupProps	build()	Builds the configured instance.
HlsOutputGroupProps.Builder	captionLanguageMappings(List<? extends CaptionLanguageMapping> captionLanguageMappings)	Sets the value of HlsOutputGroupProps.getCaptionLanguageMappings()
HlsOutputGroupProps.Builder	captionLanguageSetting(HlsCaptionLanguageSetting captionLanguageSetting)	Sets the value of HlsOutputGroupProps.getCaptionLanguageSetting()
HlsOutputGroupProps.Builder	clientCache(HlsClientCache clientCache)	Sets the value of HlsOutputGroupProps.getClientCache()
HlsOutputGroupProps.Builder	codecSpecification(HlsCodecSpecification codecSpecification)	Sets the value of HlsOutputGroupProps.getCodecSpecification()
HlsOutputGroupProps.Builder	constantIv(String constantIv)	Sets the value of HlsOutputGroupProps.getConstantIv()
HlsOutputGroupProps.Builder	destinations(List<? extends OutputDestination> destinations)	Sets the value of HlsOutputGroupProps.getDestinations()
HlsOutputGroupProps.Builder	directoryStructure(HlsDirectoryStructure directoryStructure)	Sets the value of HlsOutputGroupProps.getDirectoryStructure()
HlsOutputGroupProps.Builder	discontinuityTags(HlsDiscontinuityTags discontinuityTags)	Sets the value of HlsOutputGroupProps.getDiscontinuityTags()
HlsOutputGroupProps.Builder	encryptionType(HlsEncryptionType encryptionType)	Sets the value of HlsOutputGroupProps.getEncryptionType()
HlsOutputGroupProps.Builder	hlsCdnSettings(HlsCdnSettings hlsCdnSettings)	Sets the value of HlsOutputGroupProps.getHlsCdnSettings()
HlsOutputGroupProps.Builder	hlsId3SegmentTagging(HlsId3SegmentTaggingState hlsId3SegmentTagging)	Sets the value of HlsOutputGroupProps.getHlsId3SegmentTagging()
HlsOutputGroupProps.Builder	iFrameOnlyPlaylists(HlsIFrameOnlyPlaylists iFrameOnlyPlaylists)	Sets the value of HlsOutputGroupProps.getIFrameOnlyPlaylists()
HlsOutputGroupProps.Builder	incompleteSegmentBehavior(HlsIncompleteSegmentBehavior incompleteSegmentBehavior)	Sets the value of HlsOutputGroupProps.getIncompleteSegmentBehavior()
HlsOutputGroupProps.Builder	indexNSegments(Number indexNSegments)	Sets the value of HlsOutputGroupProps.getIndexNSegments()
HlsOutputGroupProps.Builder	inputLossAction(HlsInputLossAction inputLossAction)	Sets the value of HlsOutputGroupProps.getInputLossAction()
HlsOutputGroupProps.Builder	ivInManifest(HlsIvInManifest ivInManifest)	Sets the value of HlsOutputGroupProps.getIvInManifest()
HlsOutputGroupProps.Builder	ivSource(HlsIvSource ivSource)	Sets the value of HlsOutputGroupProps.getIvSource()
HlsOutputGroupProps.Builder	keepSegments(Number keepSegments)	Sets the value of HlsOutputGroupProps.getKeepSegments()
HlsOutputGroupProps.Builder	keyFormat(String keyFormat)	Sets the value of HlsOutputGroupProps.getKeyFormat()
HlsOutputGroupProps.Builder	keyFormatVersions(String keyFormatVersions)	Sets the value of HlsOutputGroupProps.getKeyFormatVersions()
HlsOutputGroupProps.Builder	keyProviderSettings(HlsKeyProviderSettings keyProviderSettings)	Sets the value of HlsOutputGroupProps.getKeyProviderSettings()
HlsOutputGroupProps.Builder	manifestCompression(HlsManifestCompression manifestCompression)	Sets the value of HlsOutputGroupProps.getManifestCompression()
HlsOutputGroupProps.Builder	manifestDurationFormat(HlsManifestDurationFormat manifestDurationFormat)	Sets the value of HlsOutputGroupProps.getManifestDurationFormat()
HlsOutputGroupProps.Builder	minSegment(Segment minSegment)	Sets the value of HlsOutputGroupProps.getMinSegment()
HlsOutputGroupProps.Builder	mode(HlsMode mode)	Sets the value of HlsOutputGroupProps.getMode()
HlsOutputGroupProps.Builder	name(String name)	Sets the value of HlsOutputGroupProps.getName()
HlsOutputGroupProps.Builder	outputs(List<? extends HlsOutputDefinition> outputs)	Sets the value of HlsOutputGroupProps.getOutputs()
HlsOutputGroupProps.Builder	outputSelection(HlsOutputSelection outputSelection)	Sets the value of HlsOutputGroupProps.getOutputSelection()
HlsOutputGroupProps.Builder	programDateTime(HlsProgramDateTime programDateTime)	Sets the value of HlsOutputGroupProps.getProgramDateTime()
HlsOutputGroupProps.Builder	programDateTimeClock(HlsProgramDateTimeClock programDateTimeClock)	Sets the value of HlsOutputGroupProps.getProgramDateTimeClock()
HlsOutputGroupProps.Builder	programDateTimePeriod(Duration programDateTimePeriod)	Sets the value of HlsOutputGroupProps.getProgramDateTimePeriod()
HlsOutputGroupProps.Builder	redundantManifest(HlsRedundantManifest redundantManifest)	Sets the value of HlsOutputGroupProps.getRedundantManifest()
HlsOutputGroupProps.Builder	segment(Segment segment)	Sets the value of HlsOutputGroupProps.getSegment()
HlsOutputGroupProps.Builder	segmentationMode(HlsSegmentationMode segmentationMode)	Sets the value of HlsOutputGroupProps.getSegmentationMode()
HlsOutputGroupProps.Builder	segmentsPerSubdirectory(Number segmentsPerSubdirectory)	Sets the value of HlsOutputGroupProps.getSegmentsPerSubdirectory()
HlsOutputGroupProps.Builder	streamInfResolution(HlsStreamInfResolution streamInfResolution)	Sets the value of HlsOutputGroupProps.getStreamInfResolution()
HlsOutputGroupProps.Builder	timedMetadataId3Frame(HlsTimedMetadataId3Frame timedMetadataId3Frame)	Sets the value of HlsOutputGroupProps.getTimedMetadataId3Frame()
HlsOutputGroupProps.Builder	timedMetadataId3Period(Duration timedMetadataId3Period)	Sets the value of HlsOutputGroupProps.getTimedMetadataId3Period()
HlsOutputGroupProps.Builder	timestampDelta(Duration timestampDelta)	Sets the value of HlsOutputGroupProps.getTimestampDelta()
HlsOutputGroupProps.Builder	tsFileMode(HlsTsFileMode tsFileMode)	Sets the value of HlsOutputGroupProps.getTsFileMode()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

destinations

@Stability(Experimental)
public HlsOutputGroupProps.Builder destinations(List<? extends OutputDestination> destinations)

Sets the value of HlsOutputGroupProps.getDestinations()

Parameters:

destinations - The destinations for this output group — one per pipeline. This parameter is required. Array position determines the pipeline mapping:

• destinations[0] → Pipeline 0
• destinations[1] → Pipeline 1 (STANDARD channels only)

For a SINGLE_PIPELINE channel, provide exactly 1 destination. For a STANDARD channel, provide exactly 2 destinations.

Returns:

this

name

@Stability(Experimental)
public HlsOutputGroupProps.Builder name(String name)

Sets the value of HlsOutputGroupProps.getName()

Parameters:

name - The name of this output group. This parameter is required. Used as the destination reference ID. Underscores are normalised to hyphens internally.

Returns:

this

adMarkers

@Stability(Experimental)
public HlsOutputGroupProps.Builder adMarkers(List<? extends HlsAdMarkers> adMarkers)

Sets the value of HlsOutputGroupProps.getAdMarkers()

Parameters:

adMarkers - Chooses one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.

Returns:

this

baseUrlContent

@Stability(Experimental)
public HlsOutputGroupProps.Builder baseUrlContent(String baseUrlContent)

Sets the value of HlsOutputGroupProps.getBaseUrlContent()

Parameters:

baseUrlContent - A partial URI prefix that will be prepended to each output in the media .m3u8 file.

Returns:

this

baseUrlContent1

@Stability(Experimental)
public HlsOutputGroupProps.Builder baseUrlContent1(String baseUrlContent1)

Sets the value of HlsOutputGroupProps.getBaseUrlContent1()

Parameters:

baseUrlContent1 - Optional base URL content for pipeline 1 if different from pipeline 0.

Returns:

this

baseUrlManifest

@Stability(Experimental)
public HlsOutputGroupProps.Builder baseUrlManifest(String baseUrlManifest)

Sets the value of HlsOutputGroupProps.getBaseUrlManifest()

Parameters:

baseUrlManifest - A partial URI prefix that will be prepended to each output in the media .m3u8 file for the manifest.

Returns:

this

baseUrlManifest1

@Stability(Experimental)
public HlsOutputGroupProps.Builder baseUrlManifest1(String baseUrlManifest1)

Sets the value of HlsOutputGroupProps.getBaseUrlManifest1()

Parameters:

baseUrlManifest1 - Optional base URL manifest for pipeline 1 if different from pipeline 0.

Returns:

this

captionLanguageMappings

@Stability(Experimental)
public HlsOutputGroupProps.Builder captionLanguageMappings(List<? extends CaptionLanguageMapping> captionLanguageMappings)

Sets the value of HlsOutputGroupProps.getCaptionLanguageMappings()

Parameters:

captionLanguageMappings - A mapping of up to 4 captions channels to captions languages. Meaningful only if captionLanguageSetting is set to INSERT.

Returns:

this

captionLanguageSetting

@Stability(Experimental)
public HlsOutputGroupProps.Builder captionLanguageSetting(HlsCaptionLanguageSetting captionLanguageSetting)

Sets the value of HlsOutputGroupProps.getCaptionLanguageSetting()

Parameters:

captionLanguageSetting - Applies only to 608 embedded output captions.

Returns:

this

clientCache

@Stability(Experimental)
public HlsOutputGroupProps.Builder clientCache(HlsClientCache clientCache)

Sets the value of HlsOutputGroupProps.getClientCache()

Parameters:

clientCache - When set to DISABLED, sets the #EXT-X-ALLOW-CACHE:no tag in the manifest.

Returns:

this

codecSpecification

@Stability(Experimental)
public HlsOutputGroupProps.Builder codecSpecification(HlsCodecSpecification codecSpecification)

Sets the value of HlsOutputGroupProps.getCodecSpecification()

Parameters:

codecSpecification - The specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

Returns:

this

constantIv

@Stability(Experimental)
public HlsOutputGroupProps.Builder constantIv(String constantIv)

Sets the value of HlsOutputGroupProps.getConstantIv()

Parameters:

constantIv - A 128-bit, 16-byte hex value represented by a 32-character text string used as the IV for encryption. Used with encryptionType when ivSource is set to EXPLICIT.

Returns:

this

directoryStructure

@Stability(Experimental)
public HlsOutputGroupProps.Builder directoryStructure(HlsDirectoryStructure directoryStructure)

Sets the value of HlsOutputGroupProps.getDirectoryStructure()

Parameters:

directoryStructure - Places segments in subdirectories.

Returns:

this

discontinuityTags

@Stability(Experimental)
public HlsOutputGroupProps.Builder discontinuityTags(HlsDiscontinuityTags discontinuityTags)

Sets the value of HlsOutputGroupProps.getDiscontinuityTags()

Parameters:

discontinuityTags - Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests.

Returns:

this

encryptionType

@Stability(Experimental)
public HlsOutputGroupProps.Builder encryptionType(HlsEncryptionType encryptionType)

Sets the value of HlsOutputGroupProps.getEncryptionType()

Parameters:

encryptionType - Encrypts the segments with the specified encryption scheme.

Returns:

this

hlsCdnSettings

@Stability(Experimental)
public HlsOutputGroupProps.Builder hlsCdnSettings(HlsCdnSettings hlsCdnSettings)

Sets the value of HlsOutputGroupProps.getHlsCdnSettings()

Parameters:

hlsCdnSettings - Settings to configure the CDN for the HLS output.

Returns:

this

hlsId3SegmentTagging

@Stability(Experimental)
public HlsOutputGroupProps.Builder hlsId3SegmentTagging(HlsId3SegmentTaggingState hlsId3SegmentTagging)

Sets the value of HlsOutputGroupProps.getHlsId3SegmentTagging()

Parameters:

hlsId3SegmentTagging - State of HLS ID3 Segment Tagging.

Returns:

this

iFrameOnlyPlaylists

@Stability(Experimental)
public HlsOutputGroupProps.Builder iFrameOnlyPlaylists(HlsIFrameOnlyPlaylists iFrameOnlyPlaylists)

Sets the value of HlsOutputGroupProps.getIFrameOnlyPlaylists()

Parameters:

iFrameOnlyPlaylists - Whether to create an I-frame-only manifest.

Returns:

this

incompleteSegmentBehavior

@Stability(Experimental)
public HlsOutputGroupProps.Builder incompleteSegmentBehavior(HlsIncompleteSegmentBehavior incompleteSegmentBehavior)

Sets the value of HlsOutputGroupProps.getIncompleteSegmentBehavior()

Parameters:

incompleteSegmentBehavior - Specifies whether to include the final (incomplete) segment in the media output.

Returns:

this

indexNSegments

@Stability(Experimental)
public HlsOutputGroupProps.Builder indexNSegments(Number indexNSegments)

Sets the value of HlsOutputGroupProps.getIndexNSegments()

Parameters:

indexNSegments - The maximum number of segments in the media manifest (LIVE mode only).

Returns:

this

inputLossAction

@Stability(Experimental)
public HlsOutputGroupProps.Builder inputLossAction(HlsInputLossAction inputLossAction)

Sets the value of HlsOutputGroupProps.getInputLossAction()

Parameters:

inputLossAction - Action to take when the input is lost.

Returns:

this

ivInManifest

@Stability(Experimental)
public HlsOutputGroupProps.Builder ivInManifest(HlsIvInManifest ivInManifest)

Sets the value of HlsOutputGroupProps.getIvInManifest()

Parameters:

ivInManifest - Whether the IV is listed in the manifest.

Returns:

this

ivSource

@Stability(Experimental)
public HlsOutputGroupProps.Builder ivSource(HlsIvSource ivSource)

Sets the value of HlsOutputGroupProps.getIvSource()

Parameters:

ivSource - Whether the IV follows the segment number or is explicit.

Returns:

this

keepSegments

@Stability(Experimental)
public HlsOutputGroupProps.Builder keepSegments(Number keepSegments)

Sets the value of HlsOutputGroupProps.getKeepSegments()

Parameters:

keepSegments - The number of segments to retain in the destination directory (LIVE mode only).

Returns:

this

keyFormat

@Stability(Experimental)
public HlsOutputGroupProps.Builder keyFormat(String keyFormat)

Sets the value of HlsOutputGroupProps.getKeyFormat()

Parameters:

keyFormat - Specifies how the key is represented in the resource identified by the URI.

Returns:

this

keyFormatVersions

@Stability(Experimental)
public HlsOutputGroupProps.Builder keyFormatVersions(String keyFormatVersions)

Sets the value of HlsOutputGroupProps.getKeyFormatVersions()

Parameters:

keyFormatVersions - Either a single positive integer version value or a slash-delimited list of version values (1/2/3).

Returns:

this

keyProviderSettings

@Stability(Experimental)
public HlsOutputGroupProps.Builder keyProviderSettings(HlsKeyProviderSettings keyProviderSettings)

Sets the value of HlsOutputGroupProps.getKeyProviderSettings()

Parameters:

keyProviderSettings - The key provider settings for HLS encryption.

Returns:

this

manifestCompression

@Stability(Experimental)
public HlsOutputGroupProps.Builder manifestCompression(HlsManifestCompression manifestCompression)

Sets the value of HlsOutputGroupProps.getManifestCompression()

Parameters:

manifestCompression - When set to GZIP, compresses HLS playlist.

Returns:

this

manifestDurationFormat

@Stability(Experimental)
public HlsOutputGroupProps.Builder manifestDurationFormat(HlsManifestDurationFormat manifestDurationFormat)

Sets the value of HlsOutputGroupProps.getManifestDurationFormat()

Parameters:

manifestDurationFormat - Indicates whether the output manifest should use floating point or integer values for segment duration.

Returns:

this

minSegment

@Stability(Experimental)
public HlsOutputGroupProps.Builder minSegment(Segment minSegment)

Sets the value of HlsOutputGroupProps.getMinSegment()

Parameters:

minSegment - The minimum segment length. HLS supports whole-second segments only.

Returns:

this

mode

@Stability(Experimental)
public HlsOutputGroupProps.Builder mode(HlsMode mode)

Sets the value of HlsOutputGroupProps.getMode()

Parameters:

mode - The output mode — LIVE or VOD.

Returns:

this

outputs

@Stability(Experimental)
public HlsOutputGroupProps.Builder outputs(List<? extends HlsOutputDefinition> outputs)

Sets the value of HlsOutputGroupProps.getOutputs()

Parameters:

outputs - The outputs for this HLS output group.

Returns:

this

outputSelection

@Stability(Experimental)
public HlsOutputGroupProps.Builder outputSelection(HlsOutputSelection outputSelection)

Sets the value of HlsOutputGroupProps.getOutputSelection()

Parameters:

outputSelection - Controls which manifests and segments are generated.

Returns:

this

programDateTime

@Stability(Experimental)
public HlsOutputGroupProps.Builder programDateTime(HlsProgramDateTime programDateTime)

Sets the value of HlsOutputGroupProps.getProgramDateTime()

Parameters:

programDateTime - Includes or excludes the EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files.

Returns:

this

programDateTimeClock

@Stability(Experimental)
public HlsOutputGroupProps.Builder programDateTimeClock(HlsProgramDateTimeClock programDateTimeClock)

Sets the value of HlsOutputGroupProps.getProgramDateTimeClock()

Parameters:

programDateTimeClock - Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock.

Returns:

this

programDateTimePeriod

@Stability(Experimental)
public HlsOutputGroupProps.Builder programDateTimePeriod(Duration programDateTimePeriod)

Sets the value of HlsOutputGroupProps.getProgramDateTimePeriod()

Parameters:

programDateTimePeriod - The period of insertion of the EXT-X-PROGRAM-DATE-TIME entry.

Returns:

this

redundantManifest

@Stability(Experimental)
public HlsOutputGroupProps.Builder redundantManifest(HlsRedundantManifest redundantManifest)

Sets the value of HlsOutputGroupProps.getRedundantManifest()

Parameters:

redundantManifest - Whether the master manifest includes information about both pipelines.

Returns:

this

segment

@Stability(Experimental)
public HlsOutputGroupProps.Builder segment(Segment segment)

Sets the value of HlsOutputGroupProps.getSegment()

Parameters:

segment - The length of each media segment. HLS supports whole-second segments only.

Returns:

this

segmentationMode

@Stability(Experimental)
public HlsOutputGroupProps.Builder segmentationMode(HlsSegmentationMode segmentationMode)

Sets the value of HlsOutputGroupProps.getSegmentationMode()

Parameters:

segmentationMode - The segmentation mode.

Returns:

this

segmentsPerSubdirectory

@Stability(Experimental)
public HlsOutputGroupProps.Builder segmentsPerSubdirectory(Number segmentsPerSubdirectory)

Sets the value of HlsOutputGroupProps.getSegmentsPerSubdirectory()

Parameters:

segmentsPerSubdirectory - The number of segments to write to a subdirectory before starting a new one.

Returns:

this

streamInfResolution

@Stability(Experimental)
public HlsOutputGroupProps.Builder streamInfResolution(HlsStreamInfResolution streamInfResolution)

Sets the value of HlsOutputGroupProps.getStreamInfResolution()

Parameters:

streamInfResolution - Whether to include or exclude the RESOLUTION attribute for a video in the EXT-X-STREAM-INF tag.

Returns:

this

timedMetadataId3Frame

@Stability(Experimental)
public HlsOutputGroupProps.Builder timedMetadataId3Frame(HlsTimedMetadataId3Frame timedMetadataId3Frame)

Sets the value of HlsOutputGroupProps.getTimedMetadataId3Frame()

Parameters:

timedMetadataId3Frame - Indicates the ID3 frame that has the timecode.

Returns:

this

timedMetadataId3Period

@Stability(Experimental)
public HlsOutputGroupProps.Builder timedMetadataId3Period(Duration timedMetadataId3Period)

Sets the value of HlsOutputGroupProps.getTimedMetadataId3Period()

Parameters:

timedMetadataId3Period - The timed metadata interval.

Returns:

this

timestampDelta

@Stability(Experimental)
public HlsOutputGroupProps.Builder timestampDelta(Duration timestampDelta)

Sets the value of HlsOutputGroupProps.getTimestampDelta()

Parameters:

timestampDelta - Provides an extra delta offset to fine tune the timestamps.

Returns:

this

tsFileMode

@Stability(Experimental)
public HlsOutputGroupProps.Builder tsFileMode(HlsTsFileMode tsFileMode)

Sets the value of HlsOutputGroupProps.getTsFileMode()

Parameters:

tsFileMode - Whether to emit segmented files or a single file.

Returns:

this

build

@Stability(Experimental)
public HlsOutputGroupProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<HlsOutputGroupProps>

Returns:

a new instance of HlsOutputGroupProps

Throws:

NullPointerException - if any required attribute was not provided