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:

  • Method Details

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.

    • 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