Class AudioInputEvent

java.lang.Object
software.amazon.awssdk.services.lexruntimev2.model.AudioInputEvent
All Implemented Interfaces:
Serializable, SdkPojo, StartConversationRequestEventStream, ToCopyableBuilder<AudioInputEvent.Builder,AudioInputEvent>
Direct Known Subclasses:
DefaultAudioInputEvent
@Generated("software.amazon.awssdk:codegen") public class AudioInputEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AudioInputEvent.Builder,AudioInputEvent>, StartConversationRequestEventStream

Represents a chunk of audio sent from the client application to Amazon Lex V2. The audio is all or part of an utterance from the user.

Amazon Lex V2 accumulates audio chunks until it recognizes a natural pause in speech before processing the input.

See Also:

  • Method Details

    • audioChunk

      public final SdkBytes audioChunk()

      An encoded stream of audio.

      Returns:
      An encoded stream of audio.

    • contentType

      public final String contentType()

      The encoding used for the audio chunk. You must use 8 KHz PCM 16-bit mono-channel little-endian format. The value of the field should be:

      audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

      Returns:
      The encoding used for the audio chunk. You must use 8 KHz PCM 16-bit mono-channel little-endian format. The value of the field should be:

      audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

    • eventId

      public final String eventId()

      A unique identifier that your application assigns to the event. You can use this to identify events in logs.

      Returns:
      A unique identifier that your application assigns to the event. You can use this to identify events in logs.

    • clientTimestampMillis

      public final Long clientTimestampMillis()

      A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.

      Returns:
      A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.

    • toBuilder

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

    • builder

      public static AudioInputEvent.Builder builder()

    • serializableBuilderClass

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

    • copy

      public final AudioInputEvent copy(Consumer<? super AudioInputEvent.Builder> modifier)
      Description copied from interface: ToCopyableBuilder
      A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build(). This is useful for making small modifications to the existing object.
      Specified by:
      copy in interface ToCopyableBuilder<AudioInputEvent.Builder,AudioInputEvent>
      Parameters:
      modifier - A function that mutates this immutable object using the provided builder.
      Returns:
      A new copy of this object with the requested modifications.

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