Class KinesisVideoStreamSourceRuntimeConfiguration

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

The runtime configuration settings for the Kinesis video stream source.

See Also:

  • Method Details

    • hasStreams

      public final boolean hasStreams()
      For responses, this returns true if the service returned a value for the Streams property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • streams

      public final List<StreamConfiguration> streams()

      The streams in the source runtime configuration of a Kinesis video stream.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStreams() method.

      Returns:
      The streams in the source runtime configuration of a Kinesis video stream.

    • mediaEncoding

      public final MediaEncoding mediaEncoding()

      Specifies the encoding of your input audio. Supported format: PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

      For more information, see Media formats in the Amazon Transcribe Developer Guide.

      If the service returns an enum value that is not available in the current SDK version, mediaEncoding will return MediaEncoding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaEncodingAsString().

      Returns:
      Specifies the encoding of your input audio. Supported format: PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

      For more information, see Media formats in the Amazon Transcribe Developer Guide.

      See Also:

    • mediaEncodingAsString

      public final String mediaEncodingAsString()

      Specifies the encoding of your input audio. Supported format: PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

      For more information, see Media formats in the Amazon Transcribe Developer Guide.

      If the service returns an enum value that is not available in the current SDK version, mediaEncoding will return MediaEncoding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaEncodingAsString().

      Returns:
      Specifies the encoding of your input audio. Supported format: PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

      For more information, see Media formats in the Amazon Transcribe Developer Guide.

      See Also:

    • mediaSampleRate

      public final Integer mediaSampleRate()

      The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.

      Valid Range: Minimum value of 8000. Maximum value of 48000.

      Returns:
      The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.

      Valid Range: Minimum value of 8000. Maximum value of 48000.

    • toBuilder

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

    • builder

      public static KinesisVideoStreamSourceRuntimeConfiguration.Builder builder()

    • serializableBuilderClass

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