Class AudioInputEvent
- All Implemented Interfaces:
Serializable
,SdkPojo
,StartConversationRequestEventStream
,ToCopyableBuilder<AudioInputEvent.Builder,
AudioInputEvent>
- Direct Known Subclasses:
DefaultAudioInputEvent
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:
-
Nested Class Summary
Nested classes/interfaces inherited from interface software.amazon.awssdk.services.lexruntimev2.model.StartConversationRequestEventStream
StartConversationRequestEventStream.EventType
-
Method Summary
Modifier and TypeMethodDescriptionfinal SdkBytes
An encoded stream of audio.static AudioInputEvent.Builder
builder()
final Long
A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.final String
The encoding used for the audio chunk.final AudioInputEvent
copy
(Consumer<? super AudioInputEvent.Builder> modifier) A convenience method for callingToCopyableBuilder.toBuilder()
, updating the returned builder and then callingSdkBuilder.build()
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
eventId()
A unique identifier that your application assigns to the event.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends AudioInputEvent.Builder> 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.services.lexruntimev2.model.StartConversationRequestEventStream
sdkEventType
-
Method Details
-
audioChunk
An encoded stream of audio.
- Returns:
- An encoded stream of audio.
-
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
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
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
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<AudioInputEvent.Builder,
AudioInputEvent> - 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
-
copy
Description copied from interface:ToCopyableBuilder
A convenience method for callingToCopyableBuilder.toBuilder()
, updating the returned builder and then callingSdkBuilder.build()
. This is useful for making small modifications to the existing object.- Specified by:
copy
in interfaceToCopyableBuilder<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
-