Class MsSmoothGroupSettings

java.lang.Object
software.amazon.awssdk.services.medialive.model.MsSmoothGroupSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MsSmoothGroupSettings.Builder,MsSmoothGroupSettings>
@Generated("software.amazon.awssdk:codegen") public final class MsSmoothGroupSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MsSmoothGroupSettings.Builder,MsSmoothGroupSettings>
Ms Smooth Group Settings
See Also:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.