Package software.amazon.awscdk.services.medialive

Interface CfnChannel.MsSmoothGroupSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannel.MsSmoothGroupSettingsProperty.Jsii$Proxy

Enclosing class:

CfnChannel

@Stability(Stable)
public static interface CfnChannel.MsSmoothGroupSettingsProperty
extends software.amazon.jsii.JsiiSerializable

The settings for a Microsoft Smooth output group.

The parent of this entity is OutputGroupSettings.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.medialive.*;
 MsSmoothGroupSettingsProperty msSmoothGroupSettingsProperty = MsSmoothGroupSettingsProperty.builder()
         .acquisitionPointId("acquisitionPointId")
         .audioOnlyTimecodeControl("audioOnlyTimecodeControl")
         .certificateMode("certificateMode")
         .connectionRetryInterval(123)
         .destination(OutputLocationRefProperty.builder()
                 .destinationRefId("destinationRefId")
                 .build())
         .eventId("eventId")
         .eventIdMode("eventIdMode")
         .eventStopBehavior("eventStopBehavior")
         .filecacheDuration(123)
         .fragmentLength(123)
         .inputLossAction("inputLossAction")
         .numRetries(123)
         .restartDelay(123)
         .segmentationMode("segmentationMode")
         .sendDelayMs(123)
         .sparseTrackType("sparseTrackType")
         .streamManifestBehavior("streamManifestBehavior")
         .timestampOffset("timestampOffset")
         .timestampOffsetMode("timestampOffsetMode")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnChannel.MsSmoothGroupSettingsProperty.Builder	A builder for CfnChannel.MsSmoothGroupSettingsProperty
static final class	CfnChannel.MsSmoothGroupSettingsProperty.Jsii$Proxy	An implementation for CfnChannel.MsSmoothGroupSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnChannel.MsSmoothGroupSettingsProperty.Builder	builder()
default String	getAcquisitionPointId()	The value of the Acquisition Point Identity element that is used in each message placed in the sparse track.
default String	getAudioOnlyTimecodeControl()	If set to passthrough for an audio-only Microsoft Smooth output, the fragment absolute time is set to the current timecode.
default String	getCertificateMode()	If set to verifyAuthenticity, verifies the HTTPS certificate chain to a trusted certificate authority (CA).
default Number	getConnectionRetryInterval()	The number of seconds to wait before retrying the connection to the IIS server if the connection is lost.
default Object	getDestination()	The Smooth Streaming publish point on an IIS server.
default String	getEventId()	The Microsoft Smooth channel ID that is sent to the IIS server.
default String	getEventIdMode()	Specifies whether to send a channel ID to the IIS server.
default String	getEventStopBehavior()	When set to sendEos, sends an EOS signal to an IIS server when stopping the channel.
default Number	getFilecacheDuration()	The size, in seconds, of the file cache for streaming outputs.
default Number	getFragmentLength()	The length, in seconds, of mp4 fragments to generate.
default String	getInputLossAction()	A parameter that controls output group behavior on an input loss.
default Number	getNumRetries()	The number of retry attempts.
default Number	getRestartDelay()	The number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
default String	getSegmentationMode()	useInputSegmentation has been deprecated.
default Number	getSendDelayMs()	The number of milliseconds to delay the output from the second pipeline.
default String	getSparseTrackType()	If set to scte35, uses incoming SCTE-35 messages to generate a sparse track in this group of Microsoft Smooth outputs.
default String	getStreamManifestBehavior()	When set to send, sends a stream manifest so that the publishing point doesn't start until all streams start.
default String	getTimestampOffset()	The timestamp offset for the channel.
default String	getTimestampOffsetMode()	The type of timestamp date offset to use.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAcquisitionPointId

@Stability(Stable)
@Nullable
default String getAcquisitionPointId()

The value of the Acquisition Point Identity element that is used in each message placed in the sparse track.

Enabled only if sparseTrackType is not "none."

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-acquisitionpointid

getAudioOnlyTimecodeControl

@Stability(Stable)
@Nullable
default String getAudioOnlyTimecodeControl()

If set to passthrough for an audio-only Microsoft Smooth output, the fragment absolute time is set to the current timecode.

This option does not write timecodes to the audio elementary stream.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-audioonlytimecodecontrol

getCertificateMode

@Stability(Stable)
@Nullable
default String getCertificateMode()

If set to verifyAuthenticity, verifies the HTTPS certificate chain to a trusted certificate authority (CA).

This causes HTTPS outputs to self-signed certificates to fail.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-certificatemode

getConnectionRetryInterval

@Stability(Stable)
@Nullable
default Number getConnectionRetryInterval()

The number of seconds to wait before retrying the connection to the IIS server if the connection is lost.

Content is cached during this time, and the cache is delivered to the IIS server after the connection is re-established.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-connectionretryinterval

getDestination

@Stability(Stable)
@Nullable
default Object getDestination()

The Smooth Streaming publish point on an IIS server.

MediaLive acts as a "Push" encoder to IIS.

Returns union: either IResolvable or CfnChannel.OutputLocationRefProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-destination

getEventId

@Stability(Stable)
@Nullable
default String getEventId()

The Microsoft Smooth channel ID that is sent to the IIS server.

Specify the ID only if eventIdMode is set to useConfigured.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-eventid

getEventIdMode

@Stability(Stable)
@Nullable
default String getEventIdMode()

Specifies whether to send a channel ID to the IIS server.

If no channel ID is sent and the same channel is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send a channel ID based on the current timestamp - "noEventId" - do not send a channel ID to the IIS server.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-eventidmode

getEventStopBehavior

@Stability(Stable)
@Nullable
default String getEventStopBehavior()

When set to sendEos, sends an EOS signal to an IIS server when stopping the channel.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-eventstopbehavior

getFilecacheDuration

@Stability(Stable)
@Nullable
default Number getFilecacheDuration()

The size, in seconds, of the file cache for streaming outputs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-filecacheduration

getFragmentLength

@Stability(Stable)
@Nullable
default Number getFragmentLength()

The length, in seconds, of mp4 fragments to generate.

The fragment length must be compatible with GOP size and frame rate.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-fragmentlength

getInputLossAction

@Stability(Stable)
@Nullable
default String getInputLossAction()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-inputlossaction

getNumRetries

@Stability(Stable)
@Nullable
default Number getNumRetries()

The number of retry attempts.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-numretries

getRestartDelay

@Stability(Stable)
@Nullable
default Number getRestartDelay()

The number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-restartdelay

getSegmentationMode

@Stability(Stable)
@Nullable
default String getSegmentationMode()

useInputSegmentation has been deprecated.

The configured segment size is always used.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-segmentationmode

getSendDelayMs

@Stability(Stable)
@Nullable
default Number getSendDelayMs()

The number of milliseconds to delay the output from the second pipeline.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-senddelayms

getSparseTrackType

@Stability(Stable)
@Nullable
default String getSparseTrackType()

If set to scte35, uses incoming SCTE-35 messages to generate a sparse track in this group of Microsoft Smooth outputs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-sparsetracktype

getStreamManifestBehavior

@Stability(Stable)
@Nullable
default String getStreamManifestBehavior()

When set to send, sends a stream manifest so that the publishing point doesn't start until all streams start.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-streammanifestbehavior

getTimestampOffset

@Stability(Stable)
@Nullable
default String getTimestampOffset()

The timestamp offset for the channel.

Used only if timestampOffsetMode is set to useConfiguredOffset.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-timestampoffset

getTimestampOffsetMode

@Stability(Stable)
@Nullable
default String getTimestampOffsetMode()

The type of timestamp date offset to use.

• useEventStartDate: Use the date the channel was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-mssmoothgroupsettings.html#cfn-medialive-channel-mssmoothgroupsettings-timestampoffsetmode

builder

@Stability(Stable)
static CfnChannel.MsSmoothGroupSettingsProperty.Builder builder()

Returns:

a CfnChannel.MsSmoothGroupSettingsProperty.Builder of CfnChannel.MsSmoothGroupSettingsProperty