software.amazon.awssdk.services.mediaconvert.model

Class AudioDescription

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.AudioDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AudioDescription.Builder,AudioDescription>

@Generated(value="software.amazon.awssdk:codegen")
public final class AudioDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AudioDescription.Builder,AudioDescription>

Description of audio output

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AudioDescription.Builder

Method Summary

Modifier and Type	Method and Description
AudioNormalizationSettings	audioNormalizationSettings() Returns the value of the AudioNormalizationSettings property for this object.
String	audioSourceName() Specifies which audio data to use from each input.
Integer	audioType() Applies only if Follow Input Audio Type is unchecked (false).
AudioTypeControl	audioTypeControl() Returns the value of the AudioTypeControl property for this object.
String	audioTypeControlAsString() Returns the value of the AudioTypeControl property for this object.
static AudioDescription.Builder	builder()
AudioCodecSettings	codecSettings() Returns the value of the CodecSettings property for this object.
String	customLanguageCode() Specify the language for this audio output track, using the ISO 639-2 or ISO 639-3 three-letter language code.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LanguageCode	languageCode() Indicates the language of the audio output track.
String	languageCodeAsString() Indicates the language of the audio output track.
AudioLanguageCodeControl	languageCodeControl() Returns the value of the LanguageCodeControl property for this object.
String	languageCodeControlAsString() Returns the value of the LanguageCodeControl property for this object.
RemixSettings	remixSettings() Advanced audio remixing settings.
List<SdkField<?>>	sdkFields()
static Class<? extends AudioDescription.Builder>	serializableBuilderClass()
String	streamName() Used for MS Smooth and Apple HLS outputs.
AudioDescription.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

audioNormalizationSettings

public AudioNormalizationSettings audioNormalizationSettings()

Returns the value of the AudioNormalizationSettings property for this object.

Returns:

The value of the AudioNormalizationSettings property for this object.

audioSourceName

public String audioSourceName()

Specifies which audio data to use from each input. In the simplest case, specify an "Audio Selector":#inputs-audio_selector by name based on its order within each input. For example if you specify "Audio Selector 3", then the third audio selector will be used from each input. If an input does not have an "Audio Selector 3", then the audio selector marked as "default" in that input will be used. If there is no audio selector marked as "default", silence will be inserted for the duration of that input. Alternatively, an "Audio Selector Group":#inputs-audio_selector_group name may be specified, with similar default/silence behavior. If no audio_source_name is specified, then "Audio Selector 1" will be chosen automatically.

Returns:

Specifies which audio data to use from each input. In the simplest case, specify an "Audio Selector":#inputs-audio_selector by name based on its order within each input. For example if you specify "Audio Selector 3", then the third audio selector will be used from each input. If an input does not have an "Audio Selector 3", then the audio selector marked as "default" in that input will be used. If there is no audio selector marked as "default", silence will be inserted for the duration of that input. Alternatively, an "Audio Selector Group":#inputs-audio_selector_group name may be specified, with similar default/silence behavior. If no audio_source_name is specified, then "Audio Selector 1" will be chosen automatically.

audioType

public Integer audioType()

Applies only if Follow Input Audio Type is unchecked (false). A number between 0 and 255. The following are defined in ISO-IEC 13818-1: 0 = Undefined, 1 = Clean Effects, 2 = Hearing Impaired, 3 = Visually Impaired Commentary, 4-255 = Reserved.

Returns:

Applies only if Follow Input Audio Type is unchecked (false). A number between 0 and 255. The following are defined in ISO-IEC 13818-1: 0 = Undefined, 1 = Clean Effects, 2 = Hearing Impaired, 3 = Visually Impaired Commentary, 4-255 = Reserved.

audioTypeControl

public AudioTypeControl audioTypeControl()

Returns the value of the AudioTypeControl property for this object.

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

Returns:

The value of the AudioTypeControl property for this object.

See Also:

AudioTypeControl

audioTypeControlAsString

public String audioTypeControlAsString()

Returns the value of the AudioTypeControl property for this object.

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

Returns:

The value of the AudioTypeControl property for this object.

See Also:

AudioTypeControl

codecSettings

public AudioCodecSettings codecSettings()

Returns the value of the CodecSettings property for this object.

Returns:

The value of the CodecSettings property for this object.

customLanguageCode

public String customLanguageCode()

Specify the language for this audio output track, using the ISO 639-2 or ISO 639-3 three-letter language code. The language specified will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input.

Returns:

Specify the language for this audio output track, using the ISO 639-2 or ISO 639-3 three-letter language code. The language specified will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input.

languageCode

public LanguageCode languageCode()

Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' 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, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input.

See Also:

LanguageCode

languageCodeAsString

public String languageCodeAsString()

Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' 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, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input.

See Also:

LanguageCode

languageCodeControl

public AudioLanguageCodeControl languageCodeControl()

Returns the value of the LanguageCodeControl property for this object.

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

Returns:

The value of the LanguageCodeControl property for this object.

See Also:

AudioLanguageCodeControl

languageCodeControlAsString

public String languageCodeControlAsString()

Returns the value of the LanguageCodeControl property for this object.

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

Returns:

The value of the LanguageCodeControl property for this object.

See Also:

AudioLanguageCodeControl

remixSettings

public RemixSettings remixSettings()

Advanced audio remixing settings.

Returns:

Advanced audio remixing settings.

streamName

public String streamName()

Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary). Alphanumeric characters, spaces, and underscore are legal.

Returns:

Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary). Alphanumeric characters, spaces, and underscore are legal.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

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