Interface HlsManifest.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<HlsManifest.Builder,HlsManifest>,SdkBuilder<HlsManifest.Builder,HlsManifest>,SdkPojo
- Enclosing class:
- HlsManifest
public static interface HlsManifest.Builder extends SdkPojo, CopyableBuilder<HlsManifest.Builder,HlsManifest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description HlsManifest.BuilderadMarkers(String adMarkers)This setting controls how ad markers are included in the packaged OriginEndpoint.HlsManifest.BuilderadMarkers(AdMarkers adMarkers)This setting controls how ad markers are included in the packaged OriginEndpoint.HlsManifest.BuilderadsOnDeliveryRestrictions(String adsOnDeliveryRestrictions)Sets the value of the AdsOnDeliveryRestrictions property for this object.HlsManifest.BuilderadsOnDeliveryRestrictions(AdsOnDeliveryRestrictions adsOnDeliveryRestrictions)Sets the value of the AdsOnDeliveryRestrictions property for this object.HlsManifest.BuilderadTriggers(Collection<AdTriggersElement> adTriggers)Sets the value of the AdTriggers property for this object.HlsManifest.BuilderadTriggers(AdTriggersElement... adTriggers)Sets the value of the AdTriggers property for this object.HlsManifest.BuilderadTriggersWithStrings(String... adTriggers)Sets the value of the AdTriggers property for this object.HlsManifest.BuilderadTriggersWithStrings(Collection<String> adTriggers)Sets the value of the AdTriggers property for this object.HlsManifest.Builderid(String id)The ID of the manifest.HlsManifest.BuilderincludeIframeOnlyStream(Boolean includeIframeOnlyStream)When enabled, an I-Frame only stream will be included in the output.HlsManifest.BuildermanifestName(String manifestName)An optional short string appended to the end of the OriginEndpoint URL.HlsManifest.BuilderplaylistType(String playlistType)The HTTP Live Streaming (HLS) playlist type.HlsManifest.BuilderplaylistType(PlaylistType playlistType)The HTTP Live Streaming (HLS) playlist type.HlsManifest.BuilderplaylistWindowSeconds(Integer playlistWindowSeconds)Time window (in seconds) contained in each parent manifest.HlsManifest.BuilderprogramDateTimeIntervalSeconds(Integer programDateTimeIntervalSeconds)The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests.HlsManifest.Builderurl(String url)The URL of the packaged OriginEndpoint for consumption.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
adMarkers
HlsManifest.Builder adMarkers(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,AdMarkers
-
adMarkers
HlsManifest.Builder adMarkers(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,AdMarkers
-
id
HlsManifest.Builder id(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.
-
includeIframeOnlyStream
HlsManifest.Builder includeIframeOnlyStream(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.
-
manifestName
HlsManifest.Builder manifestName(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.
-
playlistType
HlsManifest.Builder playlistType(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,PlaylistType
-
playlistType
HlsManifest.Builder playlistType(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,PlaylistType
-
playlistWindowSeconds
HlsManifest.Builder playlistWindowSeconds(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.
-
programDateTimeIntervalSeconds
HlsManifest.Builder programDateTimeIntervalSeconds(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.
-
url
HlsManifest.Builder url(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.
-
adTriggersWithStrings
HlsManifest.Builder adTriggersWithStrings(Collection<String> adTriggers)
Sets the value of the AdTriggers property for this object.- Parameters:
adTriggers- The new value for the AdTriggers property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
adTriggersWithStrings
HlsManifest.Builder adTriggersWithStrings(String... adTriggers)
Sets the value of the AdTriggers property for this object.- Parameters:
adTriggers- The new value for the AdTriggers property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
adTriggers
HlsManifest.Builder adTriggers(Collection<AdTriggersElement> adTriggers)
Sets the value of the AdTriggers property for this object.- Parameters:
adTriggers- The new value for the AdTriggers property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
adTriggers
HlsManifest.Builder adTriggers(AdTriggersElement... adTriggers)
Sets the value of the AdTriggers property for this object.- Parameters:
adTriggers- The new value for the AdTriggers property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
adsOnDeliveryRestrictions
HlsManifest.Builder adsOnDeliveryRestrictions(String adsOnDeliveryRestrictions)
Sets the value of the AdsOnDeliveryRestrictions property for this object.- Parameters:
adsOnDeliveryRestrictions- The new value for the AdsOnDeliveryRestrictions property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AdsOnDeliveryRestrictions,AdsOnDeliveryRestrictions
-
adsOnDeliveryRestrictions
HlsManifest.Builder adsOnDeliveryRestrictions(AdsOnDeliveryRestrictions adsOnDeliveryRestrictions)
Sets the value of the AdsOnDeliveryRestrictions property for this object.- Parameters:
adsOnDeliveryRestrictions- The new value for the AdsOnDeliveryRestrictions property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AdsOnDeliveryRestrictions,AdsOnDeliveryRestrictions
-
-