Class HlsGroupSettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<HlsGroupSettings.Builder,
HlsGroupSettings>
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<HlsAdMarkers> Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.final String
A partial URI prefix that will be prepended to each output in the media .m3u8 file.final String
Optional.final String
A partial URI prefix that will be prepended to each output in the media .m3u8 file.final String
Optional.static HlsGroupSettings.Builder
builder()
final List
<CaptionLanguageMapping> Mapping of up to 4 caption channels to caption languages.Applies only to 608 Embedded output captions.final String
Applies only to 608 Embedded output captions.final HlsClientCache
When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.final String
When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.final HlsCodecSpecification
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.final String
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.final String
For use with encryptionType.final OutputLocationRef
A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).final HlsDirectoryStructure
Place segments in subdirectories.final String
Place segments in subdirectories.final HlsDiscontinuityTags
Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group.final String
Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group.final HlsEncryptionType
Encrypts the segments with the given encryption scheme.final String
Encrypts the segments with the given encryption scheme.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 AdMarkers property.final boolean
For responses, this returns true if the service returned a value for the CaptionLanguageMappings property.final int
hashCode()
final HlsCdnSettings
Parameters that control interactions with the CDN.State of HLS ID3 Segment Taggingfinal String
State of HLS ID3 Segment Taggingfinal IFrameOnlyPlaylistType
DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).final String
DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline.final String
Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline.final Integer
Applies only if Mode field is LIVE.final InputLossActionForHlsOut
Parameter that control output group behavior on input loss.final String
Parameter that control output group behavior on input loss.final HlsIvInManifest
For use with encryptionType.final String
For use with encryptionType.final HlsIvSource
ivSource()
For use with encryptionType.final String
For use with encryptionType.final Integer
Applies only if Mode field is LIVE.final String
The value specifies how the key is represented in the resource identified by the URI.final String
Either a single positive integer version value or a slash delimited list of version values (1/2/3).final KeyProviderSettings
The key provider settings.final HlsManifestCompression
When set to gzip, compresses HLS playlist.final String
When set to gzip, compresses HLS playlist.Indicates whether the output manifest should use floating point or integer values for segment duration.final String
Indicates whether the output manifest should use floating point or integer values for segment duration.final Integer
Minimum length of MPEG-2 Transport Stream segments in seconds.final HlsMode
mode()
If "vod", all segments are indexed and kept permanently in the destination and manifest.final String
If "vod", all segments are indexed and kept permanently in the destination and manifest.final HlsOutputSelection
MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group.final String
MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group.final HlsProgramDateTime
Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files.final String
Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files.final HlsProgramDateTimeClock
Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock.final String
Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock.final Integer
Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.final HlsRedundantManifest
ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline.final String
ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline.final HlsSegmentationMode
useInputSegmentation has been deprecated.final String
useInputSegmentation has been deprecated.final Integer
Length of MPEG-2 Transport Stream segments to create in seconds.final Integer
Number of segments to write to a subdirectory before starting a new one.static Class
<? extends HlsGroupSettings.Builder> final HlsStreamInfResolution
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.final String
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.final HlsTimedMetadataId3Frame
Indicates ID3 frame that has the timecode.final String
Indicates ID3 frame that has the timecode.final Integer
Timed Metadata interval in seconds.final Integer
Provides an extra millisecond delta offset to fine tune the timestamps.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.final HlsTsFileMode
SEGMENTED_FILES: Emit the program as segments - multiple .ts media files.final String
SEGMENTED_FILES: Emit the program as segments - multiple .ts media files.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
adMarkers
Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.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
hasAdMarkers()
method.- Returns:
- Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
-
hasAdMarkers
public final boolean hasAdMarkers()For responses, this returns true if the service returned a value for the AdMarkers 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. -
adMarkersAsStrings
Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.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
hasAdMarkers()
method.- Returns:
- Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
-
baseUrlContent
A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.- Returns:
- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
-
baseUrlContent1
Optional. One value per output group. This field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0.- Returns:
- Optional. One value per output group. This field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0.
-
baseUrlManifest
A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.- Returns:
- A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
-
baseUrlManifest1
Optional. One value per output group. Complete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0.- Returns:
- Optional. One value per output group. Complete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0.
-
hasCaptionLanguageMappings
public final boolean hasCaptionLanguageMappings()For responses, this returns true if the service returned a value for the CaptionLanguageMappings 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. -
clientCache
When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.If the service returns an enum value that is not available in the current SDK version,
clientCache
will returnHlsClientCache.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromclientCacheAsString()
.- Returns:
- When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.
- See Also:
-
clientCacheAsString
When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.If the service returns an enum value that is not available in the current SDK version,
clientCache
will returnHlsClientCache.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromclientCacheAsString()
.- Returns:
- When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.
- See Also:
-
codecSpecification
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.If the service returns an enum value that is not available in the current SDK version,
codecSpecification
will returnHlsCodecSpecification.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcodecSpecificationAsString()
.- Returns:
- Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
- See Also:
-
codecSpecificationAsString
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.If the service returns an enum value that is not available in the current SDK version,
codecSpecification
will returnHlsCodecSpecification.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcodecSpecificationAsString()
.- Returns:
- Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
- See Also:
-
constantIv
For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.- Returns:
- For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
-
destination
A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).- Returns:
- A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
-
directoryStructure
Place segments in subdirectories.If the service returns an enum value that is not available in the current SDK version,
directoryStructure
will returnHlsDirectoryStructure.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdirectoryStructureAsString()
.- Returns:
- Place segments in subdirectories.
- See Also:
-
directoryStructureAsString
Place segments in subdirectories.If the service returns an enum value that is not available in the current SDK version,
directoryStructure
will returnHlsDirectoryStructure.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdirectoryStructureAsString()
.- Returns:
- Place segments in subdirectories.
- See Also:
-
discontinuityTags
Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group. Typically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose. Choose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags.If the service returns an enum value that is not available in the current SDK version,
discontinuityTags
will returnHlsDiscontinuityTags.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdiscontinuityTagsAsString()
.- Returns:
- Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group. Typically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose. Choose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags.
- See Also:
-
discontinuityTagsAsString
Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group. Typically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose. Choose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags.If the service returns an enum value that is not available in the current SDK version,
discontinuityTags
will returnHlsDiscontinuityTags.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdiscontinuityTagsAsString()
.- Returns:
- Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group. Typically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose. Choose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags.
- See Also:
-
encryptionType
Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.If the service returns an enum value that is not available in the current SDK version,
encryptionType
will returnHlsEncryptionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencryptionTypeAsString()
.- Returns:
- Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
- See Also:
-
encryptionTypeAsString
Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.If the service returns an enum value that is not available in the current SDK version,
encryptionType
will returnHlsEncryptionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencryptionTypeAsString()
.- Returns:
- Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
- See Also:
-
hlsCdnSettings
Parameters that control interactions with the CDN.- Returns:
- Parameters that control interactions with the CDN.
-
hlsId3SegmentTagging
State of HLS ID3 Segment TaggingIf the service returns an enum value that is not available in the current SDK version,
hlsId3SegmentTagging
will returnHlsId3SegmentTaggingState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhlsId3SegmentTaggingAsString()
.- Returns:
- State of HLS ID3 Segment Tagging
- See Also:
-
hlsId3SegmentTaggingAsString
State of HLS ID3 Segment TaggingIf the service returns an enum value that is not available in the current SDK version,
hlsId3SegmentTagging
will returnHlsId3SegmentTaggingState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhlsId3SegmentTaggingAsString()
.- Returns:
- State of HLS ID3 Segment Tagging
- See Also:
-
iFrameOnlyPlaylists
DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888"If the service returns an enum value that is not available in the current SDK version,
iFrameOnlyPlaylists
will returnIFrameOnlyPlaylistType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromiFrameOnlyPlaylistsAsString()
.- Returns:
- DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888"
- See Also:
-
iFrameOnlyPlaylistsAsString
DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888"If the service returns an enum value that is not available in the current SDK version,
iFrameOnlyPlaylists
will returnIFrameOnlyPlaylistType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromiFrameOnlyPlaylistsAsString()
.- Returns:
- DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888"
- See Also:
-
incompleteSegmentBehavior
Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline. Auto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups. Suppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior.If the service returns an enum value that is not available in the current SDK version,
incompleteSegmentBehavior
will returnHlsIncompleteSegmentBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromincompleteSegmentBehaviorAsString()
.- Returns:
- Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline. Auto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups. Suppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior.
- See Also:
-
incompleteSegmentBehaviorAsString
Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline. Auto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups. Suppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior.If the service returns an enum value that is not available in the current SDK version,
incompleteSegmentBehavior
will returnHlsIncompleteSegmentBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromincompleteSegmentBehaviorAsString()
.- Returns:
- Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline. Auto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups. Suppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior.
- See Also:
-
indexNSegments
Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be smaller than the number in the Keep Segments field.- Returns:
- Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be smaller than the number in the Keep Segments field.
-
inputLossAction
Parameter that control output group behavior on input loss.If the service returns an enum value that is not available in the current SDK version,
inputLossAction
will returnInputLossActionForHlsOut.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominputLossActionAsString()
.- Returns:
- Parameter that control output group behavior on input loss.
- See Also:
-
inputLossActionAsString
Parameter that control output group behavior on input loss.If the service returns an enum value that is not available in the current SDK version,
inputLossAction
will returnInputLossActionForHlsOut.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominputLossActionAsString()
.- Returns:
- Parameter that control output group behavior on input loss.
- See Also:
-
ivInManifest
For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest.If the service returns an enum value that is not available in the current SDK version,
ivInManifest
will returnHlsIvInManifest.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromivInManifestAsString()
.- Returns:
- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest.
- See Also:
-
ivInManifestAsString
For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest.If the service returns an enum value that is not available in the current SDK version,
ivInManifest
will returnHlsIvInManifest.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromivInManifestAsString()
.- Returns:
- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest.
- See Also:
-
ivSource
For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value.If the service returns an enum value that is not available in the current SDK version,
ivSource
will returnHlsIvSource.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromivSourceAsString()
.- Returns:
- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value.
- See Also:
-
ivSourceAsString
For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value.If the service returns an enum value that is not available in the current SDK version,
ivSource
will returnHlsIvSource.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromivSourceAsString()
.- Returns:
- For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value.
- See Also:
-
keepSegments
Applies only if Mode field is LIVE. Specifies the number of media segments to retain in the destination directory. This number should be bigger than indexNSegments (Num segments). We recommend (value = (2 x indexNsegments) + 1). If this "keep segments" number is too low, the following might happen: the player is still reading a media manifest file that lists this segment, but that segment has been removed from the destination directory (as directed by indexNSegments). This situation would result in a 404 HTTP error on the player.- Returns:
- Applies only if Mode field is LIVE. Specifies the number of media segments to retain in the destination directory. This number should be bigger than indexNSegments (Num segments). We recommend (value = (2 x indexNsegments) + 1). If this "keep segments" number is too low, the following might happen: the player is still reading a media manifest file that lists this segment, but that segment has been removed from the destination directory (as directed by indexNSegments). This situation would result in a 404 HTTP error on the player.
-
keyFormat
The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.- Returns:
- The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
-
keyFormatVersions
Either a single positive integer version value or a slash delimited list of version values (1/2/3).- Returns:
- Either a single positive integer version value or a slash delimited list of version values (1/2/3).
-
keyProviderSettings
The key provider settings.- Returns:
- The key provider settings.
-
manifestCompression
When set to gzip, compresses HLS playlist.If the service returns an enum value that is not available in the current SDK version,
manifestCompression
will returnHlsManifestCompression.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommanifestCompressionAsString()
.- Returns:
- When set to gzip, compresses HLS playlist.
- See Also:
-
manifestCompressionAsString
When set to gzip, compresses HLS playlist.If the service returns an enum value that is not available in the current SDK version,
manifestCompression
will returnHlsManifestCompression.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommanifestCompressionAsString()
.- Returns:
- When set to gzip, compresses HLS playlist.
- See Also:
-
manifestDurationFormat
Indicates whether the output manifest should use floating point or integer values for segment duration.If the service returns an enum value that is not available in the current SDK version,
manifestDurationFormat
will returnHlsManifestDurationFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommanifestDurationFormatAsString()
.- Returns:
- Indicates whether the output manifest should use floating point or integer values for segment duration.
- See Also:
-
manifestDurationFormatAsString
Indicates whether the output manifest should use floating point or integer values for segment duration.If the service returns an enum value that is not available in the current SDK version,
manifestDurationFormat
will returnHlsManifestDurationFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommanifestDurationFormatAsString()
.- Returns:
- Indicates whether the output manifest should use floating point or integer values for segment duration.
- See Also:
-
minSegmentLength
Minimum length of MPEG-2 Transport Stream segments in seconds. When set, minimum segment length is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.- Returns:
- Minimum length of MPEG-2 Transport Stream segments in seconds. When set, minimum segment length is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
-
mode
If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.If the service returns an enum value that is not available in the current SDK version,
mode
will returnHlsMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodeAsString()
.- Returns:
- If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.
- See Also:
-
modeAsString
If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.If the service returns an enum value that is not available in the current SDK version,
mode
will returnHlsMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodeAsString()
.- Returns:
- If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.
- See Also:
-
outputSelection
MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. VARIANT_MANIFESTS_AND_SEGMENTS: Generates media manifests for this output group, but not a master manifest. SEGMENTS_ONLY: Does not generate any manifests for this output group.If the service returns an enum value that is not available in the current SDK version,
outputSelection
will returnHlsOutputSelection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutputSelectionAsString()
.- Returns:
- MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. VARIANT_MANIFESTS_AND_SEGMENTS: Generates media manifests for this output group, but not a master manifest. SEGMENTS_ONLY: Does not generate any manifests for this output group.
- See Also:
-
outputSelectionAsString
MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. VARIANT_MANIFESTS_AND_SEGMENTS: Generates media manifests for this output group, but not a master manifest. SEGMENTS_ONLY: Does not generate any manifests for this output group.If the service returns an enum value that is not available in the current SDK version,
outputSelection
will returnHlsOutputSelection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutputSelectionAsString()
.- Returns:
- MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. VARIANT_MANIFESTS_AND_SEGMENTS: Generates media manifests for this output group, but not a master manifest. SEGMENTS_ONLY: Does not generate any manifests for this output group.
- See Also:
-
programDateTime
Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated using the program date time clock.If the service returns an enum value that is not available in the current SDK version,
programDateTime
will returnHlsProgramDateTime.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprogramDateTimeAsString()
.- Returns:
- Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated using the program date time clock.
- See Also:
-
programDateTimeAsString
Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated using the program date time clock.If the service returns an enum value that is not available in the current SDK version,
programDateTime
will returnHlsProgramDateTime.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprogramDateTimeAsString()
.- Returns:
- Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated using the program date time clock.
- See Also:
-
programDateTimeClock
Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. Options include: INITIALIZE_FROM_OUTPUT_TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment. SYSTEM_CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock.If the service returns an enum value that is not available in the current SDK version,
programDateTimeClock
will returnHlsProgramDateTimeClock.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprogramDateTimeClockAsString()
.- Returns:
- Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. Options include: INITIALIZE_FROM_OUTPUT_TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment. SYSTEM_CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock.
- See Also:
-
programDateTimeClockAsString
Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. Options include: INITIALIZE_FROM_OUTPUT_TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment. SYSTEM_CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock.If the service returns an enum value that is not available in the current SDK version,
programDateTimeClock
will returnHlsProgramDateTimeClock.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprogramDateTimeClockAsString()
.- Returns:
- Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. Options include: INITIALIZE_FROM_OUTPUT_TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment. SYSTEM_CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock.
- See Also:
-
programDateTimePeriod
Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.- Returns:
- Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
-
redundantManifest
ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant.If the service returns an enum value that is not available in the current SDK version,
redundantManifest
will returnHlsRedundantManifest.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromredundantManifestAsString()
.- Returns:
- ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant.
- See Also:
-
redundantManifestAsString
ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant.If the service returns an enum value that is not available in the current SDK version,
redundantManifest
will returnHlsRedundantManifest.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromredundantManifestAsString()
.- Returns:
- ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant.
- See Also:
-
segmentLength
Length of MPEG-2 Transport Stream segments to create in seconds. Note that segments will end on the next keyframe after this duration, so actual segment length may be longer.- Returns:
- Length of MPEG-2 Transport Stream segments to create in seconds. Note that segments will end on the next keyframe after this duration, so actual segment length may be longer.
-
segmentationMode
useInputSegmentation has been deprecated. The configured segment size is always used.If the service returns an enum value that is not available in the current SDK version,
segmentationMode
will returnHlsSegmentationMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsegmentationModeAsString()
.- Returns:
- useInputSegmentation has been deprecated. The configured segment size is always used.
- See Also:
-
segmentationModeAsString
useInputSegmentation has been deprecated. The configured segment size is always used.If the service returns an enum value that is not available in the current SDK version,
segmentationMode
will returnHlsSegmentationMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsegmentationModeAsString()
.- Returns:
- useInputSegmentation has been deprecated. The configured segment size is always used.
- See Also:
-
segmentsPerSubdirectory
Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.- Returns:
- Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
-
streamInfResolution
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.If the service returns an enum value that is not available in the current SDK version,
streamInfResolution
will returnHlsStreamInfResolution.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstreamInfResolutionAsString()
.- Returns:
- Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
- See Also:
-
streamInfResolutionAsString
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.If the service returns an enum value that is not available in the current SDK version,
streamInfResolution
will returnHlsStreamInfResolution.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstreamInfResolutionAsString()
.- Returns:
- Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
- See Also:
-
timedMetadataId3Frame
Indicates ID3 frame that has the timecode.If the service returns an enum value that is not available in the current SDK version,
timedMetadataId3Frame
will returnHlsTimedMetadataId3Frame.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtimedMetadataId3FrameAsString()
.- Returns:
- Indicates ID3 frame that has the timecode.
- See Also:
-
timedMetadataId3FrameAsString
Indicates ID3 frame that has the timecode.If the service returns an enum value that is not available in the current SDK version,
timedMetadataId3Frame
will returnHlsTimedMetadataId3Frame.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtimedMetadataId3FrameAsString()
.- Returns:
- Indicates ID3 frame that has the timecode.
- See Also:
-
timedMetadataId3Period
Timed Metadata interval in seconds.- Returns:
- Timed Metadata interval in seconds.
-
timestampDeltaMilliseconds
Provides an extra millisecond delta offset to fine tune the timestamps.- Returns:
- Provides an extra millisecond delta offset to fine tune the timestamps.
-
tsFileMode
SEGMENTED_FILES: Emit the program as segments - multiple .ts media files. SINGLE_FILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.If the service returns an enum value that is not available in the current SDK version,
tsFileMode
will returnHlsTsFileMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtsFileModeAsString()
.- Returns:
- SEGMENTED_FILES: Emit the program as segments - multiple .ts media files. SINGLE_FILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.
- See Also:
-
tsFileModeAsString
SEGMENTED_FILES: Emit the program as segments - multiple .ts media files. SINGLE_FILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.If the service returns an enum value that is not available in the current SDK version,
tsFileMode
will returnHlsTsFileMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtsFileModeAsString()
.- Returns:
- SEGMENTED_FILES: Emit the program as segments - multiple .ts media files. SINGLE_FILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.
- See Also:
-
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<HlsGroupSettings.Builder,
HlsGroupSettings> - Returns:
- a builder for type T
-
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
-