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(value=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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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 Detail

getAcquisitionPointId

@Stability(value=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."

getAudioOnlyTimecodeControl

@Stability(value=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.

getCertificateMode

@Stability(value=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.

getConnectionRetryInterval

@Stability(value=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.

getDestination

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

The Smooth Streaming publish point on an IIS server.

MediaLive acts as a "Push" encoder to IIS.

getEventId

@Stability(value=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.

getEventIdMode

@Stability(value=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.

getEventStopBehavior

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

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

getFilecacheDuration

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

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

getFragmentLength

@Stability(value=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.

getInputLossAction

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

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

getNumRetries

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

The number of retry attempts.

getRestartDelay

@Stability(value=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.

getSegmentationMode

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

useInputSegmentation has been deprecated.

The configured segment size is always used.

getSendDelayMs

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

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

getSparseTrackType

@Stability(value=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.

getStreamManifestBehavior

@Stability(value=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.

getTimestampOffset

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

The timestamp offset for the channel.

Used only if timestampOffsetMode is set to useConfiguredOffset.

getTimestampOffsetMode

@Stability(value=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.

builder

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

Returns:

a CfnChannel.MsSmoothGroupSettingsProperty.Builder of CfnChannel.MsSmoothGroupSettingsProperty