aws-cdk-lib.aws_medialive.CfnChannel.MsSmoothGroupSettingsProperty

interface MsSmoothGroupSettingsProperty

LanguageType name
.NETAmazon.CDK.AWS.MediaLive.CfnChannel.MsSmoothGroupSettingsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsmedialive#CfnChannel_MsSmoothGroupSettingsProperty
Javasoftware.amazon.awscdk.services.medialive.CfnChannel.MsSmoothGroupSettingsProperty
Pythonaws_cdk.aws_medialive.CfnChannel.MsSmoothGroupSettingsProperty
TypeScript aws-cdk-lib » aws_medialive » CfnChannel » MsSmoothGroupSettingsProperty

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 { aws_medialive as medialive } from 'aws-cdk-lib';
const msSmoothGroupSettingsProperty: medialive.CfnChannel.MsSmoothGroupSettingsProperty = {
  acquisitionPointId: 'acquisitionPointId',
  audioOnlyTimecodeControl: 'audioOnlyTimecodeControl',
  certificateMode: 'certificateMode',
  connectionRetryInterval: 123,
  destination: {
    destinationRefId: 'destinationRefId',
  },
  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',
};

Properties

NameTypeDescription
acquisitionPointId?stringThe value of the Acquisition Point Identity element that is used in each message placed in the sparse track.
audioOnlyTimecodeControl?stringIf set to passthrough for an audio-only Microsoft Smooth output, the fragment absolute time is set to the current timecode.
certificateMode?stringIf set to verifyAuthenticity, verifies the HTTPS certificate chain to a trusted certificate authority (CA).
connectionRetryInterval?numberThe number of seconds to wait before retrying the connection to the IIS server if the connection is lost.
destination?IResolvable | OutputLocationRefPropertyThe Smooth Streaming publish point on an IIS server.
eventId?stringThe Microsoft Smooth channel ID that is sent to the IIS server.
eventIdMode?stringSpecifies whether to send a channel ID to the IIS server.
eventStopBehavior?stringWhen set to sendEos, sends an EOS signal to an IIS server when stopping the channel.
filecacheDuration?numberThe size, in seconds, of the file cache for streaming outputs.
fragmentLength?numberThe length, in seconds, of mp4 fragments to generate.
inputLossAction?stringA parameter that controls output group behavior on an input loss.
numRetries?numberThe number of retry attempts.
restartDelay?numberThe number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
segmentationMode?stringuseInputSegmentation has been deprecated.
sendDelayMs?numberThe number of milliseconds to delay the output from the second pipeline.
sparseTrackType?stringIf set to scte35, uses incoming SCTE-35 messages to generate a sparse track in this group of Microsoft Smooth outputs.
streamManifestBehavior?stringWhen set to send, sends a stream manifest so that the publishing point doesn't start until all streams start.
timestampOffset?stringThe timestamp offset for the channel.
timestampOffsetMode?stringThe type of timestamp date offset to use.

acquisitionPointId?

Type: string (optional)

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."


audioOnlyTimecodeControl?

Type: string (optional)

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.


certificateMode?

Type: string (optional)

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.


connectionRetryInterval?

Type: number (optional)

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.


destination?

Type: IResolvable | OutputLocationRefProperty (optional)

The Smooth Streaming publish point on an IIS server.

MediaLive acts as a "Push" encoder to IIS.


eventId?

Type: string (optional)

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

Specify the ID only if eventIdMode is set to useConfigured.


eventIdMode?

Type: string (optional)

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.


eventStopBehavior?

Type: string (optional)

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


filecacheDuration?

Type: number (optional)

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


fragmentLength?

Type: number (optional)

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

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


inputLossAction?

Type: string (optional)

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


numRetries?

Type: number (optional)

The number of retry attempts.


restartDelay?

Type: number (optional)

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


segmentationMode?

Type: string (optional)

useInputSegmentation has been deprecated.

The configured segment size is always used.


sendDelayMs?

Type: number (optional)

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


sparseTrackType?

Type: string (optional)

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


streamManifestBehavior?

Type: string (optional)

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


timestampOffset?

Type: string (optional)

The timestamp offset for the channel.

Used only if timestampOffsetMode is set to useConfiguredOffset.


timestampOffsetMode?

Type: string (optional)

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.