MsSmoothGroupSettings (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.medialive.model.MsSmoothGroupSettings

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<MsSmoothGroupSettings.Builder,MsSmoothGroupSettings>

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

Placeholder documentation for MsSmoothGroupSettings

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface MsSmoothGroupSettings.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MsSmoothGroupSettings.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`acquisitionPointId()` The value of the "Acquisition Point Identity" element used in each message placed 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)`
`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.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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.
`SmoothGroupSegmentationMode`	`segmentationMode()` When set to useInputSegmentation, the output segment or fragment points are set by the RAI markers from the input streams.
`String`	`segmentationModeAsString()` When set to useInputSegmentation, the output segment or fragment points are set by the RAI markers from the input streams.
`Integer`	`sendDelayMs()` Outputs that are "output locked" can use this delay.
`static Class<? extends MsSmoothGroupSettings.Builder>`	`serializableBuilderClass()`
`SmoothGroupSparseTrackType`	`sparseTrackType()` If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.
`String`	`sparseTrackTypeAsString()` If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.
`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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - acquisitionPointId
```
public String acquisitionPointId()
```
    The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
    
    Returns:
    
    The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
  - audioOnlyTimecodeControl
```
public 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 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 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 unless those certificates are manually added to the OS trusted keystore.
    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 unless those certificates are manually added to the OS trusted keystore.
    
    See Also:
    
    SmoothGroupCertificateMode
  - certificateModeAsString
```
public 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 unless those certificates are manually added to the OS trusted keystore.
    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 unless those certificates are manually added to the OS trusted keystore.
    
    See Also:
    
    SmoothGroupCertificateMode
  - connectionRetryInterval
```
public 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 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 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 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 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 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 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 Integer filecacheDuration()
```
    Size in seconds of file cache for streaming outputs.
    
    Returns:
    
    Size in seconds of file cache for streaming outputs.
  - fragmentLength
```
public 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 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 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 Integer numRetries()
```
    Number of retry attempts.
    
    Returns:
    
    Number of retry attempts.
  - restartDelay
```
public 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 SmoothGroupSegmentationMode segmentationMode()
```
    When set to useInputSegmentation, the output segment or fragment points are set by the RAI markers from the input streams.
    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:
    
    When set to useInputSegmentation, the output segment or fragment points are set by the RAI markers from the input streams.
    
    See Also:
    
    SmoothGroupSegmentationMode
  - segmentationModeAsString
```
public String segmentationModeAsString()
```
    When set to useInputSegmentation, the output segment or fragment points are set by the RAI markers from the input streams.
    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:
    
    When set to useInputSegmentation, the output segment or fragment points are set by the RAI markers from the input streams.
    
    See Also:
    
    SmoothGroupSegmentationMode
  - sendDelayMs
```
public Integer sendDelayMs()
```
    Outputs that are "output locked" can use this delay. Assign a delay to the output that is "secondary". Do not assign a delay to the "primary" output. The delay means that the primary output will always reach the downstream system before the secondary, which helps ensure that the downstream system always uses the primary output. (If there were no delay, the downstream system might flip-flop between whichever output happens to arrive first.) If the primary fails, the downstream system will switch to the secondary output. When the primary is restarted, the downstream system will switch back to the primary (because once again it is always arriving first)
    
    Returns:
    
    Outputs that are "output locked" can use this delay. Assign a delay to the output that is "secondary". Do not assign a delay to the "primary" output. The delay means that the primary output will always reach the downstream system before the secondary, which helps ensure that the downstream system always uses the primary output. (If there were no delay, the downstream system might flip-flop between whichever output happens to arrive first.) If the primary fails, the downstream system will switch to the secondary output. When the primary is restarted, the downstream system will switch back to the primary (because once again it is always arriving first)
  - sparseTrackType
```
public SmoothGroupSparseTrackType sparseTrackType()
```
    If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.
    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:
    
    If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.
    
    See Also:
    
    SmoothGroupSparseTrackType
  - sparseTrackTypeAsString
```
public String sparseTrackTypeAsString()
```
    If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.
    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:
    
    If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.
    
    See Also:
    
    SmoothGroupSparseTrackType
  - streamManifestBehavior
```
public 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 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 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 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 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()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<MsSmoothGroupSettings.Builder,MsSmoothGroupSettings>
    
    Returns:
    
    a builder for type T
  - builder
```
public static MsSmoothGroupSettings.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends MsSmoothGroupSettings.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Class MsSmoothGroupSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

acquisitionPointId

audioOnlyTimecodeControl

audioOnlyTimecodeControlAsString

certificateMode

certificateModeAsString

connectionRetryInterval

destination

eventId

eventIdMode

eventIdModeAsString

eventStopBehavior

eventStopBehaviorAsString

filecacheDuration

fragmentLength

inputLossAction

inputLossActionAsString

numRetries

restartDelay

segmentationMode

segmentationModeAsString

sendDelayMs

sparseTrackType

sparseTrackTypeAsString

streamManifestBehavior

streamManifestBehaviorAsString

timestampOffset

timestampOffsetMode

timestampOffsetModeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

marshall