Class AudioEvent
- All Implemented Interfaces:
Serializable
,SdkPojo
,AudioStream
,ToCopyableBuilder<AudioEvent.Builder,
AudioEvent>
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:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface software.amazon.awssdk.services.transcribestreaming.model.AudioStream
AudioStream.EventType
-
Method Summary
Modifier and TypeMethodDescriptionfinal SdkBytes
An audio blob containing the next segment of audio from your application, with a maximum duration of 1 second.static AudioEvent.Builder
builder()
final AudioEvent
copy
(Consumer<? super AudioEvent.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 <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
The type of this event.static Class
<? extends AudioEvent.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.
-
Method Details
-
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
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<AudioEvent.Builder,
AudioEvent> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
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
-
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<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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-
sdkEventType
Description copied from interface:AudioStream
The type of this event. Corresponds to the:event-type
header on the Message.- Specified by:
sdkEventType
in interfaceAudioStream
-