software.amazon.awssdk.services.mediaconvert.model

Class AudioSelector

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.AudioSelector

All Implemented Interfaces:

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

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

Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your outputs. You can use multiple Audio selectors per input.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AudioSelector.Builder

Method Summary

Modifier and Type	Method and Description
static AudioSelector.Builder	builder()
String	customLanguageCode() Selects a specific language code from within an audio source, using the ISO 639-2 or ISO 639-3 three-letter language code
AudioDefaultSelection	defaultSelection() Enable this setting on one audio selector to set it as the default for the job.
String	defaultSelectionAsString() Enable this setting on one audio selector to set it as the default for the job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	externalAudioFileInput() Specifies audio data from an external file source.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPids() Returns true if the Pids property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTracks() Returns true if the Tracks property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
LanguageCode	languageCode() Selects a specific language code from within an audio source.
String	languageCodeAsString() Selects a specific language code from within an audio source.
Integer	offset() Specifies a time delta in milliseconds to offset the audio from the input video.
List<Integer>	pids() Selects a specific PID from within an audio source (e.g.
Integer	programSelection() Use this setting for input streams that contain Dolby E, to have the service extract specific program data from the track.
RemixSettings	remixSettings() Use these settings to reorder the audio channels of one input to match those of another input.
List<SdkField<?>>	sdkFields()
AudioSelectorType	selectorType() Specifies the type of the audio selector.
String	selectorTypeAsString() Specifies the type of the audio selector.
static Class<? extends AudioSelector.Builder>	serializableBuilderClass()
AudioSelector.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<Integer>	tracks() Identify a track from the input audio to include in this selector by entering the track index number.

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

customLanguageCode

public final String customLanguageCode()

Selects a specific language code from within an audio source, using the ISO 639-2 or ISO 639-3 three-letter language code

Returns:

Selects a specific language code from within an audio source, using the ISO 639-2 or ISO 639-3 three-letter language code

defaultSelection

public final AudioDefaultSelection defaultSelection()

Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio.

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

Returns:

Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio.

See Also:

AudioDefaultSelection

defaultSelectionAsString

public final String defaultSelectionAsString()

Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio.

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

Returns:

Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio.

See Also:

AudioDefaultSelection

externalAudioFileInput

public final String externalAudioFileInput()

Specifies audio data from an external file source.

Returns:

Specifies audio data from an external file source.

languageCode

public final LanguageCode languageCode()

Selects a specific language code from within an audio source.

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:

Selects a specific language code from within an audio source.

See Also:

LanguageCode

languageCodeAsString

public final String languageCodeAsString()

Selects a specific language code from within an audio source.

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:

Selects a specific language code from within an audio source.

See Also:

LanguageCode

offset

public final Integer offset()

Specifies a time delta in milliseconds to offset the audio from the input video.

Returns:

Specifies a time delta in milliseconds to offset the audio from the input video.

hasPids

public final boolean hasPids()

Returns true if the Pids property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

pids

public final List<Integer> pids()

Selects a specific PID from within an audio source (e.g. 257 selects PID 0x101).

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasPids() to see if a value was sent in this field.

Returns:

Selects a specific PID from within an audio source (e.g. 257 selects PID 0x101).

programSelection

public final Integer programSelection()

Use this setting for input streams that contain Dolby E, to have the service extract specific program data from the track. To select multiple programs, create multiple selectors with the same Track and different Program numbers. In the console, this setting is visible when you set Selector type to Track. Choose the program number from the dropdown list. If you are sending a JSON file, provide the program ID, which is part of the audio metadata. If your input file has incorrect metadata, you can choose All channels instead of a program number to have the service ignore the program IDs and include all the programs in the track.

Returns:

Use this setting for input streams that contain Dolby E, to have the service extract specific program data from the track. To select multiple programs, create multiple selectors with the same Track and different Program numbers. In the console, this setting is visible when you set Selector type to Track. Choose the program number from the dropdown list. If you are sending a JSON file, provide the program ID, which is part of the audio metadata. If your input file has incorrect metadata, you can choose All channels instead of a program number to have the service ignore the program IDs and include all the programs in the track.

remixSettings

public final RemixSettings remixSettings()

Use these settings to reorder the audio channels of one input to match those of another input. This allows you to combine the two files into a single output, one after the other.

Returns:

Use these settings to reorder the audio channels of one input to match those of another input. This allows you to combine the two files into a single output, one after the other.

selectorType

public final AudioSelectorType selectorType()

Specifies the type of the audio selector.

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

Returns:

Specifies the type of the audio selector.

See Also:

AudioSelectorType

selectorTypeAsString

public final String selectorTypeAsString()

Specifies the type of the audio selector.

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

Returns:

Specifies the type of the audio selector.

See Also:

AudioSelectorType

hasTracks

public final boolean hasTracks()

Returns true if the Tracks property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tracks

public final List<Integer> tracks()

Identify a track from the input audio to include in this selector by entering the track index number. To include several tracks in a single audio selector, specify multiple tracks as follows. Using the console, enter a comma-separated list. For examle, type "1,2,3" to include tracks 1 through 3. Specifying directly in your JSON job file, provide the track numbers in an array. For example, "tracks": [1,2,3].

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTracks() to see if a value was sent in this field.

Returns:

Identify a track from the input audio to include in this selector by entering the track index number. To include several tracks in a single audio selector, specify multiple tracks as follows. Using the console, enter a comma-separated list. For examle, type "1,2,3" to include tracks 1 through 3. Specifying directly in your JSON job file, provide the track numbers in an array. For example, "tracks": [1,2,3].

toBuilder

public AudioSelector.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AudioSelector.Builder,AudioSelector>

builder

public static AudioSelector.Builder builder()

serializableBuilderClass

public static Class<? extends AudioSelector.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