Class HlsManifestCreateOrUpdateParameters
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<HlsManifestCreateOrUpdateParameters.Builder,
HlsManifestCreateOrUpdateParameters>
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AdMarkers
This setting controls how ad markers are included in the packaged OriginEndpoint.final String
This setting controls how ad markers are included in the packaged OriginEndpoint.Returns the value of the AdsOnDeliveryRestrictions property for this object.final String
Returns the value of the AdsOnDeliveryRestrictions property for this object.final List
<AdTriggersElement> Returns the value of the AdTriggers property for this object.Returns the value of the AdTriggers property for this object.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AdTriggers property.final int
hashCode()
final String
id()
The ID of the manifest.final Boolean
When enabled, an I-Frame only stream will be included in the output.final String
An optional short string appended to the end of the OriginEndpoint URL.final PlaylistType
The HTTP Live Streaming (HLS) playlist type.final String
The HTTP Live Streaming (HLS) playlist type.final Integer
Time window (in seconds) contained in each parent manifest.final Integer
The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests.static Class
<? extends HlsManifestCreateOrUpdateParameters.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnAdMarkers.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromadMarkersAsString()
.- 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:
-
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 returnAdMarkers.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromadMarkersAsString()
.- 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:
-
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAdTriggers()
method.- Returns:
- The value of the AdTriggers property for this object.
-
hasAdTriggers
public final boolean hasAdTriggers()For responses, this returns true if the service returned a value for the AdTriggers property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAdTriggers()
method.- Returns:
- The value of the AdTriggers property for this object.
-
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 returnAdsOnDeliveryRestrictions.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromadsOnDeliveryRestrictionsAsString()
.- Returns:
- The value of the AdsOnDeliveryRestrictions property for this object.
- See Also:
-
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 returnAdsOnDeliveryRestrictions.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromadsOnDeliveryRestrictionsAsString()
.- Returns:
- The value of the AdsOnDeliveryRestrictions property for this object.
- See Also:
-
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
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
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
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 returnPlaylistType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplaylistTypeAsString()
.- 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:
-
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 returnPlaylistType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplaylistTypeAsString()
.- 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:
-
playlistWindowSeconds
Time window (in seconds) contained in each parent manifest.- Returns:
- Time window (in seconds) contained in each parent manifest.
-
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.
-
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 interfaceToCopyableBuilder<HlsManifestCreateOrUpdateParameters.Builder,
HlsManifestCreateOrUpdateParameters> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends HlsManifestCreateOrUpdateParameters.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-