Documentation

Ms Smooth Group Settings

See: newMsSmoothGroupSettings smart constructor.

Create a value of MsSmoothGroupSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fragmentLength:MsSmoothGroupSettings', msSmoothGroupSettings_fragmentLength - Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.

$sel:streamManifestBehavior:MsSmoothGroupSettings', msSmoothGroupSettings_streamManifestBehavior - When set to send, send stream manifest so publishing point doesn't start until all streams start.

$sel:sendDelayMs:MsSmoothGroupSettings', msSmoothGroupSettings_sendDelayMs - Number of milliseconds to delay the output from the second pipeline.

$sel:eventStopBehavior:MsSmoothGroupSettings', msSmoothGroupSettings_eventStopBehavior - When set to sendEos, send EOS signal to IIS server when stopping the event

$sel:timestampOffsetMode:MsSmoothGroupSettings', msSmoothGroupSettings_timestampOffsetMode - Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset

$sel:numRetries:MsSmoothGroupSettings', msSmoothGroupSettings_numRetries - Number of retry attempts.

$sel:acquisitionPointId:MsSmoothGroupSettings', msSmoothGroupSettings_acquisitionPointId - The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE.

$sel:inputLossAction:MsSmoothGroupSettings', msSmoothGroupSettings_inputLossAction - Parameter that control output group behavior on input loss.

$sel:timestampOffset:MsSmoothGroupSettings', msSmoothGroupSettings_timestampOffset - Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.

$sel:certificateMode:MsSmoothGroupSettings', msSmoothGroupSettings_certificateMode - If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail.

$sel:sparseTrackType:MsSmoothGroupSettings', msSmoothGroupSettings_sparseTrackType - Identifies the type of data to place in the sparse track: - SCTE35: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame to start a new segment. - SCTE35_WITHOUT_SEGMENTATION: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame but don't start a new segment. - NONE: Don't generate a sparse track for any outputs in this output group.

$sel:connectionRetryInterval:MsSmoothGroupSettings', msSmoothGroupSettings_connectionRetryInterval - Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.

$sel:filecacheDuration:MsSmoothGroupSettings', msSmoothGroupSettings_filecacheDuration - Size in seconds of file cache for streaming outputs.

$sel:restartDelay:MsSmoothGroupSettings', msSmoothGroupSettings_restartDelay - Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.

$sel:eventIdMode:MsSmoothGroupSettings', msSmoothGroupSettings_eventIdMode - Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event 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 an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server.

$sel:audioOnlyTimecodeControl:MsSmoothGroupSettings', msSmoothGroupSettings_audioOnlyTimecodeControl - If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream.

$sel:segmentationMode:MsSmoothGroupSettings', msSmoothGroupSettings_segmentationMode - useInputSegmentation has been deprecated. The configured segment size is always used.

$sel:eventId:MsSmoothGroupSettings', msSmoothGroupSettings_eventId - MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.

$sel:destination:MsSmoothGroupSettings', msSmoothGroupSettings_destination - Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.

Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.

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

Number of milliseconds to delay the output from the second pipeline.

When set to sendEos, send EOS signal to IIS server when stopping the event

Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset

Number of retry attempts.

The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE.

Parameter that control output group behavior on input loss.

Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.

If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail.

Identifies the type of data to place in the sparse track: - SCTE35: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame to start a new segment. - SCTE35_WITHOUT_SEGMENTATION: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame but don't start a new segment. - NONE: Don't generate a sparse track for any outputs in this output group.

Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.

Size in seconds of file cache for streaming outputs.

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

Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event 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 an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server.

If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream.

useInputSegmentation has been deprecated. The configured segment size is always used.

MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.

Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.