HlsGroupSettings (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.medialive.model.HlsGroupSettings

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<HlsGroupSettings.Builder,HlsGroupSettings>

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

Placeholder documentation for HlsGroupSettings

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface HlsGroupSettings.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`HlsGroupSettings.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<HlsAdMarkers>`	`adMarkers()` Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
`List<String>`	`adMarkersAsStrings()` Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
`String`	`baseUrlContent()` A partial URI prefix that will be prepended to each output in the media .m3u8 file.
`String`	`baseUrlManifest()` A partial URI prefix that will be prepended to each output in the media .m3u8 file.
`static HlsGroupSettings.Builder`	`builder()`
`List<CaptionLanguageMapping>`	`captionLanguageMappings()` Mapping of up to 4 caption channels to caption languages.
`HlsCaptionLanguageSetting`	`captionLanguageSetting()` Applies only to 608 Embedded output captions.
`String`	`captionLanguageSettingAsString()` Applies only to 608 Embedded output captions.
`HlsClientCache`	`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.
`String`	`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.
`HlsCodecSpecification`	`codecSpecification()` Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
`String`	`codecSpecificationAsString()` Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
`String`	`constantIv()` For use with encryptionType.
`OutputLocationRef`	`destination()` A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
`HlsDirectoryStructure`	`directoryStructure()` Place segments in subdirectories.
`String`	`directoryStructureAsString()` Place segments in subdirectories.
`HlsEncryptionType`	`encryptionType()` Encrypts the segments with the given encryption scheme.
`String`	`encryptionTypeAsString()` Encrypts the segments with the given encryption scheme.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`HlsCdnSettings`	`hlsCdnSettings()` Parameters that control interactions with the CDN.
`Integer`	`indexNSegments()` If mode is "live", the number of segments to retain in the manifest (.m3u8) file.
`InputLossActionForHlsOut`	`inputLossAction()` Parameter that control output group behavior on input loss.
`String`	`inputLossActionAsString()` Parameter that control output group behavior on input loss.
`HlsIvInManifest`	`ivInManifest()` For use with encryptionType.
`String`	`ivInManifestAsString()` For use with encryptionType.
`HlsIvSource`	`ivSource()` For use with encryptionType.
`String`	`ivSourceAsString()` For use with encryptionType.
`Integer`	`keepSegments()` If mode is "live", the number of TS segments to retain in the destination directory.
`String`	`keyFormat()` The value specifies how the key is represented in the resource identified by the URI.
`String`	`keyFormatVersions()` Either a single positive integer version value or a slash delimited list of version values (1/2/3).
`KeyProviderSettings`	`keyProviderSettings()` The key provider settings.
`HlsManifestCompression`	`manifestCompression()` When set to gzip, compresses HLS playlist.
`String`	`manifestCompressionAsString()` When set to gzip, compresses HLS playlist.
`HlsManifestDurationFormat`	`manifestDurationFormat()` Indicates whether the output manifest should use floating point or integer values for segment duration.
`String`	`manifestDurationFormatAsString()` Indicates whether the output manifest should use floating point or integer values for segment duration.
`Integer`	`minSegmentLength()` When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
`HlsMode`	`mode()` If "vod", all segments are indexed and kept permanently in the destination and manifest.
`String`	`modeAsString()` If "vod", all segments are indexed and kept permanently in the destination and manifest.
`HlsOutputSelection`	`outputSelection()` Generates the .m3u8 playlist file for this HLS output group.
`String`	`outputSelectionAsString()` Generates the .m3u8 playlist file for this HLS output group.
`HlsProgramDateTime`	`programDateTime()` Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files.
`String`	`programDateTimeAsString()` Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files.
`Integer`	`programDateTimePeriod()` Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
`HlsRedundantManifest`	`redundantManifest()` When set to "enabled", includes the media playlists from both pipelines in the master manifest (.m3u8) file.
`String`	`redundantManifestAsString()` When set to "enabled", includes the media playlists from both pipelines in the master manifest (.m3u8) file.
`List<SdkField<?>>`	`sdkFields()`
`HlsSegmentationMode`	`segmentationMode()` When set to useInputSegmentation, the output segment or fragment points are set by the RAI markers from the input streams.
`String`	`segmentationModeAsString()` When set to useInputSegmentation, the output segment or fragment points are set by the RAI markers from the input streams.
`Integer`	`segmentLength()` Length of MPEG-2 Transport Stream segments to create (in seconds).
`Integer`	`segmentsPerSubdirectory()` Number of segments to write to a subdirectory before starting a new one.
`static Class<? extends HlsGroupSettings.Builder>`	`serializableBuilderClass()`
`HlsStreamInfResolution`	`streamInfResolution()` Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
`String`	`streamInfResolutionAsString()` Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
`HlsTimedMetadataId3Frame`	`timedMetadataId3Frame()` Indicates ID3 frame that has the timecode.
`String`	`timedMetadataId3FrameAsString()` Indicates ID3 frame that has the timecode.
`Integer`	`timedMetadataId3Period()` Timed Metadata interval in seconds.
`Integer`	`timestampDeltaMilliseconds()` Provides an extra millisecond delta offset to fine tune the timestamps.
`HlsGroupSettings.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`HlsTsFileMode`	`tsFileMode()` When set to "singleFile", emits the program as a single media resource (.ts) file, and uses #EXT-X-BYTERANGE tags to index segment for playback.
`String`	`tsFileModeAsString()` When set to "singleFile", emits the program as a single media resource (.ts) file, and uses #EXT-X-BYTERANGE tags to index segment for playback.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - adMarkers
```
public List<HlsAdMarkers> 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.
    
    Returns:
    
    Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
  - adMarkersAsStrings
```
public List<String> 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.
    
    Returns:
    
    Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
  - baseUrlContent
```
public String 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.
  - baseUrlManifest
```
public String 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.
  - captionLanguageMappings
```
public List<CaptionLanguageMapping> captionLanguageMappings()
```
    Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
  - captionLanguageSetting
```
public HlsCaptionLanguageSetting captionLanguageSetting()
```
    Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest.
    If the service returns an enum value that is not available in the current SDK version, captionLanguageSetting will return HlsCaptionLanguageSetting.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from captionLanguageSettingAsString().
    
    Returns:
    
    Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest.
    
    See Also:
    
    HlsCaptionLanguageSetting
  - captionLanguageSettingAsString
```
public String captionLanguageSettingAsString()
```
    Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest.
    If the service returns an enum value that is not available in the current SDK version, captionLanguageSetting will return HlsCaptionLanguageSetting.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from captionLanguageSettingAsString().
    
    Returns:
    
    Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest.
    
    See Also:
    
    HlsCaptionLanguageSetting
  - clientCache
```
public HlsClientCache 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 return HlsClientCache.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from clientCacheAsString().
    
    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:
    
    HlsClientCache
  - clientCacheAsString
```
public String 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 return HlsClientCache.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from clientCacheAsString().
    
    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:
    
    HlsClientCache
  - codecSpecification
```
public HlsCodecSpecification 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 return HlsCodecSpecification.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from codecSpecificationAsString().
    
    Returns:
    
    Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
    
    See Also:
    
    HlsCodecSpecification
  - codecSpecificationAsString
```
public String 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 return HlsCodecSpecification.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from codecSpecificationAsString().
    
    Returns:
    
    Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
    
    See Also:
    
    HlsCodecSpecification
  - constantIv
```
public String 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
```
public OutputLocationRef 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
```
public HlsDirectoryStructure directoryStructure()
```
    Place segments in subdirectories.
    If the service returns an enum value that is not available in the current SDK version, directoryStructure will return HlsDirectoryStructure.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from directoryStructureAsString().
    
    Returns:
    
    Place segments in subdirectories.
    
    See Also:
    
    HlsDirectoryStructure
  - directoryStructureAsString
```
public String directoryStructureAsString()
```
    Place segments in subdirectories.
    If the service returns an enum value that is not available in the current SDK version, directoryStructure will return HlsDirectoryStructure.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from directoryStructureAsString().
    
    Returns:
    
    Place segments in subdirectories.
    
    See Also:
    
    HlsDirectoryStructure
  - encryptionType
```
public HlsEncryptionType 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 return HlsEncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionTypeAsString().
    
    Returns:
    
    Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
    
    See Also:
    
    HlsEncryptionType
  - encryptionTypeAsString
```
public String 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 return HlsEncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionTypeAsString().
    
    Returns:
    
    Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
    
    See Also:
    
    HlsEncryptionType
  - hlsCdnSettings
```
public HlsCdnSettings hlsCdnSettings()
```
    Parameters that control interactions with the CDN.
    
    Returns:
    
    Parameters that control interactions with the CDN.
  - indexNSegments
```
public Integer indexNSegments()
```
    If mode is "live", the number of segments to retain in the manifest (.m3u8) file. This number must be less than or equal to keepSegments. If mode is "vod", this parameter has no effect.
    
    Returns:
    
    If mode is "live", the number of segments to retain in the manifest (.m3u8) file. This number must be less than or equal to keepSegments. If mode is "vod", this parameter has no effect.
  - inputLossAction
```
public InputLossActionForHlsOut 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 return InputLossActionForHlsOut.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputLossActionAsString().
    
    Returns:
    
    Parameter that control output group behavior on input loss.
    
    See Also:
    
    InputLossActionForHlsOut
  - inputLossActionAsString
```
public String 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 return InputLossActionForHlsOut.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputLossActionAsString().
    
    Returns:
    
    Parameter that control output group behavior on input loss.
    
    See Also:
    
    InputLossActionForHlsOut
  - ivInManifest
```
public HlsIvInManifest 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 return HlsIvInManifest.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ivInManifestAsString().
    
    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:
    
    HlsIvInManifest
  - ivInManifestAsString
```
public String 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 return HlsIvInManifest.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ivInManifestAsString().
    
    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:
    
    HlsIvInManifest
  - ivSource
```
public HlsIvSource 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 return HlsIvSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ivSourceAsString().
    
    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:
    
    HlsIvSource
  - ivSourceAsString
```
public String 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 return HlsIvSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ivSourceAsString().
    
    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:
    
    HlsIvSource
  - keepSegments
```
public Integer keepSegments()
```
    If mode is "live", the number of TS segments to retain in the destination directory. If mode is "vod", this parameter has no effect.
    
    Returns:
    
    If mode is "live", the number of TS segments to retain in the destination directory. If mode is "vod", this parameter has no effect.
  - keyFormat
```
public String 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
```
public String 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
```
public KeyProviderSettings keyProviderSettings()
```
    The key provider settings.
    
    Returns:
    
    The key provider settings.
  - manifestCompression
```
public HlsManifestCompression 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 return HlsManifestCompression.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from manifestCompressionAsString().
    
    Returns:
    
    When set to gzip, compresses HLS playlist.
    
    See Also:
    
    HlsManifestCompression
  - manifestCompressionAsString
```
public String 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 return HlsManifestCompression.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from manifestCompressionAsString().
    
    Returns:
    
    When set to gzip, compresses HLS playlist.
    
    See Also:
    
    HlsManifestCompression
  - manifestDurationFormat
```
public HlsManifestDurationFormat 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 return HlsManifestDurationFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from manifestDurationFormatAsString().
    
    Returns:
    
    Indicates whether the output manifest should use floating point or integer values for segment duration.
    
    See Also:
    
    HlsManifestDurationFormat
  - manifestDurationFormatAsString
```
public String 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 return HlsManifestDurationFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from manifestDurationFormatAsString().
    
    Returns:
    
    Indicates whether the output manifest should use floating point or integer values for segment duration.
    
    See Also:
    
    HlsManifestDurationFormat
  - minSegmentLength
```
public Integer minSegmentLength()
```
    When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
    
    Returns:
    
    When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
  - mode
```
public HlsMode 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 return HlsMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().
    
    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:
    
    HlsMode
  - modeAsString
```
public String 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 return HlsMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().
    
    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:
    
    HlsMode
  - outputSelection
```
public HlsOutputSelection outputSelection()
```
    Generates the .m3u8 playlist file for this HLS output group. The segmentsOnly option will output segments without the .m3u8 file.
    If the service returns an enum value that is not available in the current SDK version, outputSelection will return HlsOutputSelection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputSelectionAsString().
    
    Returns:
    
    Generates the .m3u8 playlist file for this HLS output group. The segmentsOnly option will output segments without the .m3u8 file.
    
    See Also:
    
    HlsOutputSelection
  - outputSelectionAsString
```
public String outputSelectionAsString()
```
    Generates the .m3u8 playlist file for this HLS output group. The segmentsOnly option will output segments without the .m3u8 file.
    If the service returns an enum value that is not available in the current SDK version, outputSelection will return HlsOutputSelection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputSelectionAsString().
    
    Returns:
    
    Generates the .m3u8 playlist file for this HLS output group. The segmentsOnly option will output segments without the .m3u8 file.
    
    See Also:
    
    HlsOutputSelection
  - programDateTime
```
public HlsProgramDateTime programDateTime()
```
    Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.
    If the service returns an enum value that is not available in the current SDK version, programDateTime will return HlsProgramDateTime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from programDateTimeAsString().
    
    Returns:
    
    Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.
    
    See Also:
    
    HlsProgramDateTime
  - programDateTimeAsString
```
public String programDateTimeAsString()
```
    Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.
    If the service returns an enum value that is not available in the current SDK version, programDateTime will return HlsProgramDateTime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from programDateTimeAsString().
    
    Returns:
    
    Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.
    
    See Also:
    
    HlsProgramDateTime
  - programDateTimePeriod
```
public Integer 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
```
public HlsRedundantManifest redundantManifest()
```
    When set to "enabled", includes the media playlists from both pipelines in the master manifest (.m3u8) file.
    If the service returns an enum value that is not available in the current SDK version, redundantManifest will return HlsRedundantManifest.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from redundantManifestAsString().
    
    Returns:
    
    When set to "enabled", includes the media playlists from both pipelines in the master manifest (.m3u8) file.
    
    See Also:
    
    HlsRedundantManifest
  - redundantManifestAsString
```
public String redundantManifestAsString()
```
    When set to "enabled", includes the media playlists from both pipelines in the master manifest (.m3u8) file.
    If the service returns an enum value that is not available in the current SDK version, redundantManifest will return HlsRedundantManifest.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from redundantManifestAsString().
    
    Returns:
    
    When set to "enabled", includes the media playlists from both pipelines in the master manifest (.m3u8) file.
    
    See Also:
    
    HlsRedundantManifest
  - segmentLength
```
public Integer segmentLength()
```
    Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, 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 number of seconds, so actual segment length may be longer.
  - segmentationMode
```
public HlsSegmentationMode segmentationMode()
```
    When set to useInputSegmentation, the output segment or fragment points are set by the RAI markers from the input streams.
    If the service returns an enum value that is not available in the current SDK version, segmentationMode will return HlsSegmentationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from segmentationModeAsString().
    
    Returns:
    
    When set to useInputSegmentation, the output segment or fragment points are set by the RAI markers from the input streams.
    
    See Also:
    
    HlsSegmentationMode
  - segmentationModeAsString
```
public String segmentationModeAsString()
```
    When set to useInputSegmentation, the output segment or fragment points are set by the RAI markers from the input streams.
    If the service returns an enum value that is not available in the current SDK version, segmentationMode will return HlsSegmentationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from segmentationModeAsString().
    
    Returns:
    
    When set to useInputSegmentation, the output segment or fragment points are set by the RAI markers from the input streams.
    
    See Also:
    
    HlsSegmentationMode
  - segmentsPerSubdirectory
```
public Integer 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
```
public HlsStreamInfResolution 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 return HlsStreamInfResolution.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from streamInfResolutionAsString().
    
    Returns:
    
    Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
    
    See Also:
    
    HlsStreamInfResolution
  - streamInfResolutionAsString
```
public String 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 return HlsStreamInfResolution.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from streamInfResolutionAsString().
    
    Returns:
    
    Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
    
    See Also:
    
    HlsStreamInfResolution
  - timedMetadataId3Frame
```
public HlsTimedMetadataId3Frame 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 return HlsTimedMetadataId3Frame.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timedMetadataId3FrameAsString().
    
    Returns:
    
    Indicates ID3 frame that has the timecode.
    
    See Also:
    
    HlsTimedMetadataId3Frame
  - timedMetadataId3FrameAsString
```
public String 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 return HlsTimedMetadataId3Frame.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timedMetadataId3FrameAsString().
    
    Returns:
    
    Indicates ID3 frame that has the timecode.
    
    See Also:
    
    HlsTimedMetadataId3Frame
  - timedMetadataId3Period
```
public Integer timedMetadataId3Period()
```
    Timed Metadata interval in seconds.
    
    Returns:
    
    Timed Metadata interval in seconds.
  - timestampDeltaMilliseconds
```
public Integer 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
```
public HlsTsFileMode tsFileMode()
```
    When set to "singleFile", emits the program as a single media resource (.ts) file, and uses #EXT-X-BYTERANGE tags to index segment for playback. Playback of VOD mode content during event 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 return HlsTsFileMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tsFileModeAsString().
    
    Returns:
    
    When set to "singleFile", emits the program as a single media resource (.ts) file, and uses #EXT-X-BYTERANGE tags to index segment for playback. Playback of VOD mode content during event is not guaranteed due to HTTP server caching.
    
    See Also:
    
    HlsTsFileMode
  - tsFileModeAsString
```
public String tsFileModeAsString()
```
    When set to "singleFile", emits the program as a single media resource (.ts) file, and uses #EXT-X-BYTERANGE tags to index segment for playback. Playback of VOD mode content during event 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 return HlsTsFileMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tsFileModeAsString().
    
    Returns:
    
    When set to "singleFile", emits the program as a single media resource (.ts) file, and uses #EXT-X-BYTERANGE tags to index segment for playback. Playback of VOD mode content during event is not guaranteed due to HTTP server caching.
    
    See Also:
    
    HlsTsFileMode
  - toBuilder
```
public HlsGroupSettings.Builder 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 interface ToCopyableBuilder<HlsGroupSettings.Builder,HlsGroupSettings>
    
    Returns:
    
    a builder for type T
  - builder
```
public static HlsGroupSettings.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends HlsGroupSettings.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class HlsGroupSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

adMarkers

adMarkersAsStrings

baseUrlContent

baseUrlManifest

captionLanguageMappings

captionLanguageSetting

captionLanguageSettingAsString

clientCache

clientCacheAsString

codecSpecification

codecSpecificationAsString

constantIv

destination

directoryStructure

directoryStructureAsString

encryptionType

encryptionTypeAsString

hlsCdnSettings

indexNSegments

inputLossAction

inputLossActionAsString

ivInManifest

ivInManifestAsString

ivSource

ivSourceAsString

keepSegments

keyFormat

keyFormatVersions

keyProviderSettings

manifestCompression

manifestCompressionAsString

manifestDurationFormat

manifestDurationFormatAsString

minSegmentLength

mode

modeAsString

outputSelection

outputSelectionAsString

programDateTime

programDateTimeAsString

programDateTimePeriod

redundantManifest

redundantManifestAsString

segmentLength

segmentationMode

segmentationModeAsString

segmentsPerSubdirectory

streamInfResolution

streamInfResolutionAsString

timedMetadataId3Frame

timedMetadataId3FrameAsString

timedMetadataId3Period

timestampDeltaMilliseconds

tsFileMode

tsFileModeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields