software.amazon.awssdk.services.medialive.model

Interface AudioDescription.Builder

All Superinterfaces:

CopyableBuilder<AudioDescription.Builder,AudioDescription>, SdkBuilder<AudioDescription.Builder,AudioDescription>

Enclosing class:

AudioDescription

public static interface AudioDescription.Builder
extends CopyableBuilder<AudioDescription.Builder,AudioDescription>

Method Summary

Modifier and Type	Method and Description
AudioDescription.Builder	audioNormalizationSettings(AudioNormalizationSettings audioNormalizationSettings) Advanced audio normalization settings.
default AudioDescription.Builder	audioNormalizationSettings(Consumer<AudioNormalizationSettings.Builder> audioNormalizationSettings) Advanced audio normalization settings.
AudioDescription.Builder	audioSelectorName(String audioSelectorName) The name of the AudioSelector used as the source for this AudioDescription.
AudioDescription.Builder	audioType(AudioType audioType) Applies only if audioTypeControl is useConfigured.
AudioDescription.Builder	audioType(String audioType) Applies only if audioTypeControl is useConfigured.
AudioDescription.Builder	audioTypeControl(AudioDescriptionAudioTypeControl audioTypeControl) Determines how audio type is determined.
AudioDescription.Builder	audioTypeControl(String audioTypeControl) Determines how audio type is determined.
AudioDescription.Builder	codecSettings(AudioCodecSettings codecSettings) Audio codec settings.
default AudioDescription.Builder	codecSettings(Consumer<AudioCodecSettings.Builder> codecSettings) Audio codec settings.
AudioDescription.Builder	languageCode(String languageCode) Indicates the language of the audio output track.
AudioDescription.Builder	languageCodeControl(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.Builder	languageCodeControl(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.Builder	name(String name) The name of this AudioDescription.
default AudioDescription.Builder	remixSettings(Consumer<RemixSettings.Builder> remixSettings) Settings that control how input audio channels are remixed into the output audio channels.
AudioDescription.Builder	remixSettings(RemixSettings remixSettings) Settings that control how input audio channels are remixed into the output audio channels.
AudioDescription.Builder	streamName(String streamName) Used for MS Smooth and Apple HLS outputs.

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

copy

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

apply, build

Method Detail

audioNormalizationSettings

AudioDescription.Builder audioNormalizationSettings(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.

audioNormalizationSettings

default AudioDescription.Builder audioNormalizationSettings(Consumer<AudioNormalizationSettings.Builder> audioNormalizationSettings)

Advanced audio normalization settings. This is a convenience that creates an instance of the AudioNormalizationSettings.Builder avoiding the need to create one manually via AudioNormalizationSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to audioNormalizationSettings(AudioNormalizationSettings).

Parameters:

audioNormalizationSettings - a consumer that will call methods on AudioNormalizationSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

audioNormalizationSettings(AudioNormalizationSettings)

audioSelectorName

AudioDescription.Builder audioSelectorName(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.

audioType

AudioDescription.Builder audioType(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, AudioType

audioType

AudioDescription.Builder audioType(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, AudioType

audioTypeControl

AudioDescription.Builder audioTypeControl(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, AudioDescriptionAudioTypeControl

audioTypeControl

AudioDescription.Builder audioTypeControl(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, AudioDescriptionAudioTypeControl

codecSettings

AudioDescription.Builder codecSettings(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.

codecSettings

default AudioDescription.Builder codecSettings(Consumer<AudioCodecSettings.Builder> codecSettings)

Audio codec settings. This is a convenience that creates an instance of the AudioCodecSettings.Builder avoiding the need to create one manually via AudioCodecSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to codecSettings(AudioCodecSettings).

Parameters:

codecSettings - a consumer that will call methods on AudioCodecSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

codecSettings(AudioCodecSettings)

languageCode

AudioDescription.Builder languageCode(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

languageCodeControl

AudioDescription.Builder languageCodeControl(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, AudioDescriptionLanguageCodeControl

languageCodeControl

AudioDescription.Builder languageCodeControl(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, AudioDescriptionLanguageCodeControl

name

AudioDescription.Builder name(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.

remixSettings

AudioDescription.Builder remixSettings(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.

remixSettings

default AudioDescription.Builder remixSettings(Consumer<RemixSettings.Builder> remixSettings)

Settings that control how input audio channels are remixed into the output audio channels. This is a convenience that creates an instance of the RemixSettings.Builder avoiding the need to create one manually via RemixSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to remixSettings(RemixSettings).

Parameters:

remixSettings - a consumer that will call methods on RemixSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

remixSettings(RemixSettings)

streamName

AudioDescription.Builder streamName(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.