software.amazon.awssdk.services.transcribestreaming.model

Class AudioEvent

java.lang.Object

software.amazon.awssdk.services.transcribestreaming.model.AudioEvent

All Implemented Interfaces:

Serializable, SdkPojo, AudioStream, ToCopyableBuilder<AudioEvent.Builder,AudioEvent>

@Generated(value="software.amazon.awssdk:codegen")
public class AudioEvent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AudioEvent.Builder,AudioEvent>, AudioStream

Provides a wrapper for the audio chunks that you are sending.

For information on audio encoding in Amazon Transcribe, see Speech input. For information on audio encoding formats in Amazon Transcribe Medical, see Speech input.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AudioEvent.Builder

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.transcribestreaming.model.AudioStream

AudioStream.EventType

Method Summary

Modifier and Type	Method and Description
SdkBytes	audioChunk() An audio blob that contains the next part of the audio that you want to transcribe.
static AudioEvent.Builder	builder()
AudioEvent	copy(Consumer<? super AudioEvent.Builder> modifier) A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build().
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
AudioStream.EventType	sdkEventType() The type of this event.
List<SdkField<?>>	sdkFields()
static Class<? extends AudioEvent.Builder>	serializableBuilderClass()
AudioEvent.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.services.transcribestreaming.model.AudioStream

audioEventBuilder

Method Detail

audioChunk

public final SdkBytes audioChunk()

An audio blob that contains the next part of the audio that you want to transcribe. The maximum audio chunk size is 32 KB.

Returns:

An audio blob that contains the next part of the audio that you want to transcribe. The maximum audio chunk size is 32 KB.

toBuilder

public AudioEvent.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<AudioEvent.Builder,AudioEvent>

Returns:

a builder for type T

builder

public static AudioEvent.Builder builder()

serializableBuilderClass

public static Class<? extends AudioEvent.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 AudioEvent copy(Consumer<? super AudioEvent.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<AudioEvent.Builder,AudioEvent>

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.

sdkEventType

public AudioStream.EventType sdkEventType()

Description copied from interface: AudioStream

The type of this event. Corresponds to the :event-type header on the Message.

Specified by:

sdkEventType in interface AudioStream