Class AudioDescription

java.lang.Object
software.amazon.awssdk.services.medialive.model.AudioDescription
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AudioDescription.Builder,AudioDescription>

@Generated("software.amazon.awssdk:codegen") public final class AudioDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AudioDescription.Builder,AudioDescription>
Audio Description
See Also:
  • Method Details

    • audioNormalizationSettings

      public final AudioNormalizationSettings audioNormalizationSettings()
      Advanced audio normalization settings.
      Returns:
      Advanced audio normalization settings.
    • audioSelectorName

      public final String audioSelectorName()
      The name of the AudioSelector used as the source for this AudioDescription.
      Returns:
      The name of the AudioSelector used as the source for this AudioDescription.
    • audioType

      public final AudioType audioType()
      Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.

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

      Returns:
      Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
      See Also:
    • audioTypeAsString

      public final String audioTypeAsString()
      Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.

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

      Returns:
      Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
      See Also:
    • audioTypeControl

      public final AudioDescriptionAudioTypeControl audioTypeControl()
      Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.

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

      Returns:
      Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.
      See Also:
    • audioTypeControlAsString

      public final String audioTypeControlAsString()
      Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.

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

      Returns:
      Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.
      See Also:
    • audioWatermarkingSettings

      public final AudioWatermarkSettings audioWatermarkingSettings()
      Settings to configure one or more solutions that insert audio watermarks in the audio encode
      Returns:
      Settings to configure one or more solutions that insert audio watermarks in the audio encode
    • codecSettings

      public final AudioCodecSettings codecSettings()
      Audio codec settings.
      Returns:
      Audio codec settings.
    • languageCode

      public final String languageCode()
      RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
      Returns:
      RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
    • languageCodeControl

      public final AudioDescriptionLanguageCodeControl languageCodeControl()
      Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.

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

      Returns:
      Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.
      See Also:
    • languageCodeControlAsString

      public final String languageCodeControlAsString()
      Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.

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

      Returns:
      Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.
      See Also:
    • name

      public final String name()
      The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
      Returns:
      The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
    • remixSettings

      public final RemixSettings remixSettings()
      Settings that control how input audio channels are remixed into the output audio channels.
      Returns:
      Settings that control how input audio channels are remixed into the output audio channels.
    • streamName

      public final String streamName()
      Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
      Returns:
      Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
    • toBuilder

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

      public static AudioDescription.Builder builder()
    • serializableBuilderClass

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