Class AudioEvent
- java.lang.Object
-
- software.amazon.awssdk.services.transcribestreaming.model.AudioEvent
-
- All Implemented Interfaces:
Serializable,SdkPojo,AudioStream,ToCopyableBuilder<AudioEvent.Builder,AudioEvent>
@Generated("software.amazon.awssdk:codegen") public class AudioEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AudioEvent.Builder,AudioEvent>, AudioStream
A wrapper for your audio chunks. Your audio stream consists of one or more audio events, which consist of one or more audio chunks.
For more information, see Event stream encoding.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAudioEvent.Builderprotected static classAudioEvent.BuilderImpl-
Nested classes/interfaces inherited from interface software.amazon.awssdk.services.transcribestreaming.model.AudioStream
AudioStream.EventType
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedAudioEvent(AudioEvent.BuilderImpl builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SdkBytesaudioChunk()An audio blob containing the next segment of audio from your application, with a maximum duration of 1 second.static AudioEvent.Builderbuilder()AudioEventcopy(Consumer<? super AudioEvent.Builder> modifier)booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()AudioStream.EventTypesdkEventType()The type of this event.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends AudioEvent.Builder>serializableBuilderClass()AudioEvent.BuildertoBuilder()StringtoString()Returns a string representation of this object.
-
-
-
Constructor Detail
-
AudioEvent
protected AudioEvent(AudioEvent.BuilderImpl builder)
-
-
Method Detail
-
audioChunk
public final SdkBytes audioChunk()
An audio blob containing the next segment of audio from your application, with a maximum duration of 1 second. The maximum size in bytes varies based on audio properties.
Find recommended size in Transcribing streaming best practices.
Size calculation:
Duration (s) * Sample Rate (Hz) * Number of Channels * 2 (Bytes per Sample)For example, a 1-second chunk of 16 kHz, 2-channel, 16-bit audio would be
1 * 16000 * 2 * 2 = 64000 bytes.For 8 kHz, 1-channel, 16-bit audio, a 1-second chunk would be
1 * 8000 * 1 * 2 = 16000 bytes.- Returns:
- An audio blob containing the next segment of audio from your application, with a maximum duration of 1
second. The maximum size in bytes varies based on audio properties.
Find recommended size in Transcribing streaming best practices.
Size calculation:
Duration (s) * Sample Rate (Hz) * Number of Channels * 2 (Bytes per Sample)For example, a 1-second chunk of 16 kHz, 2-channel, 16-bit audio would be
1 * 16000 * 2 * 2 = 64000 bytes.For 8 kHz, 1-channel, 16-bit audio, a 1-second chunk would be
1 * 8000 * 1 * 2 = 16000 bytes.
-
toBuilder
public AudioEvent.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AudioEvent.Builder,AudioEvent>
-
builder
public static AudioEvent.Builder builder()
-
serializableBuilderClass
public static Class<? extends AudioEvent.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
copy
public final AudioEvent copy(Consumer<? super AudioEvent.Builder> modifier)
- Specified by:
copyin interfaceToCopyableBuilder<AudioEvent.Builder,AudioEvent>
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
sdkEventType
public AudioStream.EventType sdkEventType()
Description copied from interface:AudioStreamThe type of this event. Corresponds to the:event-typeheader on the Message.- Specified by:
sdkEventTypein interfaceAudioStream
-
-