Class AudioConfiguration

java.lang.Object
software.amazon.awssdk.services.ivs.model.AudioConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AudioConfiguration.Builder,AudioConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class AudioConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AudioConfiguration.Builder,AudioConfiguration>

Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfigurations object and the deprecated IngestConfiguration object. It is used for monitoring stream health.

See Also:

  • Method Details

    • channels

      public final Long channels()

      Number of audio channels.

      Returns:
      Number of audio channels.

    • codec

      public final String codec()

      Codec used for the audio encoding.

      Returns:
      Codec used for the audio encoding.

    • sampleRate

      public final Long sampleRate()

      Number of audio samples recorded per second.

      Returns:
      Number of audio samples recorded per second.

    • targetBitrate

      public final Long targetBitrate()

      The expected ingest bitrate (bits per second). This is configured in the encoder.

      Returns:
      The expected ingest bitrate (bits per second). This is configured in the encoder.

    • track

      public final String track()

      Name of the audio track (if the stream has an audio track). If multitrack is not enabled, this is track0 (the sole track).

      Returns:
      Name of the audio track (if the stream has an audio track). If multitrack is not enabled, this is track0 (the sole track).

    • toBuilder

      public AudioConfiguration.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<AudioConfiguration.Builder,AudioConfiguration>
      Returns:
      a builder for type T

    • builder

      public static AudioConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AudioConfiguration.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)

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