software.amazon.awssdk.services.medialive.model

Class AudioDescription

java.lang.Object

software.amazon.awssdk.services.medialive.model.AudioDescription

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<AudioDescription.Builder,AudioDescription>

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

Placeholder documentation for AudioDescription

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() 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.
static AudioDescription.Builder	builder()
AudioCodecSettings	codecSettings() Audio codec settings.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	languageCode() Indicates 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.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
String	name() The name of this AudioDescription.
RemixSettings	remixSettings() Settings that control how input audio channels are remixed into the output audio channels.
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()

Advanced audio normalization settings.

Returns:

Advanced audio normalization settings.

audioSelectorName

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

codecSettings

public AudioCodecSettings codecSettings()

Audio codec settings.

Returns:

Audio codec settings.

languageCode

public String languageCode()

Indicates 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:

Indicates 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 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 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 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 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 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 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)

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.