software.amazon.awssdk.services.medialive.model

Class MsSmoothGroupSettings

java.lang.Object

software.amazon.awssdk.services.medialive.model.MsSmoothGroupSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MsSmoothGroupSettings.Builder,MsSmoothGroupSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class MsSmoothGroupSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MsSmoothGroupSettings.Builder,MsSmoothGroupSettings>

Ms Smooth Group Settings

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MsSmoothGroupSettings.Builder

Method Summary

Modifier and Type	Method and Description
String	acquisitionPointId() The ID to include in each message in the sparse track.
SmoothGroupAudioOnlyTimecodeControl	audioOnlyTimecodeControl() If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode.
String	audioOnlyTimecodeControlAsString() If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode.
static MsSmoothGroupSettings.Builder	builder()
SmoothGroupCertificateMode	certificateMode() If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA).
String	certificateModeAsString() If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA).
Integer	connectionRetryInterval() Number of seconds to wait before retrying connection to the IIS server if the connection is lost.
OutputLocationRef	destination() Smooth Streaming publish point on an IIS server.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventId() MS Smooth event ID to be sent to the IIS server.
SmoothGroupEventIdMode	eventIdMode() Specifies whether or not to send an event ID to the IIS server.
String	eventIdModeAsString() Specifies whether or not to send an event ID to the IIS server.
SmoothGroupEventStopBehavior	eventStopBehavior() When set to sendEos, send EOS signal to IIS server when stopping the event
String	eventStopBehaviorAsString() When set to sendEos, send EOS signal to IIS server when stopping the event
Integer	filecacheDuration() Size in seconds of file cache for streaming outputs.
Integer	fragmentLength() Length of mp4 fragments to generate (in seconds).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InputLossActionForMsSmoothOut	inputLossAction() Parameter that control output group behavior on input loss.
String	inputLossActionAsString() Parameter that control output group behavior on input loss.
Integer	numRetries() Number of retry attempts.
Integer	restartDelay() Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
List<SdkField<?>>	sdkFields()
SmoothGroupSegmentationMode	segmentationMode() useInputSegmentation has been deprecated.
String	segmentationModeAsString() useInputSegmentation has been deprecated.
Integer	sendDelayMs() Number of milliseconds to delay the output from the second pipeline.
static Class<? extends MsSmoothGroupSettings.Builder>	serializableBuilderClass()
SmoothGroupSparseTrackType	sparseTrackType() Identifies the type of data to place in the sparse track: - SCTE35: Insert SCTE-35 messages from the source content.
String	sparseTrackTypeAsString() Identifies the type of data to place in the sparse track: - SCTE35: Insert SCTE-35 messages from the source content.
SmoothGroupStreamManifestBehavior	streamManifestBehavior() When set to send, send stream manifest so publishing point doesn't start until all streams start.
String	streamManifestBehaviorAsString() When set to send, send stream manifest so publishing point doesn't start until all streams start.
String	timestampOffset() Timestamp offset for the event.
SmoothGroupTimestampOffsetMode	timestampOffsetMode() Type of timestamp date offset to use.
String	timestampOffsetModeAsString() Type of timestamp date offset to use.
MsSmoothGroupSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

acquisitionPointId

public final String acquisitionPointId()

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

Returns:

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

audioOnlyTimecodeControl

public final SmoothGroupAudioOnlyTimecodeControl 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.

If the service returns an enum value that is not available in the current SDK version, audioOnlyTimecodeControl will return SmoothGroupAudioOnlyTimecodeControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from audioOnlyTimecodeControlAsString().

Returns:

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.

See Also:

SmoothGroupAudioOnlyTimecodeControl

audioOnlyTimecodeControlAsString

public final String audioOnlyTimecodeControlAsString()

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.

If the service returns an enum value that is not available in the current SDK version, audioOnlyTimecodeControl will return SmoothGroupAudioOnlyTimecodeControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from audioOnlyTimecodeControlAsString().

Returns:

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.

See Also:

SmoothGroupAudioOnlyTimecodeControl

certificateMode

public final SmoothGroupCertificateMode 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.

If the service returns an enum value that is not available in the current SDK version, certificateMode will return SmoothGroupCertificateMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from certificateModeAsString().

Returns:

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.

See Also:

SmoothGroupCertificateMode

certificateModeAsString

public final String certificateModeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, certificateMode will return SmoothGroupCertificateMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from certificateModeAsString().

Returns:

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.

See Also:

SmoothGroupCertificateMode

connectionRetryInterval

public final Integer 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.

Returns:

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.

destination

public final OutputLocationRef destination()

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

Returns:

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

eventId

public final String eventId()

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

Returns:

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

eventIdMode

public final SmoothGroupEventIdMode 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.

If the service returns an enum value that is not available in the current SDK version, eventIdMode will return SmoothGroupEventIdMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventIdModeAsString().

Returns:

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.

See Also:

SmoothGroupEventIdMode

eventIdModeAsString

public final String eventIdModeAsString()

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 the service returns an enum value that is not available in the current SDK version, eventIdMode will return SmoothGroupEventIdMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventIdModeAsString().

Returns:

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.

See Also:

SmoothGroupEventIdMode

eventStopBehavior

public final SmoothGroupEventStopBehavior eventStopBehavior()

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

If the service returns an enum value that is not available in the current SDK version, eventStopBehavior will return SmoothGroupEventStopBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventStopBehaviorAsString().

Returns:

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

See Also:

SmoothGroupEventStopBehavior

eventStopBehaviorAsString

public final String eventStopBehaviorAsString()

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

If the service returns an enum value that is not available in the current SDK version, eventStopBehavior will return SmoothGroupEventStopBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventStopBehaviorAsString().

Returns:

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

See Also:

SmoothGroupEventStopBehavior

filecacheDuration

public final Integer filecacheDuration()

Size in seconds of file cache for streaming outputs.

Returns:

Size in seconds of file cache for streaming outputs.

fragmentLength

public final Integer fragmentLength()

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

Returns:

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

inputLossAction

public final InputLossActionForMsSmoothOut inputLossAction()

Parameter that control output group behavior on input loss.

If the service returns an enum value that is not available in the current SDK version, inputLossAction will return InputLossActionForMsSmoothOut.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputLossActionAsString().

Returns:

Parameter that control output group behavior on input loss.

See Also:

InputLossActionForMsSmoothOut

inputLossActionAsString

public final String inputLossActionAsString()

Parameter that control output group behavior on input loss.

If the service returns an enum value that is not available in the current SDK version, inputLossAction will return InputLossActionForMsSmoothOut.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputLossActionAsString().

Returns:

Parameter that control output group behavior on input loss.

See Also:

InputLossActionForMsSmoothOut

numRetries

public final Integer numRetries()

Number of retry attempts.

Returns:

Number of retry attempts.

restartDelay

public final Integer restartDelay()

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

Returns:

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

segmentationMode

public final SmoothGroupSegmentationMode segmentationMode()

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

If the service returns an enum value that is not available in the current SDK version, segmentationMode will return SmoothGroupSegmentationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from segmentationModeAsString().

Returns:

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

See Also:

SmoothGroupSegmentationMode

segmentationModeAsString

public final String segmentationModeAsString()

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

If the service returns an enum value that is not available in the current SDK version, segmentationMode will return SmoothGroupSegmentationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from segmentationModeAsString().

Returns:

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

See Also:

SmoothGroupSegmentationMode

sendDelayMs

public final Integer sendDelayMs()

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

Returns:

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

sparseTrackType

public final SmoothGroupSparseTrackType 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.

If the service returns an enum value that is not available in the current SDK version, sparseTrackType will return SmoothGroupSparseTrackType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sparseTrackTypeAsString().

Returns:

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.

See Also:

SmoothGroupSparseTrackType

sparseTrackTypeAsString

public final String sparseTrackTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, sparseTrackType will return SmoothGroupSparseTrackType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sparseTrackTypeAsString().

Returns:

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.

See Also:

SmoothGroupSparseTrackType

streamManifestBehavior

public final SmoothGroupStreamManifestBehavior streamManifestBehavior()

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

If the service returns an enum value that is not available in the current SDK version, streamManifestBehavior will return SmoothGroupStreamManifestBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from streamManifestBehaviorAsString().

Returns:

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

See Also:

SmoothGroupStreamManifestBehavior

streamManifestBehaviorAsString

public final String streamManifestBehaviorAsString()

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

If the service returns an enum value that is not available in the current SDK version, streamManifestBehavior will return SmoothGroupStreamManifestBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from streamManifestBehaviorAsString().

Returns:

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

See Also:

SmoothGroupStreamManifestBehavior

timestampOffset

public final String timestampOffset()

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

Returns:

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

timestampOffsetMode

public final SmoothGroupTimestampOffsetMode 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

If the service returns an enum value that is not available in the current SDK version, timestampOffsetMode will return SmoothGroupTimestampOffsetMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timestampOffsetModeAsString().

Returns:

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

See Also:

SmoothGroupTimestampOffsetMode

timestampOffsetModeAsString

public final String timestampOffsetModeAsString()

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

If the service returns an enum value that is not available in the current SDK version, timestampOffsetMode will return SmoothGroupTimestampOffsetMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timestampOffsetModeAsString().

Returns:

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

See Also:

SmoothGroupTimestampOffsetMode

toBuilder

public MsSmoothGroupSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MsSmoothGroupSettings.Builder,MsSmoothGroupSettings>

builder

public static MsSmoothGroupSettings.Builder builder()

serializableBuilderClass

public static Class<? extends MsSmoothGroupSettings.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo