Package software.amazon.awscdk.services.medialive

Class CfnChannel.HlsGroupSettingsProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.medialive.CfnChannel.HlsGroupSettingsProperty.Jsii$Proxy

All Implemented Interfaces:

CfnChannel.HlsGroupSettingsProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnChannel.HlsGroupSettingsProperty

@Stability(Stable)
@Internal
public static final class CfnChannel.HlsGroupSettingsProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnChannel.HlsGroupSettingsProperty

An implementation for CfnChannel.HlsGroupSettingsProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.medialive.CfnChannel.HlsGroupSettingsProperty

CfnChannel.HlsGroupSettingsProperty.Builder, CfnChannel.HlsGroupSettingsProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnChannel.HlsGroupSettingsProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnChannel.HlsGroupSettingsProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final List<String>	getAdMarkers()	Chooses one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
final String	getBaseUrlContent()	A partial URI prefix that will be prepended to each output in the media .m3u8 file.
final String	getBaseUrlContent1()	Optional.
final String	getBaseUrlManifest()	A partial URI prefix that will be prepended to each output in the media .m3u8 file.
final String	getBaseUrlManifest1()	Optional.
final Object	getCaptionLanguageMappings()	A mapping of up to 4 captions channels to captions languages.
final String	getCaptionLanguageSetting()	Applies only to 608 embedded output captions.
final String	getClientCache()	When set to "disabled," sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.
final String	getCodecSpecification()	The specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
final String	getConstantIv()	Used with encryptionType.
final Object	getDestination()	A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
final String	getDirectoryStructure()	Places segments in subdirectories.
final String	getDiscontinuityTags()	Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group.
final String	getEncryptionType()	Encrypts the segments with the specified encryption scheme.
final Object	getHlsCdnSettings()	The parameters that control interactions with the CDN.
final String	getHlsId3SegmentTagging()	State of HLS ID3 Segment Tagging.
final String	getIFrameOnlyPlaylists()	DISABLED: Don't create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).
final String	getIncompleteSegmentBehavior()	Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline.
final Number	getIndexNSegments()	Applies only if the Mode field is LIVE.
final String	getInputLossAction()	A parameter that controls output group behavior on an input loss.
final String	getIvInManifest()	Used with encryptionType.
final String	getIvSource()	Used with encryptionType.
final Number	getKeepSegments()	Applies only if the Mode field is LIVE.
final String	getKeyFormat()	Specifies how the key is represented in the resource identified by the URI.
final String	getKeyFormatVersions()	Either a single positive integer version value or a slash-delimited list of version values (1/2/3).
final Object	getKeyProviderSettings()	The key provider settings.
final String	getManifestCompression()	When set to gzip, compresses HLS playlist.
final String	getManifestDurationFormat()	Indicates whether the output manifest should use a floating point or integer values for segment duration.
final Number	getMinSegmentLength()	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.
final String	getMode()	If "vod," all segments are indexed and kept permanently in the destination and manifest.
final String	getOutputSelection()	MANIFESTSANDSEGMENTS: Generates manifests (the master manifest, if applicable, and media manifests) for this output group.
final String	getProgramDateTime()	Includes or excludes the EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files.
final String	getProgramDateTimeClock()	CfnChannel.HlsGroupSettingsProperty.ProgramDateTimeClock.
final Number	getProgramDateTimePeriod()	The period of insertion of the EXT-X-PROGRAM-DATE-TIME entry, in seconds.
final String	getRedundantManifest()	ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline.
final String	getSegmentationMode()	useInputSegmentation has been deprecated.
final Number	getSegmentLength()	The length of the MPEG-2 Transport Stream segments to create, in seconds.
final Number	getSegmentsPerSubdirectory()	The number of segments to write to a subdirectory before starting a new one.
final String	getStreamInfResolution()	The include or exclude RESOLUTION attribute for a video in the EXT-X-STREAM-INF tag of a variant manifest.
final String	getTimedMetadataId3Frame()	Indicates the ID3 frame that has the timecode.
final Number	getTimedMetadataId3Period()	The timed metadata interval, in seconds.
final Number	getTimestampDeltaMilliseconds()	Provides an extra millisecond delta offset to fine tune the timestamps.
final String	getTsFileMode()	SEGMENTEDFILES: Emits the program as segments -multiple .ts media files.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnChannel.HlsGroupSettingsProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnChannel.HlsGroupSettingsProperty.Builder.

Method Details

getAdMarkers

public final List<String> getAdMarkers()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

Chooses one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.

Specified by:

getAdMarkers in interface CfnChannel.HlsGroupSettingsProperty

getBaseUrlContent

public final String getBaseUrlContent()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

A partial URI prefix that will be prepended to each output in the media .m3u8 file. The partial URI prefix can be used if the base manifest is delivered from a different URL than the main .m3u8 file.

Specified by:

getBaseUrlContent in interface CfnChannel.HlsGroupSettingsProperty

getBaseUrlContent1

public final String getBaseUrlContent1()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

Optional.

One value per output group. This field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0.

Specified by:

getBaseUrlContent1 in interface CfnChannel.HlsGroupSettingsProperty

getBaseUrlManifest

public final String getBaseUrlManifest()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

A partial URI prefix that will be prepended to each output in the media .m3u8 file. The partial URI prefix can be used if the base manifest is delivered from a different URL than the main .m3u8 file.

Specified by:

getBaseUrlManifest in interface CfnChannel.HlsGroupSettingsProperty

getBaseUrlManifest1

public final String getBaseUrlManifest1()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

Optional.

One value per output group. Complete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0.

Specified by:

getBaseUrlManifest1 in interface CfnChannel.HlsGroupSettingsProperty

getCaptionLanguageMappings

public final Object getCaptionLanguageMappings()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

A mapping of up to 4 captions channels to captions languages.

This is meaningful only if captionLanguageSetting is set to "insert."

Specified by:

getCaptionLanguageMappings in interface CfnChannel.HlsGroupSettingsProperty

getCaptionLanguageSetting

public final String getCaptionLanguageSetting()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

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 that 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 captions selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match properly with the output captions. None: Include the CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.

Specified by:

getCaptionLanguageSetting in interface CfnChannel.HlsGroupSettingsProperty

getClientCache

public final String getClientCache()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

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.

Specified by:

getClientCache in interface CfnChannel.HlsGroupSettingsProperty

getCodecSpecification

public final String getCodecSpecification()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

The specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

Specified by:

getCodecSpecification in interface CfnChannel.HlsGroupSettingsProperty

getConstantIv

public final String getConstantIv()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

Used with encryptionType.

This is a 128-bit, 16-byte hex value that is represented by a 32-character text string. If ivSource is set to "explicit," this parameter is required and is used as the IV for encryption.

Specified by:

getConstantIv in interface CfnChannel.HlsGroupSettingsProperty

getDestination

public final Object getDestination()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).

Specified by:

getDestination in interface CfnChannel.HlsGroupSettingsProperty

getDirectoryStructure

public final String getDirectoryStructure()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

Places segments in subdirectories.

Specified by:

getDirectoryStructure in interface CfnChannel.HlsGroupSettingsProperty

getDiscontinuityTags

public final String getDiscontinuityTags()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group.

Typically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose. Choose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags.

Specified by:

getDiscontinuityTags in interface CfnChannel.HlsGroupSettingsProperty

getEncryptionType

public final String getEncryptionType()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

Encrypts the segments with the specified encryption scheme.

Exclude this parameter if you don't want encryption.

Specified by:

getEncryptionType in interface CfnChannel.HlsGroupSettingsProperty

getHlsCdnSettings

public final Object getHlsCdnSettings()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

The parameters that control interactions with the CDN.

Specified by:

getHlsCdnSettings in interface CfnChannel.HlsGroupSettingsProperty

getHlsId3SegmentTagging

public final String getHlsId3SegmentTagging()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

State of HLS ID3 Segment Tagging.

Specified by:

getHlsId3SegmentTagging in interface CfnChannel.HlsGroupSettingsProperty

getIFrameOnlyPlaylists

public final String getIFrameOnlyPlaylists()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

DISABLED: Don't create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).

STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888".

Specified by:

getIFrameOnlyPlaylists in interface CfnChannel.HlsGroupSettingsProperty

getIncompleteSegmentBehavior

public final String getIncompleteSegmentBehavior()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline.

Auto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups. Suppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior.

Specified by:

getIncompleteSegmentBehavior in interface CfnChannel.HlsGroupSettingsProperty

getIndexNSegments

public final Number getIndexNSegments()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

Applies only if the Mode field is LIVE.

Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.

Specified by:

getIndexNSegments in interface CfnChannel.HlsGroupSettingsProperty

getInputLossAction

public final String getInputLossAction()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

A parameter that controls output group behavior on an input loss.

Specified by:

getInputLossAction in interface CfnChannel.HlsGroupSettingsProperty

getIvInManifest

public final String getIvInManifest()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

Used with encryptionType.

The IV (initialization vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include," the IV is listed in the manifest. Otherwise, the IV is not in the manifest.

Specified by:

getIvInManifest in interface CfnChannel.HlsGroupSettingsProperty

getIvSource

public final String getIvSource()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

Used 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 causes the IV to change every segment (to match the segment number). If this is set to "explicit," you must enter a constantIv value.

Specified by:

getIvSource in interface CfnChannel.HlsGroupSettingsProperty

getKeepSegments

public final Number getKeepSegments()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

Applies only if the Mode field is LIVE.

Specifies the number of media segments (.ts files) to retain in the destination directory.

Specified by:

getKeepSegments in interface CfnChannel.HlsGroupSettingsProperty

getKeyFormat

public final String getKeyFormat()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

Specifies how the key is represented in the resource identified by the URI.

If the parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be specified.

Specified by:

getKeyFormat in interface CfnChannel.HlsGroupSettingsProperty

getKeyFormatVersions

public final String getKeyFormatVersions()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

Either a single positive integer version value or a slash-delimited list of version values (1/2/3).

Specified by:

getKeyFormatVersions in interface CfnChannel.HlsGroupSettingsProperty

getKeyProviderSettings

public final Object getKeyProviderSettings()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

The key provider settings.

Specified by:

getKeyProviderSettings in interface CfnChannel.HlsGroupSettingsProperty

getManifestCompression

public final String getManifestCompression()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

When set to gzip, compresses HLS playlist.

Specified by:

getManifestCompression in interface CfnChannel.HlsGroupSettingsProperty

getManifestDurationFormat

public final String getManifestDurationFormat()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

Indicates whether the output manifest should use a floating point or integer values for segment duration.

Specified by:

getManifestDurationFormat in interface CfnChannel.HlsGroupSettingsProperty

getMinSegmentLength

public final Number getMinSegmentLength()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

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.

Specified by:

getMinSegmentLength in interface CfnChannel.HlsGroupSettingsProperty

getMode

public final String getMode()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

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 might prevent players from rewinding all the way to the beginning of the channel. 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.

Specified by:

getMode in interface CfnChannel.HlsGroupSettingsProperty

getOutputSelection

public final String getOutputSelection()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

MANIFESTSANDSEGMENTS: Generates manifests (the master manifest, if applicable, and media manifests) for this output group.

SEGMENTSONLY: Doesn't generate any manifests for this output group.

Specified by:

getOutputSelection in interface CfnChannel.HlsGroupSettingsProperty

getProgramDateTime

public final String getProgramDateTime()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

Includes or excludes the 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.

Specified by:

getProgramDateTime in interface CfnChannel.HlsGroupSettingsProperty

getProgramDateTimeClock

public final String getProgramDateTimeClock()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

CfnChannel.HlsGroupSettingsProperty.ProgramDateTimeClock.

Specified by:

getProgramDateTimeClock in interface CfnChannel.HlsGroupSettingsProperty

getProgramDateTimePeriod

public final Number getProgramDateTimePeriod()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

The period of insertion of the EXT-X-PROGRAM-DATE-TIME entry, in seconds.

Specified by:

getProgramDateTimePeriod in interface CfnChannel.HlsGroupSettingsProperty

getRedundantManifest

public final String getRedundantManifest()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows a playout device that supports stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players, so a redundant manifest from MediaLive is irrelevant.

Specified by:

getRedundantManifest in interface CfnChannel.HlsGroupSettingsProperty

getSegmentationMode

public final String getSegmentationMode()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

useInputSegmentation has been deprecated.

The configured segment size is always used.

Specified by:

getSegmentationMode in interface CfnChannel.HlsGroupSettingsProperty

getSegmentLength

public final Number getSegmentLength()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

The length of the MPEG-2 Transport Stream segments to create, in seconds.

Note that segments will end on the next keyframe after this number of seconds, so the actual segment length might be longer.

Specified by:

getSegmentLength in interface CfnChannel.HlsGroupSettingsProperty

getSegmentsPerSubdirectory

public final Number getSegmentsPerSubdirectory()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

The number of segments to write to a subdirectory before starting a new one.

For this setting to have an effect, directoryStructure must be subdirectoryPerStream.

Specified by:

getSegmentsPerSubdirectory in interface CfnChannel.HlsGroupSettingsProperty

getStreamInfResolution

public final String getStreamInfResolution()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

The include or exclude RESOLUTION attribute for a video in the EXT-X-STREAM-INF tag of a variant manifest.

Specified by:

getStreamInfResolution in interface CfnChannel.HlsGroupSettingsProperty

getTimedMetadataId3Frame

public final String getTimedMetadataId3Frame()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

Indicates the ID3 frame that has the timecode.

Specified by:

getTimedMetadataId3Frame in interface CfnChannel.HlsGroupSettingsProperty

getTimedMetadataId3Period

public final Number getTimedMetadataId3Period()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

The timed metadata interval, in seconds.

Specified by:

getTimedMetadataId3Period in interface CfnChannel.HlsGroupSettingsProperty

getTimestampDeltaMilliseconds

public final Number getTimestampDeltaMilliseconds()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

Provides an extra millisecond delta offset to fine tune the timestamps.

Specified by:

getTimestampDeltaMilliseconds in interface CfnChannel.HlsGroupSettingsProperty

getTsFileMode

public final String getTsFileMode()

Description copied from interface: CfnChannel.HlsGroupSettingsProperty

SEGMENTEDFILES: Emits the program as segments -multiple .ts media files. SINGLEFILE: Applies only if the Mode field is VOD. Emits the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.

Specified by:

getTsFileMode in interface CfnChannel.HlsGroupSettingsProperty

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object