@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class HlsGroupSettings extends Object implements Serializable, Cloneable, StructuredPojo
Constructor and Description |
---|
HlsGroupSettings() |
Modifier and Type | Method and Description |
---|---|
HlsGroupSettings |
clone() |
boolean |
equals(Object obj) |
List<HlsAdditionalManifest> |
getAdditionalManifests()
By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job.
|
List<String> |
getAdMarkers()
Choose one or more ad marker types to decorate your Apple HLS manifest.
|
String |
getAudioOnlyHeader()
Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues.
|
String |
getBaseUrl()
A partial URI prefix that will be prepended to each output in the media .m3u8 file.
|
List<HlsCaptionLanguageMapping> |
getCaptionLanguageMappings()
Language to be used on Caption outputs
|
String |
getCaptionLanguageSetting()
Applies only to 608 Embedded output captions.
|
String |
getCaptionSegmentLengthControl()
Set Caption segment length control to Match video to create caption segments that align with the video segments
from the first video output in this output group.
|
String |
getClientCache()
Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag.
|
String |
getCodecSpecification()
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
|
String |
getDestination()
Use Destination to specify the S3 output location and the output filename base.
|
DestinationSettings |
getDestinationSettings()
Settings associated with the destination.
|
String |
getDirectoryStructure()
Indicates whether segments should be placed in subdirectories.
|
HlsEncryptionSettings |
getEncryption()
DRM settings.
|
String |
getImageBasedTrickPlay()
Specify whether MediaConvert generates images for trick play.
|
HlsImageBasedTrickPlaySettings |
getImageBasedTrickPlaySettings()
Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
|
String |
getManifestCompression()
When set to GZIP, compresses HLS playlist.
|
String |
getManifestDurationFormat()
Indicates whether the output manifest should use floating point values for segment duration.
|
Double |
getMinFinalSegmentLength()
Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back
the end of your video asset.
|
Integer |
getMinSegmentLength()
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.
|
String |
getOutputSelection()
Indicates whether the .m3u8 manifest file should be generated for this HLS output group.
|
String |
getProgramDateTime()
Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files.
|
Integer |
getProgramDateTimePeriod()
Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
|
String |
getProgressiveWriteHlsManifest()
Specify whether MediaConvert generates HLS manifests while your job is running or when your job is complete.
|
String |
getSegmentControl()
When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index
segment for playback.
|
Integer |
getSegmentLength()
Specify the length, in whole seconds, of each segment.
|
String |
getSegmentLengthControl()
Specify how you want MediaConvert to determine the segment length.
|
Integer |
getSegmentsPerSubdirectory()
Specify the number of segments to write to a subdirectory before starting a new one.
|
String |
getStreamInfResolution()
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
|
String |
getTargetDurationCompatibilityMode()
When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its
current value in seconds.
|
String |
getTimedMetadataId3Frame()
Specify the type of the ID3 frame to use for ID3 timestamps in your output.
|
Integer |
getTimedMetadataId3Period()
Specify the interval in seconds to write ID3 timestamps in your output.
|
Integer |
getTimestampDeltaMilliseconds()
Provides an extra millisecond delta offset to fine tune the timestamps.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAdditionalManifests(Collection<HlsAdditionalManifest> additionalManifests)
By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job.
|
void |
setAdMarkers(Collection<String> adMarkers)
Choose one or more ad marker types to decorate your Apple HLS manifest.
|
void |
setAudioOnlyHeader(String audioOnlyHeader)
Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues.
|
void |
setBaseUrl(String baseUrl)
A partial URI prefix that will be prepended to each output in the media .m3u8 file.
|
void |
setCaptionLanguageMappings(Collection<HlsCaptionLanguageMapping> captionLanguageMappings)
Language to be used on Caption outputs
|
void |
setCaptionLanguageSetting(String captionLanguageSetting)
Applies only to 608 Embedded output captions.
|
void |
setCaptionSegmentLengthControl(String captionSegmentLengthControl)
Set Caption segment length control to Match video to create caption segments that align with the video segments
from the first video output in this output group.
|
void |
setClientCache(String clientCache)
Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag.
|
void |
setCodecSpecification(String codecSpecification)
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
|
void |
setDestination(String destination)
Use Destination to specify the S3 output location and the output filename base.
|
void |
setDestinationSettings(DestinationSettings destinationSettings)
Settings associated with the destination.
|
void |
setDirectoryStructure(String directoryStructure)
Indicates whether segments should be placed in subdirectories.
|
void |
setEncryption(HlsEncryptionSettings encryption)
DRM settings.
|
void |
setImageBasedTrickPlay(String imageBasedTrickPlay)
Specify whether MediaConvert generates images for trick play.
|
void |
setImageBasedTrickPlaySettings(HlsImageBasedTrickPlaySettings imageBasedTrickPlaySettings)
Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
|
void |
setManifestCompression(String manifestCompression)
When set to GZIP, compresses HLS playlist.
|
void |
setManifestDurationFormat(String manifestDurationFormat)
Indicates whether the output manifest should use floating point values for segment duration.
|
void |
setMinFinalSegmentLength(Double minFinalSegmentLength)
Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back
the end of your video asset.
|
void |
setMinSegmentLength(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.
|
void |
setOutputSelection(String outputSelection)
Indicates whether the .m3u8 manifest file should be generated for this HLS output group.
|
void |
setProgramDateTime(String programDateTime)
Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files.
|
void |
setProgramDateTimePeriod(Integer programDateTimePeriod)
Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
|
void |
setProgressiveWriteHlsManifest(String progressiveWriteHlsManifest)
Specify whether MediaConvert generates HLS manifests while your job is running or when your job is complete.
|
void |
setSegmentControl(String segmentControl)
When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index
segment for playback.
|
void |
setSegmentLength(Integer segmentLength)
Specify the length, in whole seconds, of each segment.
|
void |
setSegmentLengthControl(String segmentLengthControl)
Specify how you want MediaConvert to determine the segment length.
|
void |
setSegmentsPerSubdirectory(Integer segmentsPerSubdirectory)
Specify the number of segments to write to a subdirectory before starting a new one.
|
void |
setStreamInfResolution(String streamInfResolution)
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
|
void |
setTargetDurationCompatibilityMode(String targetDurationCompatibilityMode)
When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its
current value in seconds.
|
void |
setTimedMetadataId3Frame(String timedMetadataId3Frame)
Specify the type of the ID3 frame to use for ID3 timestamps in your output.
|
void |
setTimedMetadataId3Period(Integer timedMetadataId3Period)
Specify the interval in seconds to write ID3 timestamps in your output.
|
void |
setTimestampDeltaMilliseconds(Integer timestampDeltaMilliseconds)
Provides an extra millisecond delta offset to fine tune the timestamps.
|
String |
toString()
Returns a string representation of this object.
|
HlsGroupSettings |
withAdditionalManifests(Collection<HlsAdditionalManifest> additionalManifests)
By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job.
|
HlsGroupSettings |
withAdditionalManifests(HlsAdditionalManifest... additionalManifests)
By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job.
|
HlsGroupSettings |
withAdMarkers(Collection<String> adMarkers)
Choose one or more ad marker types to decorate your Apple HLS manifest.
|
HlsGroupSettings |
withAdMarkers(HlsAdMarkers... adMarkers)
Choose one or more ad marker types to decorate your Apple HLS manifest.
|
HlsGroupSettings |
withAdMarkers(String... adMarkers)
Choose one or more ad marker types to decorate your Apple HLS manifest.
|
HlsGroupSettings |
withAudioOnlyHeader(HlsAudioOnlyHeader audioOnlyHeader)
Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues.
|
HlsGroupSettings |
withAudioOnlyHeader(String audioOnlyHeader)
Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues.
|
HlsGroupSettings |
withBaseUrl(String baseUrl)
A partial URI prefix that will be prepended to each output in the media .m3u8 file.
|
HlsGroupSettings |
withCaptionLanguageMappings(Collection<HlsCaptionLanguageMapping> captionLanguageMappings)
Language to be used on Caption outputs
|
HlsGroupSettings |
withCaptionLanguageMappings(HlsCaptionLanguageMapping... captionLanguageMappings)
Language to be used on Caption outputs
|
HlsGroupSettings |
withCaptionLanguageSetting(HlsCaptionLanguageSetting captionLanguageSetting)
Applies only to 608 Embedded output captions.
|
HlsGroupSettings |
withCaptionLanguageSetting(String captionLanguageSetting)
Applies only to 608 Embedded output captions.
|
HlsGroupSettings |
withCaptionSegmentLengthControl(HlsCaptionSegmentLengthControl captionSegmentLengthControl)
Set Caption segment length control to Match video to create caption segments that align with the video segments
from the first video output in this output group.
|
HlsGroupSettings |
withCaptionSegmentLengthControl(String captionSegmentLengthControl)
Set Caption segment length control to Match video to create caption segments that align with the video segments
from the first video output in this output group.
|
HlsGroupSettings |
withClientCache(HlsClientCache clientCache)
Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag.
|
HlsGroupSettings |
withClientCache(String clientCache)
Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag.
|
HlsGroupSettings |
withCodecSpecification(HlsCodecSpecification codecSpecification)
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
|
HlsGroupSettings |
withCodecSpecification(String codecSpecification)
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
|
HlsGroupSettings |
withDestination(String destination)
Use Destination to specify the S3 output location and the output filename base.
|
HlsGroupSettings |
withDestinationSettings(DestinationSettings destinationSettings)
Settings associated with the destination.
|
HlsGroupSettings |
withDirectoryStructure(HlsDirectoryStructure directoryStructure)
Indicates whether segments should be placed in subdirectories.
|
HlsGroupSettings |
withDirectoryStructure(String directoryStructure)
Indicates whether segments should be placed in subdirectories.
|
HlsGroupSettings |
withEncryption(HlsEncryptionSettings encryption)
DRM settings.
|
HlsGroupSettings |
withImageBasedTrickPlay(HlsImageBasedTrickPlay imageBasedTrickPlay)
Specify whether MediaConvert generates images for trick play.
|
HlsGroupSettings |
withImageBasedTrickPlay(String imageBasedTrickPlay)
Specify whether MediaConvert generates images for trick play.
|
HlsGroupSettings |
withImageBasedTrickPlaySettings(HlsImageBasedTrickPlaySettings imageBasedTrickPlaySettings)
Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
|
HlsGroupSettings |
withManifestCompression(HlsManifestCompression manifestCompression)
When set to GZIP, compresses HLS playlist.
|
HlsGroupSettings |
withManifestCompression(String manifestCompression)
When set to GZIP, compresses HLS playlist.
|
HlsGroupSettings |
withManifestDurationFormat(HlsManifestDurationFormat manifestDurationFormat)
Indicates whether the output manifest should use floating point values for segment duration.
|
HlsGroupSettings |
withManifestDurationFormat(String manifestDurationFormat)
Indicates whether the output manifest should use floating point values for segment duration.
|
HlsGroupSettings |
withMinFinalSegmentLength(Double minFinalSegmentLength)
Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back
the end of your video asset.
|
HlsGroupSettings |
withMinSegmentLength(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.
|
HlsGroupSettings |
withOutputSelection(HlsOutputSelection outputSelection)
Indicates whether the .m3u8 manifest file should be generated for this HLS output group.
|
HlsGroupSettings |
withOutputSelection(String outputSelection)
Indicates whether the .m3u8 manifest file should be generated for this HLS output group.
|
HlsGroupSettings |
withProgramDateTime(HlsProgramDateTime programDateTime)
Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files.
|
HlsGroupSettings |
withProgramDateTime(String programDateTime)
Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files.
|
HlsGroupSettings |
withProgramDateTimePeriod(Integer programDateTimePeriod)
Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
|
HlsGroupSettings |
withProgressiveWriteHlsManifest(HlsProgressiveWriteHlsManifest progressiveWriteHlsManifest)
Specify whether MediaConvert generates HLS manifests while your job is running or when your job is complete.
|
HlsGroupSettings |
withProgressiveWriteHlsManifest(String progressiveWriteHlsManifest)
Specify whether MediaConvert generates HLS manifests while your job is running or when your job is complete.
|
HlsGroupSettings |
withSegmentControl(HlsSegmentControl segmentControl)
When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index
segment for playback.
|
HlsGroupSettings |
withSegmentControl(String segmentControl)
When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index
segment for playback.
|
HlsGroupSettings |
withSegmentLength(Integer segmentLength)
Specify the length, in whole seconds, of each segment.
|
HlsGroupSettings |
withSegmentLengthControl(HlsSegmentLengthControl segmentLengthControl)
Specify how you want MediaConvert to determine the segment length.
|
HlsGroupSettings |
withSegmentLengthControl(String segmentLengthControl)
Specify how you want MediaConvert to determine the segment length.
|
HlsGroupSettings |
withSegmentsPerSubdirectory(Integer segmentsPerSubdirectory)
Specify the number of segments to write to a subdirectory before starting a new one.
|
HlsGroupSettings |
withStreamInfResolution(HlsStreamInfResolution streamInfResolution)
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
|
HlsGroupSettings |
withStreamInfResolution(String streamInfResolution)
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
|
HlsGroupSettings |
withTargetDurationCompatibilityMode(HlsTargetDurationCompatibilityMode targetDurationCompatibilityMode)
When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its
current value in seconds.
|
HlsGroupSettings |
withTargetDurationCompatibilityMode(String targetDurationCompatibilityMode)
When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its
current value in seconds.
|
HlsGroupSettings |
withTimedMetadataId3Frame(HlsTimedMetadataId3Frame timedMetadataId3Frame)
Specify the type of the ID3 frame to use for ID3 timestamps in your output.
|
HlsGroupSettings |
withTimedMetadataId3Frame(String timedMetadataId3Frame)
Specify the type of the ID3 frame to use for ID3 timestamps in your output.
|
HlsGroupSettings |
withTimedMetadataId3Period(Integer timedMetadataId3Period)
Specify the interval in seconds to write ID3 timestamps in your output.
|
HlsGroupSettings |
withTimestampDeltaMilliseconds(Integer timestampDeltaMilliseconds)
Provides an extra millisecond delta offset to fine tune the timestamps.
|
public List<String> getAdMarkers()
HlsAdMarkers
public void setAdMarkers(Collection<String> adMarkers)
adMarkers
- Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine
whether SCTE-35 markers appear in the outputs themselves.HlsAdMarkers
public HlsGroupSettings withAdMarkers(String... adMarkers)
NOTE: This method appends the values to the existing list (if any). Use
setAdMarkers(java.util.Collection)
or withAdMarkers(java.util.Collection)
if you want to
override the existing values.
adMarkers
- Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine
whether SCTE-35 markers appear in the outputs themselves.HlsAdMarkers
public HlsGroupSettings withAdMarkers(Collection<String> adMarkers)
adMarkers
- Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine
whether SCTE-35 markers appear in the outputs themselves.HlsAdMarkers
public HlsGroupSettings withAdMarkers(HlsAdMarkers... adMarkers)
adMarkers
- Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine
whether SCTE-35 markers appear in the outputs themselves.HlsAdMarkers
public List<HlsAdditionalManifest> getAdditionalManifests()
public void setAdditionalManifests(Collection<HlsAdditionalManifest> additionalManifests)
additionalManifests
- By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job.
This default manifest references every output in the output group. To create additional top-level
manifests that reference a subset of the outputs in the output group, specify a list of them here.public HlsGroupSettings withAdditionalManifests(HlsAdditionalManifest... additionalManifests)
NOTE: This method appends the values to the existing list (if any). Use
setAdditionalManifests(java.util.Collection)
or withAdditionalManifests(java.util.Collection)
if you want to override the existing values.
additionalManifests
- By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job.
This default manifest references every output in the output group. To create additional top-level
manifests that reference a subset of the outputs in the output group, specify a list of them here.public HlsGroupSettings withAdditionalManifests(Collection<HlsAdditionalManifest> additionalManifests)
additionalManifests
- By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job.
This default manifest references every output in the output group. To create additional top-level
manifests that reference a subset of the outputs in the output group, specify a list of them here.public void setAudioOnlyHeader(String audioOnlyHeader)
audioOnlyHeader
- Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues.
Keep the default value, Include, to output audio-only headers. Choose Exclude to remove the audio-only
headers from your audio segments.HlsAudioOnlyHeader
public String getAudioOnlyHeader()
HlsAudioOnlyHeader
public HlsGroupSettings withAudioOnlyHeader(String audioOnlyHeader)
audioOnlyHeader
- Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues.
Keep the default value, Include, to output audio-only headers. Choose Exclude to remove the audio-only
headers from your audio segments.HlsAudioOnlyHeader
public HlsGroupSettings withAudioOnlyHeader(HlsAudioOnlyHeader audioOnlyHeader)
audioOnlyHeader
- Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues.
Keep the default value, Include, to output audio-only headers. Choose Exclude to remove the audio-only
headers from your audio segments.HlsAudioOnlyHeader
public void setBaseUrl(String baseUrl)
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.public String getBaseUrl()
public HlsGroupSettings withBaseUrl(String baseUrl)
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.public List<HlsCaptionLanguageMapping> getCaptionLanguageMappings()
public void setCaptionLanguageMappings(Collection<HlsCaptionLanguageMapping> captionLanguageMappings)
captionLanguageMappings
- Language to be used on Caption outputspublic HlsGroupSettings withCaptionLanguageMappings(HlsCaptionLanguageMapping... captionLanguageMappings)
NOTE: This method appends the values to the existing list (if any). Use
setCaptionLanguageMappings(java.util.Collection)
or
withCaptionLanguageMappings(java.util.Collection)
if you want to override the existing values.
captionLanguageMappings
- Language to be used on Caption outputspublic HlsGroupSettings withCaptionLanguageMappings(Collection<HlsCaptionLanguageMapping> captionLanguageMappings)
captionLanguageMappings
- Language to be used on Caption outputspublic void setCaptionLanguageSetting(String captionLanguageSetting)
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.HlsCaptionLanguageSetting
public String getCaptionLanguageSetting()
HlsCaptionLanguageSetting
public HlsGroupSettings withCaptionLanguageSetting(String captionLanguageSetting)
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.HlsCaptionLanguageSetting
public HlsGroupSettings withCaptionLanguageSetting(HlsCaptionLanguageSetting captionLanguageSetting)
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.HlsCaptionLanguageSetting
public void setCaptionSegmentLengthControl(String captionSegmentLengthControl)
captionSegmentLengthControl
- Set Caption segment length control to Match video to create caption segments that align with the video
segments from the first video output in this output group. For example, if the video segments are 2
seconds long, your WebVTT segments will also be 2 seconds long. Keep the default setting, Large segments
to create caption segments that are 300 seconds long.HlsCaptionSegmentLengthControl
public String getCaptionSegmentLengthControl()
HlsCaptionSegmentLengthControl
public HlsGroupSettings withCaptionSegmentLengthControl(String captionSegmentLengthControl)
captionSegmentLengthControl
- Set Caption segment length control to Match video to create caption segments that align with the video
segments from the first video output in this output group. For example, if the video segments are 2
seconds long, your WebVTT segments will also be 2 seconds long. Keep the default setting, Large segments
to create caption segments that are 300 seconds long.HlsCaptionSegmentLengthControl
public HlsGroupSettings withCaptionSegmentLengthControl(HlsCaptionSegmentLengthControl captionSegmentLengthControl)
captionSegmentLengthControl
- Set Caption segment length control to Match video to create caption segments that align with the video
segments from the first video output in this output group. For example, if the video segments are 2
seconds long, your WebVTT segments will also be 2 seconds long. Keep the default setting, Large segments
to create caption segments that are 300 seconds long.HlsCaptionSegmentLengthControl
public void setClientCache(String clientCache)
clientCache
- Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the
default value Enabled and control caching in your video distribution set up. For example, use the
Cache-Control http header.HlsClientCache
public String getClientCache()
HlsClientCache
public HlsGroupSettings withClientCache(String clientCache)
clientCache
- Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the
default value Enabled and control caching in your video distribution set up. For example, use the
Cache-Control http header.HlsClientCache
public HlsGroupSettings withClientCache(HlsClientCache clientCache)
clientCache
- Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the
default value Enabled and control caching in your video distribution set up. For example, use the
Cache-Control http header.HlsClientCache
public void setCodecSpecification(String codecSpecification)
codecSpecification
- Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.HlsCodecSpecification
public String getCodecSpecification()
HlsCodecSpecification
public HlsGroupSettings withCodecSpecification(String codecSpecification)
codecSpecification
- Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.HlsCodecSpecification
public HlsGroupSettings withCodecSpecification(HlsCodecSpecification codecSpecification)
codecSpecification
- Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.HlsCodecSpecification
public void setDestination(String destination)
destination
- Use 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.public String getDestination()
public HlsGroupSettings withDestination(String destination)
destination
- Use 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.public void setDestinationSettings(DestinationSettings destinationSettings)
destinationSettings
- Settings associated with the destination. Will vary based on the type of destinationpublic DestinationSettings getDestinationSettings()
public HlsGroupSettings withDestinationSettings(DestinationSettings destinationSettings)
destinationSettings
- Settings associated with the destination. Will vary based on the type of destinationpublic void setDirectoryStructure(String directoryStructure)
directoryStructure
- Indicates whether segments should be placed in subdirectories.HlsDirectoryStructure
public String getDirectoryStructure()
HlsDirectoryStructure
public HlsGroupSettings withDirectoryStructure(String directoryStructure)
directoryStructure
- Indicates whether segments should be placed in subdirectories.HlsDirectoryStructure
public HlsGroupSettings withDirectoryStructure(HlsDirectoryStructure directoryStructure)
directoryStructure
- Indicates whether segments should be placed in subdirectories.HlsDirectoryStructure
public void setEncryption(HlsEncryptionSettings encryption)
encryption
- DRM settings.public HlsEncryptionSettings getEncryption()
public HlsGroupSettings withEncryption(HlsEncryptionSettings encryption)
encryption
- DRM settings.public void setImageBasedTrickPlay(String imageBasedTrickPlay)
imageBasedTrickPlay
- Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not
generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to
generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child
manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A
common application for these images is Roku trick mode. The thumbnails and full-frame images that
MediaConvert creates with this feature are compatible with this Roku specification:
https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.mdHlsImageBasedTrickPlay
public String getImageBasedTrickPlay()
HlsImageBasedTrickPlay
public HlsGroupSettings withImageBasedTrickPlay(String imageBasedTrickPlay)
imageBasedTrickPlay
- Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not
generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to
generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child
manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A
common application for these images is Roku trick mode. The thumbnails and full-frame images that
MediaConvert creates with this feature are compatible with this Roku specification:
https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.mdHlsImageBasedTrickPlay
public HlsGroupSettings withImageBasedTrickPlay(HlsImageBasedTrickPlay imageBasedTrickPlay)
imageBasedTrickPlay
- Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not
generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to
generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child
manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A
common application for these images is Roku trick mode. The thumbnails and full-frame images that
MediaConvert creates with this feature are compatible with this Roku specification:
https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.mdHlsImageBasedTrickPlay
public void setImageBasedTrickPlaySettings(HlsImageBasedTrickPlaySettings imageBasedTrickPlaySettings)
imageBasedTrickPlaySettings
- Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCEDpublic HlsImageBasedTrickPlaySettings getImageBasedTrickPlaySettings()
public HlsGroupSettings withImageBasedTrickPlaySettings(HlsImageBasedTrickPlaySettings imageBasedTrickPlaySettings)
imageBasedTrickPlaySettings
- Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCEDpublic void setManifestCompression(String manifestCompression)
manifestCompression
- When set to GZIP, compresses HLS playlist.HlsManifestCompression
public String getManifestCompression()
HlsManifestCompression
public HlsGroupSettings withManifestCompression(String manifestCompression)
manifestCompression
- When set to GZIP, compresses HLS playlist.HlsManifestCompression
public HlsGroupSettings withManifestCompression(HlsManifestCompression manifestCompression)
manifestCompression
- When set to GZIP, compresses HLS playlist.HlsManifestCompression
public void setManifestDurationFormat(String manifestDurationFormat)
manifestDurationFormat
- Indicates whether the output manifest should use floating point values for segment duration.HlsManifestDurationFormat
public String getManifestDurationFormat()
HlsManifestDurationFormat
public HlsGroupSettings withManifestDurationFormat(String manifestDurationFormat)
manifestDurationFormat
- Indicates whether the output manifest should use floating point values for segment duration.HlsManifestDurationFormat
public HlsGroupSettings withManifestDurationFormat(HlsManifestDurationFormat manifestDurationFormat)
manifestDurationFormat
- Indicates whether the output manifest should use floating point values for segment duration.HlsManifestDurationFormat
public void setMinFinalSegmentLength(Double minFinalSegmentLength)
minFinalSegmentLength
- Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices
play back the end of your video asset. If you know that player devices are hanging on the final segment of
your video because the length of your final segment is too short, use this setting to specify a minimum
final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your
segment length. When you specify a value for this setting, the encoder will combine any final segment that
is shorter than the length that you specify with the previous segment. For example, your segment length is
3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the
minimum final segment length to 1, your final segment is 3.5 seconds.public Double getMinFinalSegmentLength()
public HlsGroupSettings withMinFinalSegmentLength(Double minFinalSegmentLength)
minFinalSegmentLength
- Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices
play back the end of your video asset. If you know that player devices are hanging on the final segment of
your video because the length of your final segment is too short, use this setting to specify a minimum
final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your
segment length. When you specify a value for this setting, the encoder will combine any final segment that
is shorter than the length that you specify with the previous segment. For example, your segment length is
3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the
minimum final segment length to 1, your final segment is 3.5 seconds.public void setMinSegmentLength(Integer minSegmentLength)
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.public Integer getMinSegmentLength()
public HlsGroupSettings withMinSegmentLength(Integer minSegmentLength)
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.public void setOutputSelection(String outputSelection)
outputSelection
- Indicates whether the .m3u8 manifest file should be generated for this HLS output group.HlsOutputSelection
public String getOutputSelection()
HlsOutputSelection
public HlsGroupSettings withOutputSelection(String outputSelection)
outputSelection
- Indicates whether the .m3u8 manifest file should be generated for this HLS output group.HlsOutputSelection
public HlsGroupSettings withOutputSelection(HlsOutputSelection outputSelection)
outputSelection
- Indicates whether the .m3u8 manifest file should be generated for this HLS output group.HlsOutputSelection
public void setProgramDateTime(String programDateTime)
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 timestamp_offset.HlsProgramDateTime
public String getProgramDateTime()
HlsProgramDateTime
public HlsGroupSettings withProgramDateTime(String programDateTime)
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 timestamp_offset.HlsProgramDateTime
public HlsGroupSettings withProgramDateTime(HlsProgramDateTime programDateTime)
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 timestamp_offset.HlsProgramDateTime
public void setProgramDateTimePeriod(Integer programDateTimePeriod)
programDateTimePeriod
- Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.public Integer getProgramDateTimePeriod()
public HlsGroupSettings withProgramDateTimePeriod(Integer programDateTimePeriod)
programDateTimePeriod
- Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.public void setProgressiveWriteHlsManifest(String progressiveWriteHlsManifest)
progressiveWriteHlsManifest
- Specify whether MediaConvert generates HLS manifests while your job is running or when your job is
complete. To generate HLS manifests while your job is running: Choose Enabled. Use if you want to play
back your content as soon as it's available. MediaConvert writes the parent and child manifests after the
first three media segments are written to your destination S3 bucket. It then writes new updated manifests
after each additional segment is written. The parent manifest includes the latest BANDWIDTH and
AVERAGE-BANDWIDTH attributes, and child manifests include the latest available media segment. When your
job completes, the final child playlists include an EXT-X-ENDLIST tag. To generate HLS manifests only when
your job completes: Choose Disabled.HlsProgressiveWriteHlsManifest
public String getProgressiveWriteHlsManifest()
HlsProgressiveWriteHlsManifest
public HlsGroupSettings withProgressiveWriteHlsManifest(String progressiveWriteHlsManifest)
progressiveWriteHlsManifest
- Specify whether MediaConvert generates HLS manifests while your job is running or when your job is
complete. To generate HLS manifests while your job is running: Choose Enabled. Use if you want to play
back your content as soon as it's available. MediaConvert writes the parent and child manifests after the
first three media segments are written to your destination S3 bucket. It then writes new updated manifests
after each additional segment is written. The parent manifest includes the latest BANDWIDTH and
AVERAGE-BANDWIDTH attributes, and child manifests include the latest available media segment. When your
job completes, the final child playlists include an EXT-X-ENDLIST tag. To generate HLS manifests only when
your job completes: Choose Disabled.HlsProgressiveWriteHlsManifest
public HlsGroupSettings withProgressiveWriteHlsManifest(HlsProgressiveWriteHlsManifest progressiveWriteHlsManifest)
progressiveWriteHlsManifest
- Specify whether MediaConvert generates HLS manifests while your job is running or when your job is
complete. To generate HLS manifests while your job is running: Choose Enabled. Use if you want to play
back your content as soon as it's available. MediaConvert writes the parent and child manifests after the
first three media segments are written to your destination S3 bucket. It then writes new updated manifests
after each additional segment is written. The parent manifest includes the latest BANDWIDTH and
AVERAGE-BANDWIDTH attributes, and child manifests include the latest available media segment. When your
job completes, the final child playlists include an EXT-X-ENDLIST tag. To generate HLS manifests only when
your job completes: Choose Disabled.HlsProgressiveWriteHlsManifest
public void setSegmentControl(String segmentControl)
segmentControl
- When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags
to index segment for playback.HlsSegmentControl
public String getSegmentControl()
HlsSegmentControl
public HlsGroupSettings withSegmentControl(String segmentControl)
segmentControl
- When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags
to index segment for playback.HlsSegmentControl
public HlsGroupSettings withSegmentControl(HlsSegmentControl segmentControl)
segmentControl
- When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags
to index segment for playback.HlsSegmentControl
public void setSegmentLength(Integer segmentLength)
segmentLength
- Specify the length, in whole seconds, of each segment. When you don't specify a value, MediaConvert
defaults to 10. Related settings: Use Segment length control to specify whether the encoder enforces this
value strictly. Use Segment control to specify whether MediaConvert creates separate segment files or one
content file that has metadata to mark the segment boundaries.public Integer getSegmentLength()
public HlsGroupSettings withSegmentLength(Integer segmentLength)
segmentLength
- Specify the length, in whole seconds, of each segment. When you don't specify a value, MediaConvert
defaults to 10. Related settings: Use Segment length control to specify whether the encoder enforces this
value strictly. Use Segment control to specify whether MediaConvert creates separate segment files or one
content file that has metadata to mark the segment boundaries.public void setSegmentLengthControl(String segmentLengthControl)
segmentLengthControl
- Specify how you want MediaConvert to determine the segment length. Choose Exact to have the encoder use
the exact length that you specify with the setting Segment length. This might result in extra I-frames.
Choose Multiple of GOP to have the encoder round up the segment lengths to match the next GOP boundary.HlsSegmentLengthControl
public String getSegmentLengthControl()
HlsSegmentLengthControl
public HlsGroupSettings withSegmentLengthControl(String segmentLengthControl)
segmentLengthControl
- Specify how you want MediaConvert to determine the segment length. Choose Exact to have the encoder use
the exact length that you specify with the setting Segment length. This might result in extra I-frames.
Choose Multiple of GOP to have the encoder round up the segment lengths to match the next GOP boundary.HlsSegmentLengthControl
public HlsGroupSettings withSegmentLengthControl(HlsSegmentLengthControl segmentLengthControl)
segmentLengthControl
- Specify how you want MediaConvert to determine the segment length. Choose Exact to have the encoder use
the exact length that you specify with the setting Segment length. This might result in extra I-frames.
Choose Multiple of GOP to have the encoder round up the segment lengths to match the next GOP boundary.HlsSegmentLengthControl
public void setSegmentsPerSubdirectory(Integer segmentsPerSubdirectory)
segmentsPerSubdirectory
- Specify the number of segments to write to a subdirectory before starting a new one. You must also set
Directory structure to Subdirectory per stream for this setting to have an effect.public Integer getSegmentsPerSubdirectory()
public HlsGroupSettings withSegmentsPerSubdirectory(Integer segmentsPerSubdirectory)
segmentsPerSubdirectory
- Specify the number of segments to write to a subdirectory before starting a new one. You must also set
Directory structure to Subdirectory per stream for this setting to have an effect.public void setStreamInfResolution(String streamInfResolution)
streamInfResolution
- Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.HlsStreamInfResolution
public String getStreamInfResolution()
HlsStreamInfResolution
public HlsGroupSettings withStreamInfResolution(String streamInfResolution)
streamInfResolution
- Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.HlsStreamInfResolution
public HlsGroupSettings withStreamInfResolution(HlsStreamInfResolution streamInfResolution)
streamInfResolution
- Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.HlsStreamInfResolution
public void setTargetDurationCompatibilityMode(String targetDurationCompatibilityMode)
targetDurationCompatibilityMode
- When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above
its current value in seconds. When set to SPEC\\_COMPLIANT, the segment target duration is rounded up to
the nearest integer value if fraction seconds are greater than or equal to 0.5 (>= 0.5) and rounded down
if less than 0.5 (< 0.5). You may need to use LEGACY if your client needs to ensure that the target
duration is always longer than the actual duration of the segment. Some older players may experience
interrupted playback when the actual duration of a track in a segment is longer than the target duration.HlsTargetDurationCompatibilityMode
public String getTargetDurationCompatibilityMode()
HlsTargetDurationCompatibilityMode
public HlsGroupSettings withTargetDurationCompatibilityMode(String targetDurationCompatibilityMode)
targetDurationCompatibilityMode
- When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above
its current value in seconds. When set to SPEC\\_COMPLIANT, the segment target duration is rounded up to
the nearest integer value if fraction seconds are greater than or equal to 0.5 (>= 0.5) and rounded down
if less than 0.5 (< 0.5). You may need to use LEGACY if your client needs to ensure that the target
duration is always longer than the actual duration of the segment. Some older players may experience
interrupted playback when the actual duration of a track in a segment is longer than the target duration.HlsTargetDurationCompatibilityMode
public HlsGroupSettings withTargetDurationCompatibilityMode(HlsTargetDurationCompatibilityMode targetDurationCompatibilityMode)
targetDurationCompatibilityMode
- When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above
its current value in seconds. When set to SPEC\\_COMPLIANT, the segment target duration is rounded up to
the nearest integer value if fraction seconds are greater than or equal to 0.5 (>= 0.5) and rounded down
if less than 0.5 (< 0.5). You may need to use LEGACY if your client needs to ensure that the target
duration is always longer than the actual duration of the segment. Some older players may experience
interrupted playback when the actual duration of a track in a segment is longer than the target duration.HlsTargetDurationCompatibilityMode
public void setTimedMetadataId3Frame(String timedMetadataId3Frame)
timedMetadataId3Frame
- Specify the type of the ID3 frame to use for ID3 timestamps in your output. To include ID3 timestamps:
Specify PRIV or TDRL and set ID3 metadata to Passthrough. To exclude ID3 timestamps: Set ID3 timestamp
frame type to None.HlsTimedMetadataId3Frame
public String getTimedMetadataId3Frame()
HlsTimedMetadataId3Frame
public HlsGroupSettings withTimedMetadataId3Frame(String timedMetadataId3Frame)
timedMetadataId3Frame
- Specify the type of the ID3 frame to use for ID3 timestamps in your output. To include ID3 timestamps:
Specify PRIV or TDRL and set ID3 metadata to Passthrough. To exclude ID3 timestamps: Set ID3 timestamp
frame type to None.HlsTimedMetadataId3Frame
public HlsGroupSettings withTimedMetadataId3Frame(HlsTimedMetadataId3Frame timedMetadataId3Frame)
timedMetadataId3Frame
- Specify the type of the ID3 frame to use for ID3 timestamps in your output. To include ID3 timestamps:
Specify PRIV or TDRL and set ID3 metadata to Passthrough. To exclude ID3 timestamps: Set ID3 timestamp
frame type to None.HlsTimedMetadataId3Frame
public void setTimedMetadataId3Period(Integer timedMetadataId3Period)
timedMetadataId3Period
- Specify the interval in seconds to write ID3 timestamps in your output. The first timestamp starts at the
output timecode and date, and increases incrementally with each ID3 timestamp. To use the default interval
of 10 seconds: Leave blank. To include this metadata in your output: Set ID3 timestamp frame type to PRIV
or TDRL, and set ID3 metadata to Passthrough.public Integer getTimedMetadataId3Period()
public HlsGroupSettings withTimedMetadataId3Period(Integer timedMetadataId3Period)
timedMetadataId3Period
- Specify the interval in seconds to write ID3 timestamps in your output. The first timestamp starts at the
output timecode and date, and increases incrementally with each ID3 timestamp. To use the default interval
of 10 seconds: Leave blank. To include this metadata in your output: Set ID3 timestamp frame type to PRIV
or TDRL, and set ID3 metadata to Passthrough.public void setTimestampDeltaMilliseconds(Integer timestampDeltaMilliseconds)
timestampDeltaMilliseconds
- Provides an extra millisecond delta offset to fine tune the timestamps.public Integer getTimestampDeltaMilliseconds()
public HlsGroupSettings withTimestampDeltaMilliseconds(Integer timestampDeltaMilliseconds)
timestampDeltaMilliseconds
- Provides an extra millisecond delta offset to fine tune the timestamps.public String toString()
toString
in class Object
Object.toString()
public HlsGroupSettings clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.