Class MedicalScribeAudioEvent

java.lang.Object
software.amazon.awssdk.services.transcribestreaming.model.MedicalScribeAudioEvent
All Implemented Interfaces:
Serializable, SdkPojo, MedicalScribeInputStream, ToCopyableBuilder<MedicalScribeAudioEvent.Builder,MedicalScribeAudioEvent>
Direct Known Subclasses:
DefaultAudioEvent
@Generated("software.amazon.awssdk:codegen") public class MedicalScribeAudioEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MedicalScribeAudioEvent.Builder,MedicalScribeAudioEvent>, MedicalScribeInputStream

A wrapper for your 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 MedicalScribeAudioEvent.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<MedicalScribeAudioEvent.Builder,MedicalScribeAudioEvent>
      Returns:
      a builder for type T

    • builder

      public static MedicalScribeAudioEvent.Builder builder()

    • serializableBuilderClass

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