software.amazon.awssdk.services.lexruntimev2.model

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(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AudioInputEvent.Builder
protected static class	AudioInputEvent.BuilderImpl

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.lexruntimev2.model.StartConversationRequestEventStream

StartConversationRequestEventStream.EventType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AudioInputEvent(AudioInputEvent.BuilderImpl builder)

Method Summary

Modifier and Type	Method and Description
SdkBytes	audioChunk() An encoded stream of audio.
static AudioInputEvent.Builder	builder()
Long	clientTimestampMillis() A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.
String	contentType() The encoding used for the audio chunk.
AudioInputEvent	copy(Consumer<? super AudioInputEvent.Builder> modifier)
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventId() A unique identifier that your application assigns to the event.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends AudioInputEvent.Builder>	serializableBuilderClass()
AudioInputEvent.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.services.lexruntimev2.model.StartConversationRequestEventStream

audioInputEventBuilder, configurationEventBuilder, disconnectionEventBuilder, dTMFInputEventBuilder, playbackCompletionEventBuilder, sdkEventType, textInputEventBuilder

Constructor Detail

AudioInputEvent

protected AudioInputEvent(AudioInputEvent.BuilderImpl builder)

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<AudioInputEvent.Builder,AudioInputEvent>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Specified by:

copy in interface ToCopyableBuilder<AudioInputEvent.Builder,AudioInputEvent>

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo