AudioDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.medialive.model.AudioDescription

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AudioDescription
extends Object
implements Serializable, Cloneable, StructuredPojo

Audio Description

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AudioDescription()

Constructors
Constructor and Description
`AudioDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AudioDescription`	`clone()`
`boolean`	`equals(Object obj)`
`AudioNormalizationSettings`	`getAudioNormalizationSettings()` Advanced audio normalization settings.
`String`	`getAudioSelectorName()` The name of the AudioSelector used as the source for this AudioDescription.
`String`	`getAudioType()` Applies only if audioTypeControl is useConfigured.
`String`	`getAudioTypeControl()` Determines how audio type is determined.
`AudioCodecSettings`	`getCodecSettings()` Audio codec settings.
`String`	`getLanguageCode()` RFC 5646 language code representing the language of the audio output track.
`String`	`getLanguageCodeControl()` Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input.
`String`	`getName()` The name of this AudioDescription.
`RemixSettings`	`getRemixSettings()` Settings that control how input audio channels are remixed into the output audio channels.
`String`	`getStreamName()` Used for MS Smooth and Apple HLS outputs.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAudioNormalizationSettings(AudioNormalizationSettings audioNormalizationSettings)` Advanced audio normalization settings.
`void`	`setAudioSelectorName(String audioSelectorName)` The name of the AudioSelector used as the source for this AudioDescription.
`void`	`setAudioType(String audioType)` Applies only if audioTypeControl is useConfigured.
`void`	`setAudioTypeControl(String audioTypeControl)` Determines how audio type is determined.
`void`	`setCodecSettings(AudioCodecSettings codecSettings)` Audio codec settings.
`void`	`setLanguageCode(String languageCode)` RFC 5646 language code representing the language of the audio output track.
`void`	`setLanguageCodeControl(String languageCodeControl)` Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input.
`void`	`setName(String name)` The name of this AudioDescription.
`void`	`setRemixSettings(RemixSettings remixSettings)` Settings that control how input audio channels are remixed into the output audio channels.
`void`	`setStreamName(String streamName)` Used for MS Smooth and Apple HLS outputs.
`String`	`toString()` Returns a string representation of this object.
`AudioDescription`	`withAudioNormalizationSettings(AudioNormalizationSettings audioNormalizationSettings)` Advanced audio normalization settings.
`AudioDescription`	`withAudioSelectorName(String audioSelectorName)` The name of the AudioSelector used as the source for this AudioDescription.
`AudioDescription`	`withAudioType(AudioType audioType)` Applies only if audioTypeControl is useConfigured.
`AudioDescription`	`withAudioType(String audioType)` Applies only if audioTypeControl is useConfigured.
`AudioDescription`	`withAudioTypeControl(AudioDescriptionAudioTypeControl audioTypeControl)` Determines how audio type is determined.
`AudioDescription`	`withAudioTypeControl(String audioTypeControl)` Determines how audio type is determined.
`AudioDescription`	`withCodecSettings(AudioCodecSettings codecSettings)` Audio codec settings.
`AudioDescription`	`withLanguageCode(String languageCode)` RFC 5646 language code representing the language of the audio output track.
`AudioDescription`	`withLanguageCodeControl(AudioDescriptionLanguageCodeControl languageCodeControl)` Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input.
`AudioDescription`	`withLanguageCodeControl(String languageCodeControl)` Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input.
`AudioDescription`	`withName(String name)` The name of this AudioDescription.
`AudioDescription`	`withRemixSettings(RemixSettings remixSettings)` Settings that control how input audio channels are remixed into the output audio channels.
`AudioDescription`	`withStreamName(String streamName)` Used for MS Smooth and Apple HLS outputs.

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

- Constructor Detail
  - AudioDescription
```
public AudioDescription()
```
- Method Detail
  - setAudioNormalizationSettings
```
public void setAudioNormalizationSettings(AudioNormalizationSettings audioNormalizationSettings)
```
    Advanced audio normalization settings.
    
    Parameters:
    
    audioNormalizationSettings - Advanced audio normalization settings.
  - getAudioNormalizationSettings
```
public AudioNormalizationSettings getAudioNormalizationSettings()
```
    Advanced audio normalization settings.
    
    Returns:
    
    Advanced audio normalization settings.
  - withAudioNormalizationSettings
```
public AudioDescription withAudioNormalizationSettings(AudioNormalizationSettings audioNormalizationSettings)
```
    Advanced audio normalization settings.
    
    Parameters:
    
    audioNormalizationSettings - Advanced audio normalization settings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAudioSelectorName
```
public void setAudioSelectorName(String audioSelectorName)
```
    The name of the AudioSelector used as the source for this AudioDescription.
    
    Parameters:
    
    audioSelectorName - The name of the AudioSelector used as the source for this AudioDescription.
  - getAudioSelectorName
```
public String getAudioSelectorName()
```
    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.
  - withAudioSelectorName
```
public AudioDescription withAudioSelectorName(String audioSelectorName)
```
    The name of the AudioSelector used as the source for this AudioDescription.
    
    Parameters:
    
    audioSelectorName - The name of the AudioSelector used as the source for this AudioDescription.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAudioType
```
public void setAudioType(String audioType)
```
    Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
    
    Parameters:
    
    audioType - Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
    
    See Also:
    
    AudioType
  - getAudioType
```
public String getAudioType()
```
    Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
    
    Returns:
    
    Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
    
    See Also:
    
    AudioType
  - withAudioType
```
public AudioDescription withAudioType(String audioType)
```
    Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
    
    Parameters:
    
    audioType - Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AudioType
  - withAudioType
```
public AudioDescription withAudioType(AudioType audioType)
```
    Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
    
    Parameters:
    
    audioType - Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AudioType
  - setAudioTypeControl
```
public void setAudioTypeControl(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    AudioDescriptionAudioTypeControl
  - getAudioTypeControl
```
public String getAudioTypeControl()
```
    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.
    
    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
  - withAudioTypeControl
```
public AudioDescription withAudioTypeControl(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AudioDescriptionAudioTypeControl
  - withAudioTypeControl
```
public AudioDescription withAudioTypeControl(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AudioDescriptionAudioTypeControl
  - setCodecSettings
```
public void setCodecSettings(AudioCodecSettings codecSettings)
```
    Audio codec settings.
    
    Parameters:
    
    codecSettings - Audio codec settings.
  - getCodecSettings
```
public AudioCodecSettings getCodecSettings()
```
    Audio codec settings.
    
    Returns:
    
    Audio codec settings.
  - withCodecSettings
```
public AudioDescription withCodecSettings(AudioCodecSettings codecSettings)
```
    Audio codec settings.
    
    Parameters:
    
    codecSettings - Audio codec settings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLanguageCode
```
public void setLanguageCode(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.
    
    Parameters:
    
    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.
  - getLanguageCode
```
public String getLanguageCode()
```
    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.
  - withLanguageCode
```
public AudioDescription withLanguageCode(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLanguageCodeControl
```
public void setLanguageCodeControl(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    AudioDescriptionLanguageCodeControl
  - getLanguageCodeControl
```
public String getLanguageCodeControl()
```
    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.
    
    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
  - withLanguageCodeControl
```
public AudioDescription withLanguageCodeControl(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AudioDescriptionLanguageCodeControl
  - withLanguageCodeControl
```
public AudioDescription withLanguageCodeControl(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AudioDescriptionLanguageCodeControl
  - setName
```
public void setName(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.
    
    Parameters:
    
    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.
  - getName
```
public String getName()
```
    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.
  - withName
```
public AudioDescription withName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRemixSettings
```
public void setRemixSettings(RemixSettings remixSettings)
```
    Settings that control how input audio channels are remixed into the output audio channels.
    
    Parameters:
    
    remixSettings - Settings that control how input audio channels are remixed into the output audio channels.
  - getRemixSettings
```
public RemixSettings getRemixSettings()
```
    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.
  - withRemixSettings
```
public AudioDescription withRemixSettings(RemixSettings remixSettings)
```
    Settings that control how input audio channels are remixed into the output audio channels.
    
    Parameters:
    
    remixSettings - Settings that control how input audio channels are remixed into the output audio channels.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStreamName
```
public void setStreamName(String streamName)
```
    Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
    
    Parameters:
    
    streamName - Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
  - getStreamName
```
public String getStreamName()
```
    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).
  - withStreamName
```
public AudioDescription withStreamName(String streamName)
```
    Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
    
    Parameters:
    
    streamName - Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AudioDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class AudioDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AudioDescription

Method Detail

setAudioNormalizationSettings

getAudioNormalizationSettings

withAudioNormalizationSettings

setAudioSelectorName

getAudioSelectorName

withAudioSelectorName

setAudioType

getAudioType

withAudioType

withAudioType

setAudioTypeControl

getAudioTypeControl

withAudioTypeControl

withAudioTypeControl

setCodecSettings

getCodecSettings

withCodecSettings

setLanguageCode

getLanguageCode

withLanguageCode

setLanguageCodeControl

getLanguageCodeControl

withLanguageCodeControl

withLanguageCodeControl

setName

getName

withName

setRemixSettings

getRemixSettings

withRemixSettings

setStreamName

getStreamName

withStreamName

toString

equals

hashCode

clone

marshall