Class MsSmoothGroupSettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MsSmoothGroupSettings.Builder,
MsSmoothGroupSettings>
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ID to include in each message in the sparse track.If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode.final String
If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode.builder()
If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA).final String
If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA).final Integer
Number of seconds to wait before retrying connection to the IIS server if the connection is lost.final OutputLocationRef
Smooth Streaming publish point on an IIS server.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
eventId()
MS Smooth event ID to be sent to the IIS server.final SmoothGroupEventIdMode
Specifies whether or not to send an event ID to the IIS server.final String
Specifies whether or not to send an event ID to the IIS server.When set to sendEos, send EOS signal to IIS server when stopping the eventfinal String
When set to sendEos, send EOS signal to IIS server when stopping the eventfinal Integer
Size in seconds of file cache for streaming outputs.final Integer
Length of mp4 fragments to generate (in seconds).final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
Parameter that control output group behavior on input loss.final String
Parameter that control output group behavior on input loss.final Integer
Number of retry attempts.final Integer
Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.useInputSegmentation has been deprecated.final String
useInputSegmentation has been deprecated.final Integer
Number of milliseconds to delay the output from the second pipeline.static Class
<? extends MsSmoothGroupSettings.Builder> Identifies the type of data to place in the sparse track: - SCTE35: Insert SCTE-35 messages from the source content.final String
Identifies the type of data to place in the sparse track: - SCTE35: Insert SCTE-35 messages from the source content.When set to send, send stream manifest so publishing point doesn't start until all streams start.final String
When set to send, send stream manifest so publishing point doesn't start until all streams start.final String
Timestamp offset for the event.Type of timestamp date offset to use.final String
Type of timestamp date offset to use.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 returnSmoothGroupAudioOnlyTimecodeControl.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaudioOnlyTimecodeControlAsString()
.- 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
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 returnSmoothGroupAudioOnlyTimecodeControl.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaudioOnlyTimecodeControlAsString()
.- 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
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 returnSmoothGroupCertificateMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcertificateModeAsString()
.- 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
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 returnSmoothGroupCertificateMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcertificateModeAsString()
.- 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
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
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
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
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 returnSmoothGroupEventIdMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventIdModeAsString()
.- 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
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 returnSmoothGroupEventIdMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventIdModeAsString()
.- 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
When set to sendEos, send EOS signal to IIS server when stopping the eventIf the service returns an enum value that is not available in the current SDK version,
eventStopBehavior
will returnSmoothGroupEventStopBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventStopBehaviorAsString()
.- Returns:
- When set to sendEos, send EOS signal to IIS server when stopping the event
- See Also:
-
eventStopBehaviorAsString
When set to sendEos, send EOS signal to IIS server when stopping the eventIf the service returns an enum value that is not available in the current SDK version,
eventStopBehavior
will returnSmoothGroupEventStopBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventStopBehaviorAsString()
.- Returns:
- When set to sendEos, send EOS signal to IIS server when stopping the event
- See Also:
-
filecacheDuration
Size in seconds of file cache for streaming outputs.- Returns:
- Size in seconds of file cache for streaming outputs.
-
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
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 returnInputLossActionForMsSmoothOut.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominputLossActionAsString()
.- Returns:
- Parameter that control output group behavior on input loss.
- See Also:
-
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 returnInputLossActionForMsSmoothOut.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominputLossActionAsString()
.- Returns:
- Parameter that control output group behavior on input loss.
- See Also:
-
numRetries
Number of retry attempts.- Returns:
- Number of retry attempts.
-
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
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 returnSmoothGroupSegmentationMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsegmentationModeAsString()
.- Returns:
- useInputSegmentation has been deprecated. The configured segment size is always used.
- See Also:
-
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 returnSmoothGroupSegmentationMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsegmentationModeAsString()
.- Returns:
- useInputSegmentation has been deprecated. The configured segment size is always used.
- See Also:
-
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
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 returnSmoothGroupSparseTrackType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsparseTrackTypeAsString()
.- 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
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 returnSmoothGroupSparseTrackType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsparseTrackTypeAsString()
.- 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
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 returnSmoothGroupStreamManifestBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstreamManifestBehaviorAsString()
.- Returns:
- When set to send, send stream manifest so publishing point doesn't start until all streams start.
- See Also:
-
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 returnSmoothGroupStreamManifestBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstreamManifestBehaviorAsString()
.- Returns:
- When set to send, send stream manifest so publishing point doesn't start until all streams start.
- See Also:
-
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
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 offsetIf the service returns an enum value that is not available in the current SDK version,
timestampOffsetMode
will returnSmoothGroupTimestampOffsetMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtimestampOffsetModeAsString()
.- 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
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 offsetIf the service returns an enum value that is not available in the current SDK version,
timestampOffsetMode
will returnSmoothGroupTimestampOffsetMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtimestampOffsetModeAsString()
.- 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
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 interfaceToCopyableBuilder<MsSmoothGroupSettings.Builder,
MsSmoothGroupSettings> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-