Package software.amazon.awssdk.services.medialive.model

Interface MsSmoothGroupSettings.Builder

All Superinterfaces:
Buildable, CopyableBuilder<MsSmoothGroupSettings.Builder,MsSmoothGroupSettings>, SdkBuilder<MsSmoothGroupSettings.Builder,MsSmoothGroupSettings>, SdkPojo
Enclosing class:
MsSmoothGroupSettings
public static interface MsSmoothGroupSettings.Builder extends SdkPojo, CopyableBuilder<MsSmoothGroupSettings.Builder,MsSmoothGroupSettings>

  • Method Details

    • acquisitionPointId

      MsSmoothGroupSettings.Builder acquisitionPointId(String acquisitionPointId)
      The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE.
      Parameters:
      acquisitionPointId - The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • audioOnlyTimecodeControl

      MsSmoothGroupSettings.Builder audioOnlyTimecodeControl(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • audioOnlyTimecodeControl

      MsSmoothGroupSettings.Builder audioOnlyTimecodeControl(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • certificateMode

      MsSmoothGroupSettings.Builder certificateMode(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • certificateMode

      MsSmoothGroupSettings.Builder certificateMode(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • connectionRetryInterval

      MsSmoothGroupSettings.Builder connectionRetryInterval(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • destination

      MsSmoothGroupSettings.Builder destination(OutputLocationRef destination)
      Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
      Parameters:
      destination - Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destination

      default MsSmoothGroupSettings.Builder destination(Consumer<OutputLocationRef.Builder> destination)
      Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS. This is a convenience method that creates an instance of the OutputLocationRef.Builder avoiding the need to create one manually via OutputLocationRef.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destination(OutputLocationRef).

      Parameters:
      destination - a consumer that will call methods on OutputLocationRef.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • eventId

      MsSmoothGroupSettings.Builder eventId(String eventId)
      MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
      Parameters:
      eventId - MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventIdMode

      MsSmoothGroupSettings.Builder eventIdMode(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • eventIdMode

      MsSmoothGroupSettings.Builder eventIdMode(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • eventStopBehavior

      MsSmoothGroupSettings.Builder eventStopBehavior(String eventStopBehavior)
      When set to sendEos, send EOS signal to IIS server when stopping the event
      Parameters:
      eventStopBehavior - When set to sendEos, send EOS signal to IIS server when stopping the event
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • eventStopBehavior

      MsSmoothGroupSettings.Builder eventStopBehavior(SmoothGroupEventStopBehavior eventStopBehavior)
      When set to sendEos, send EOS signal to IIS server when stopping the event
      Parameters:
      eventStopBehavior - When set to sendEos, send EOS signal to IIS server when stopping the event
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • filecacheDuration

      MsSmoothGroupSettings.Builder filecacheDuration(Integer filecacheDuration)
      Size in seconds of file cache for streaming outputs.
      Parameters:
      filecacheDuration - Size in seconds of file cache for streaming outputs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fragmentLength

      MsSmoothGroupSettings.Builder fragmentLength(Integer fragmentLength)
      Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
      Parameters:
      fragmentLength - Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputLossAction

      MsSmoothGroupSettings.Builder inputLossAction(String inputLossAction)
      Parameter that control output group behavior on input loss.
      Parameters:
      inputLossAction - Parameter that control output group behavior on input loss.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • inputLossAction

      MsSmoothGroupSettings.Builder inputLossAction(InputLossActionForMsSmoothOut inputLossAction)
      Parameter that control output group behavior on input loss.
      Parameters:
      inputLossAction - Parameter that control output group behavior on input loss.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • numRetries

      MsSmoothGroupSettings.Builder numRetries(Integer numRetries)
      Number of retry attempts.
      Parameters:
      numRetries - Number of retry attempts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • restartDelay

      MsSmoothGroupSettings.Builder restartDelay(Integer restartDelay)
      Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
      Parameters:
      restartDelay - Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segmentationMode

      MsSmoothGroupSettings.Builder segmentationMode(String segmentationMode)
      useInputSegmentation has been deprecated. The configured segment size is always used.
      Parameters:
      segmentationMode - useInputSegmentation has been deprecated. The configured segment size is always used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • segmentationMode

      MsSmoothGroupSettings.Builder segmentationMode(SmoothGroupSegmentationMode segmentationMode)
      useInputSegmentation has been deprecated. The configured segment size is always used.
      Parameters:
      segmentationMode - useInputSegmentation has been deprecated. The configured segment size is always used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sendDelayMs

      MsSmoothGroupSettings.Builder sendDelayMs(Integer sendDelayMs)
      Number of milliseconds to delay the output from the second pipeline.
      Parameters:
      sendDelayMs - Number of milliseconds to delay the output from the second pipeline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sparseTrackType

      MsSmoothGroupSettings.Builder sparseTrackType(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sparseTrackType

      MsSmoothGroupSettings.Builder sparseTrackType(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • streamManifestBehavior

      MsSmoothGroupSettings.Builder streamManifestBehavior(String streamManifestBehavior)
      When set to send, send stream manifest so publishing point doesn't start until all streams start.
      Parameters:
      streamManifestBehavior - When set to send, send stream manifest so publishing point doesn't start until all streams start.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • streamManifestBehavior

      MsSmoothGroupSettings.Builder streamManifestBehavior(SmoothGroupStreamManifestBehavior streamManifestBehavior)
      When set to send, send stream manifest so publishing point doesn't start until all streams start.
      Parameters:
      streamManifestBehavior - When set to send, send stream manifest so publishing point doesn't start until all streams start.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timestampOffset

      MsSmoothGroupSettings.Builder timestampOffset(String timestampOffset)
      Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
      Parameters:
      timestampOffset - Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timestampOffsetMode

      MsSmoothGroupSettings.Builder timestampOffsetMode(String 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
      Parameters:
      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
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timestampOffsetMode

      MsSmoothGroupSettings.Builder timestampOffsetMode(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
      Parameters:
      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
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: