HlsGroupSettings (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<HlsGroupSettings.Builder,HlsGroupSettings>
```
@Generated(value="software.amazon.awssdk:codegen")
public class HlsGroupSettings
extends Object
implements StructuredPojo, ToCopyableBuilder<HlsGroupSettings.Builder,HlsGroupSettings>
```
Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to HLS_GROUP_SETTINGS.

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>`	`adMarkersStrings()` Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
`String`	`baseUrl()` A partial URI prefix that will be prepended to each output in the media .m3u8 file.
`static HlsGroupSettings.Builder`	`builder()`
`List<HlsCaptionLanguageMapping>`	`captionLanguageMappings()` Language to be used on Caption outputs
`HlsCaptionLanguageSetting`	`captionLanguageSetting()` Returns the value of the CaptionLanguageSetting property for this object.
`String`	`captionLanguageSettingString()` Returns the value of the CaptionLanguageSetting property for this object.
`HlsClientCache`	`clientCache()` Returns the value of the ClientCache property for this object.
`String`	`clientCacheString()` Returns the value of the ClientCache property for this object.
`HlsCodecSpecification`	`codecSpecification()` Returns the value of the CodecSpecification property for this object.
`String`	`codecSpecificationString()` Returns the value of the CodecSpecification property for this object.
`String`	`destination()` Use Destination (Destination) to specify the S3 output location and the output filename base.
`HlsDirectoryStructure`	`directoryStructure()` Returns the value of the DirectoryStructure property for this object.
`String`	`directoryStructureString()` Returns the value of the DirectoryStructure property for this object.
`HlsEncryptionSettings`	`encryption()` DRM settings.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`HlsManifestCompression`	`manifestCompression()` Returns the value of the ManifestCompression property for this object.
`String`	`manifestCompressionString()` Returns the value of the ManifestCompression property for this object.
`HlsManifestDurationFormat`	`manifestDurationFormat()` Returns the value of the ManifestDurationFormat property for this object.
`String`	`manifestDurationFormatString()` Returns the value of the ManifestDurationFormat property for this object.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`Integer`	`minSegmentLength()` When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
`HlsOutputSelection`	`outputSelection()` Returns the value of the OutputSelection property for this object.
`String`	`outputSelectionString()` Returns the value of the OutputSelection property for this object.
`HlsProgramDateTime`	`programDateTime()` Returns the value of the ProgramDateTime property for this object.
`Integer`	`programDateTimePeriod()` Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
`String`	`programDateTimeString()` Returns the value of the ProgramDateTime property for this object.
`HlsSegmentControl`	`segmentControl()` Returns the value of the SegmentControl property for this object.
`String`	`segmentControlString()` Returns the value of the SegmentControl property for this object.
`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()` Returns the value of the StreamInfResolution property for this object.
`String`	`streamInfResolutionString()` Returns the value of the StreamInfResolution property for this object.
`HlsTimedMetadataId3Frame`	`timedMetadataId3Frame()` Returns the value of the TimedMetadataId3Frame property for this object.
`String`	`timedMetadataId3FrameString()` Returns the value of the TimedMetadataId3Frame property for this object.
`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()`

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.
  - adMarkersStrings
```
public List<String> adMarkersStrings()
```
    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.
  - baseUrl
```
public String baseUrl()
```
    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<HlsCaptionLanguageMapping> captionLanguageMappings()
```
    Language to be used on Caption outputs
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Language to be used on Caption outputs
  - captionLanguageSetting
```
public HlsCaptionLanguageSetting captionLanguageSetting()
```
    Returns the value of the CaptionLanguageSetting property for this object.
    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 captionLanguageSettingString().
    
    Returns:
    
    The value of the CaptionLanguageSetting property for this object.
    
    See Also:
    
    HlsCaptionLanguageSetting
  - captionLanguageSettingString
```
public String captionLanguageSettingString()
```
    Returns the value of the CaptionLanguageSetting property for this object.
    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 captionLanguageSettingString().
    
    Returns:
    
    The value of the CaptionLanguageSetting property for this object.
    
    See Also:
    
    HlsCaptionLanguageSetting
  - clientCache
```
public HlsClientCache clientCache()
```
    Returns the value of the ClientCache property for this object.
    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 clientCacheString().
    
    Returns:
    
    The value of the ClientCache property for this object.
    
    See Also:
    
    HlsClientCache
  - clientCacheString
```
public String clientCacheString()
```
    Returns the value of the ClientCache property for this object.
    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 clientCacheString().
    
    Returns:
    
    The value of the ClientCache property for this object.
    
    See Also:
    
    HlsClientCache
  - codecSpecification
```
public HlsCodecSpecification codecSpecification()
```
    Returns the value of the CodecSpecification property for this object.
    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 codecSpecificationString().
    
    Returns:
    
    The value of the CodecSpecification property for this object.
    
    See Also:
    
    HlsCodecSpecification
  - codecSpecificationString
```
public String codecSpecificationString()
```
    Returns the value of the CodecSpecification property for this object.
    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 codecSpecificationString().
    
    Returns:
    
    The value of the CodecSpecification property for this object.
    
    See Also:
    
    HlsCodecSpecification
  - destination
```
public String destination()
```
    Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.
    
    Returns:
    
    Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.
  - directoryStructure
```
public HlsDirectoryStructure directoryStructure()
```
    Returns the value of the DirectoryStructure property for this object.
    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 directoryStructureString().
    
    Returns:
    
    The value of the DirectoryStructure property for this object.
    
    See Also:
    
    HlsDirectoryStructure
  - directoryStructureString
```
public String directoryStructureString()
```
    Returns the value of the DirectoryStructure property for this object.
    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 directoryStructureString().
    
    Returns:
    
    The value of the DirectoryStructure property for this object.
    
    See Also:
    
    HlsDirectoryStructure
  - encryption
```
public HlsEncryptionSettings encryption()
```
    DRM settings.
    
    Returns:
    
    DRM settings.
  - manifestCompression
```
public HlsManifestCompression manifestCompression()
```
    Returns the value of the ManifestCompression property for this object.
    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 manifestCompressionString().
    
    Returns:
    
    The value of the ManifestCompression property for this object.
    
    See Also:
    
    HlsManifestCompression
  - manifestCompressionString
```
public String manifestCompressionString()
```
    Returns the value of the ManifestCompression property for this object.
    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 manifestCompressionString().
    
    Returns:
    
    The value of the ManifestCompression property for this object.
    
    See Also:
    
    HlsManifestCompression
  - manifestDurationFormat
```
public HlsManifestDurationFormat manifestDurationFormat()
```
    Returns the value of the ManifestDurationFormat property for this object.
    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 manifestDurationFormatString().
    
    Returns:
    
    The value of the ManifestDurationFormat property for this object.
    
    See Also:
    
    HlsManifestDurationFormat
  - manifestDurationFormatString
```
public String manifestDurationFormatString()
```
    Returns the value of the ManifestDurationFormat property for this object.
    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 manifestDurationFormatString().
    
    Returns:
    
    The value of the ManifestDurationFormat property for this object.
    
    See Also:
    
    HlsManifestDurationFormat
  - minSegmentLength
```
public Integer minSegmentLength()
```
    When set, Minimum Segment Size 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, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
  - outputSelection
```
public HlsOutputSelection outputSelection()
```
    Returns the value of the OutputSelection property for this object.
    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 outputSelectionString().
    
    Returns:
    
    The value of the OutputSelection property for this object.
    
    See Also:
    
    HlsOutputSelection
  - outputSelectionString
```
public String outputSelectionString()
```
    Returns the value of the OutputSelection property for this object.
    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 outputSelectionString().
    
    Returns:
    
    The value of the OutputSelection property for this object.
    
    See Also:
    
    HlsOutputSelection
  - programDateTime
```
public HlsProgramDateTime programDateTime()
```
    Returns the value of the ProgramDateTime property for this object.
    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 programDateTimeString().
    
    Returns:
    
    The value of the ProgramDateTime property for this object.
    
    See Also:
    
    HlsProgramDateTime
  - programDateTimeString
```
public String programDateTimeString()
```
    Returns the value of the ProgramDateTime property for this object.
    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 programDateTimeString().
    
    Returns:
    
    The value of the ProgramDateTime property for this object.
    
    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.
  - segmentControl
```
public HlsSegmentControl segmentControl()
```
    Returns the value of the SegmentControl property for this object.
    If the service returns an enum value that is not available in the current SDK version, segmentControl will return HlsSegmentControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from segmentControlString().
    
    Returns:
    
    The value of the SegmentControl property for this object.
    
    See Also:
    
    HlsSegmentControl
  - segmentControlString
```
public String segmentControlString()
```
    Returns the value of the SegmentControl property for this object.
    If the service returns an enum value that is not available in the current SDK version, segmentControl will return HlsSegmentControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from segmentControlString().
    
    Returns:
    
    The value of the SegmentControl property for this object.
    
    See Also:
    
    HlsSegmentControl
  - 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.
  - segmentsPerSubdirectory
```
public Integer segmentsPerSubdirectory()
```
    Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect.
    
    Returns:
    
    Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect.
  - streamInfResolution
```
public HlsStreamInfResolution streamInfResolution()
```
    Returns the value of the StreamInfResolution property for this object.
    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 streamInfResolutionString().
    
    Returns:
    
    The value of the StreamInfResolution property for this object.
    
    See Also:
    
    HlsStreamInfResolution
  - streamInfResolutionString
```
public String streamInfResolutionString()
```
    Returns the value of the StreamInfResolution property for this object.
    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 streamInfResolutionString().
    
    Returns:
    
    The value of the StreamInfResolution property for this object.
    
    See Also:
    
    HlsStreamInfResolution
  - timedMetadataId3Frame
```
public HlsTimedMetadataId3Frame timedMetadataId3Frame()
```
    Returns the value of the TimedMetadataId3Frame property for this object.
    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 timedMetadataId3FrameString().
    
    Returns:
    
    The value of the TimedMetadataId3Frame property for this object.
    
    See Also:
    
    HlsTimedMetadataId3Frame
  - timedMetadataId3FrameString
```
public String timedMetadataId3FrameString()
```
    Returns the value of the TimedMetadataId3Frame property for this object.
    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 timedMetadataId3FrameString().
    
    Returns:
    
    The value of the TimedMetadataId3Frame property for this object.
    
    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.
  - 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)
```
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

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

adMarkersStrings

baseUrl

captionLanguageMappings

captionLanguageSetting

captionLanguageSettingString

clientCache

clientCacheString

codecSpecification

codecSpecificationString

destination

directoryStructure

directoryStructureString

encryption

manifestCompression

manifestCompressionString

manifestDurationFormat

manifestDurationFormatString

minSegmentLength

outputSelection

outputSelectionString

programDateTime

programDateTimeString

programDateTimePeriod

segmentControl

segmentControlString

segmentLength

segmentsPerSubdirectory

streamInfResolution

streamInfResolutionString

timedMetadataId3Frame

timedMetadataId3FrameString

timedMetadataId3Period

timestampDeltaMilliseconds

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

marshall