Class AudioFillerSettings

java.lang.Object
software.amazon.awssdk.services.lexmodelsv2.model.AudioFillerSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AudioFillerSettings.Builder,AudioFillerSettings>
@Generated("software.amazon.awssdk:codegen") public final class AudioFillerSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AudioFillerSettings.Builder,AudioFillerSettings>

Configuration that plays background filler audio during speech-to-speech interactions to mask processing delays and improve the perceived responsiveness of the bot.

Audio filler requires unifiedSpeechSettings (speech-to-speech) to be enabled on the bot locale when enabled is true.

See Also:

  • Method Details

    • enabled

      public final Boolean enabled()

      Specifies whether audio filler playback is enabled for the bot locale. Set to true to play filler audio while Amazon Lex processes a user utterance. Set to false to disable filler audio.

      Returns:
      Specifies whether audio filler playback is enabled for the bot locale. Set to true to play filler audio while Amazon Lex processes a user utterance. Set to false to disable filler audio.

    • audioType

      public final AudioFillerType audioType()

      The identifier of the audio filler to play while Amazon Lex processes the user's input. This field is required when enabled is true.

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

      Returns:
      The identifier of the audio filler to play while Amazon Lex processes the user's input. This field is required when enabled is true.
      See Also:

    • audioTypeAsString

      public final String audioTypeAsString()

      The identifier of the audio filler to play while Amazon Lex processes the user's input. This field is required when enabled is true.

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

      Returns:
      The identifier of the audio filler to play while Amazon Lex processes the user's input. This field is required when enabled is true.
      See Also:

    • startDelayInMilliseconds

      public final Integer startDelayInMilliseconds()

      The time, in milliseconds, to wait after the end of the user's utterance before starting audio filler playback. Valid range is 500 to 5000 milliseconds. If not specified, Amazon Lex uses a default of 2500 milliseconds.

      Returns:
      The time, in milliseconds, to wait after the end of the user's utterance before starting audio filler playback. Valid range is 500 to 5000 milliseconds. If not specified, Amazon Lex uses a default of 2500 milliseconds.

    • minimumPlayDurationInMilliseconds

      public final Integer minimumPlayDurationInMilliseconds()

      The minimum time, in milliseconds, that audio filler plays once it has started, even if the bot response becomes ready sooner. Valid range is 1000 to 5000 milliseconds. If not specified, Amazon Lex uses a default of 3000 milliseconds.

      Returns:
      The minimum time, in milliseconds, that audio filler plays once it has started, even if the bot response becomes ready sooner. Valid range is 1000 to 5000 milliseconds. If not specified, Amazon Lex uses a default of 3000 milliseconds.

    • responseDeliveryDelayInMilliseconds

      public final Integer responseDeliveryDelayInMilliseconds()

      The silent delay, in milliseconds, inserted between the end of audio filler playback and the start of the bot's response. Valid range is 200 to 1000 milliseconds. If not specified, Amazon Lex uses a default of 500 milliseconds.

      Returns:
      The silent delay, in milliseconds, inserted between the end of audio filler playback and the start of the bot's response. Valid range is 200 to 1000 milliseconds. If not specified, Amazon Lex uses a default of 500 milliseconds.

    • toBuilder

      public AudioFillerSettings.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<AudioFillerSettings.Builder,AudioFillerSettings>
      Returns:
      a builder for type T

    • builder

      public static AudioFillerSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AudioFillerSettings.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.