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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AudioDescription.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<DashRoleAudio>`	`audioDashRoles()`	Identifies the DASH roles to assign to this audio output.
`List<String>`	`audioDashRolesAsStrings()`	Identifies the DASH roles to assign to this audio output.
`AudioNormalizationSettings`	`audioNormalizationSettings()`	Advanced audio normalization settings.
`String`	`audioSelectorName()`	The name of the AudioSelector used as the source for this AudioDescription.
`AudioType`	`audioType()`	Applies only if audioTypeControl is useConfigured.
`String`	`audioTypeAsString()`	Applies only if audioTypeControl is useConfigured.
`AudioDescriptionAudioTypeControl`	`audioTypeControl()`	Determines how audio type is determined.
`String`	`audioTypeControlAsString()`	Determines how audio type is determined.
`AudioWatermarkSettings`	`audioWatermarkingSettings()`	Settings to configure one or more solutions that insert audio watermarks in the audio encode
`static AudioDescription.Builder`	`builder()`
`AudioCodecSettings`	`codecSettings()`	Audio codec settings.
`DvbDashAccessibility`	`dvbDashAccessibility()`	Identifies DVB DASH accessibility signaling in this audio output.
`String`	`dvbDashAccessibilityAsString()`	Identifies DVB DASH accessibility signaling in this audio output.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAudioDashRoles()`	For responses, this returns true if the service returned a value for the AudioDashRoles property.
`int`	`hashCode()`
`String`	`languageCode()`	RFC 5646 language code representing the language of the audio output track.
`AudioDescriptionLanguageCodeControl`	`languageCodeControl()`	Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input.
`String`	`languageCodeControlAsString()`	Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input.
`String`	`name()`	The name of this AudioDescription.
`RemixSettings`	`remixSettings()`	Settings that control how input audio channels are remixed into the output audio channels.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AudioDescription.Builder>`	`serializableBuilderClass()`
`String`	`streamName()`	Used for MS Smooth and Apple HLS outputs.
`AudioDescription.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    AudioType
  - 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:
    
    AudioType
  - 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:
    
    AudioDescriptionAudioTypeControl
  - 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:
    
    AudioDescriptionAudioTypeControl
  - 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:
    
    AudioDescriptionLanguageCodeControl
  - 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:
    
    AudioDescriptionLanguageCodeControl
  - 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).
  - audioDashRoles
```
public final List<DashRoleAudio> audioDashRoles()
```
    Identifies the DASH roles to assign to this audio output. Applies only when the audio output is configured for DVB DASH accessibility signaling.
    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 hasAudioDashRoles() method.
    
    Returns:
    
    Identifies the DASH roles to assign to this audio output. Applies only when the audio output is configured for DVB DASH accessibility signaling.
  - hasAudioDashRoles
```
public final boolean hasAudioDashRoles()
```
    For responses, this returns true if the service returned a value for the AudioDashRoles 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.
  - audioDashRolesAsStrings
```
public final List<String> audioDashRolesAsStrings()
```
    Identifies the DASH roles to assign to this audio output. Applies only when the audio output is configured for DVB DASH accessibility signaling.
    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 hasAudioDashRoles() method.
    
    Returns:
    
    Identifies the DASH roles to assign to this audio output. Applies only when the audio output is configured for DVB DASH accessibility signaling.
  - dvbDashAccessibility
```
public final DvbDashAccessibility dvbDashAccessibility()
```
    Identifies DVB DASH accessibility signaling in this audio output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.
    If the service returns an enum value that is not available in the current SDK version, dvbDashAccessibility will return DvbDashAccessibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dvbDashAccessibilityAsString().
    
    Returns:
    
    Identifies DVB DASH accessibility signaling in this audio output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.
    
    See Also:
    
    DvbDashAccessibility
  - dvbDashAccessibilityAsString
```
public final String dvbDashAccessibilityAsString()
```
    Identifies DVB DASH accessibility signaling in this audio output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.
    If the service returns an enum value that is not available in the current SDK version, dvbDashAccessibility will return DvbDashAccessibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dvbDashAccessibilityAsString().
    
    Returns:
    
    Identifies DVB DASH accessibility signaling in this audio output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.
    
    See Also:
    
    DvbDashAccessibility
  - toBuilder
```
public AudioDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AudioDescription.Builder,AudioDescription>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class AudioDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

audioNormalizationSettings

audioSelectorName

audioType

audioTypeAsString

audioTypeControl

audioTypeControlAsString

audioWatermarkingSettings

codecSettings

languageCode

languageCodeControl

languageCodeControlAsString

name

remixSettings

streamName

audioDashRoles

hasAudioDashRoles

audioDashRolesAsStrings

dvbDashAccessibility

dvbDashAccessibilityAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField