com.amazonaws.services.mediaconvert.model

Class AudioSelector

java.lang.Object

com.amazonaws.services.mediaconvert.model.AudioSelector

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AudioSelector()

Method Summary

Modifier and Type	Method and Description
AudioSelector	clone()
boolean	equals(Object obj)
String	getCustomLanguageCode() Selects a specific language code from within an audio source, using the ISO 639-2 or ISO 639-3 three-letter language code
String	getDefaultSelection() Enable this setting on one audio selector to set it as the default for the job.
String	getExternalAudioFileInput() Specifies audio data from an external file source.
HlsRenditionGroupSettings	getHlsRenditionGroupSettings() Settings specific to audio sources in an HLS alternate rendition group.
String	getLanguageCode() Selects a specific language code from within an audio source.
Integer	getOffset() Specifies a time delta in milliseconds to offset the audio from the input video.
List<Integer>	getPids() Selects a specific PID from within an audio source (e.g.
Integer	getProgramSelection() Use this setting for input streams that contain Dolby E, to have the service extract specific program data from the track.
RemixSettings	getRemixSettings() Use these settings to reorder the audio channels of one input to match those of another input.
String	getSelectorType() Specifies the type of the audio selector.
List<Integer>	getTracks() Identify a track from the input audio to include in this selector by entering the track index number.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setCustomLanguageCode(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
void	setDefaultSelection(String defaultSelection) Enable this setting on one audio selector to set it as the default for the job.
void	setExternalAudioFileInput(String externalAudioFileInput) Specifies audio data from an external file source.
void	setHlsRenditionGroupSettings(HlsRenditionGroupSettings hlsRenditionGroupSettings) Settings specific to audio sources in an HLS alternate rendition group.
void	setLanguageCode(String languageCode) Selects a specific language code from within an audio source.
void	setOffset(Integer offset) Specifies a time delta in milliseconds to offset the audio from the input video.
void	setPids(Collection<Integer> pids) Selects a specific PID from within an audio source (e.g.
void	setProgramSelection(Integer programSelection) Use this setting for input streams that contain Dolby E, to have the service extract specific program data from the track.
void	setRemixSettings(RemixSettings remixSettings) Use these settings to reorder the audio channels of one input to match those of another input.
void	setSelectorType(String selectorType) Specifies the type of the audio selector.
void	setTracks(Collection<Integer> tracks) Identify a track from the input audio to include in this selector by entering the track index number.
String	toString() Returns a string representation of this object.
AudioSelector	withCustomLanguageCode(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
AudioSelector	withDefaultSelection(AudioDefaultSelection defaultSelection) Enable this setting on one audio selector to set it as the default for the job.
AudioSelector	withDefaultSelection(String defaultSelection) Enable this setting on one audio selector to set it as the default for the job.
AudioSelector	withExternalAudioFileInput(String externalAudioFileInput) Specifies audio data from an external file source.
AudioSelector	withHlsRenditionGroupSettings(HlsRenditionGroupSettings hlsRenditionGroupSettings) Settings specific to audio sources in an HLS alternate rendition group.
AudioSelector	withLanguageCode(LanguageCode languageCode) Selects a specific language code from within an audio source.
AudioSelector	withLanguageCode(String languageCode) Selects a specific language code from within an audio source.
AudioSelector	withOffset(Integer offset) Specifies a time delta in milliseconds to offset the audio from the input video.
AudioSelector	withPids(Collection<Integer> pids) Selects a specific PID from within an audio source (e.g.
AudioSelector	withPids(Integer... pids) Selects a specific PID from within an audio source (e.g.
AudioSelector	withProgramSelection(Integer programSelection) Use this setting for input streams that contain Dolby E, to have the service extract specific program data from the track.
AudioSelector	withRemixSettings(RemixSettings remixSettings) Use these settings to reorder the audio channels of one input to match those of another input.
AudioSelector	withSelectorType(AudioSelectorType selectorType) Specifies the type of the audio selector.
AudioSelector	withSelectorType(String selectorType) Specifies the type of the audio selector.
AudioSelector	withTracks(Collection<Integer> tracks) Identify a track from the input audio to include in this selector by entering the track index number.
AudioSelector	withTracks(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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AudioSelector

public AudioSelector()

Method Detail

setCustomLanguageCode

public void setCustomLanguageCode(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

Parameters:

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

getCustomLanguageCode

public String getCustomLanguageCode()

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

withCustomLanguageCode

public AudioSelector withCustomLanguageCode(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

Parameters:

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:

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

setDefaultSelection

public void setDefaultSelection(String 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.

Parameters:

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.

See Also:

AudioDefaultSelection

getDefaultSelection

public String getDefaultSelection()

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.

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

withDefaultSelection

public AudioSelector withDefaultSelection(String 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.

Parameters:

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.

Returns:

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

See Also:

AudioDefaultSelection

withDefaultSelection

public AudioSelector withDefaultSelection(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.

Parameters:

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.

Returns:

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

See Also:

AudioDefaultSelection

setExternalAudioFileInput

public void setExternalAudioFileInput(String externalAudioFileInput)

Specifies audio data from an external file source.

Parameters:

externalAudioFileInput - Specifies audio data from an external file source.

getExternalAudioFileInput

public String getExternalAudioFileInput()

Specifies audio data from an external file source.

Returns:

Specifies audio data from an external file source.

withExternalAudioFileInput

public AudioSelector withExternalAudioFileInput(String externalAudioFileInput)

Specifies audio data from an external file source.

Parameters:

externalAudioFileInput - Specifies audio data from an external file source.

Returns:

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

setHlsRenditionGroupSettings

public void setHlsRenditionGroupSettings(HlsRenditionGroupSettings hlsRenditionGroupSettings)

Settings specific to audio sources in an HLS alternate rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique audio track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the properties provided, the job fails. If no properties in hlsRenditionGroupSettings are specified, the default audio track within the video segment is chosen. If there is no audio within video segment, the alternative audio with DEFAULT=YES is chosen instead.

Parameters:

hlsRenditionGroupSettings - Settings specific to audio sources in an HLS alternate rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique audio track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the properties provided, the job fails. If no properties in hlsRenditionGroupSettings are specified, the default audio track within the video segment is chosen. If there is no audio within video segment, the alternative audio with DEFAULT=YES is chosen instead.

getHlsRenditionGroupSettings

public HlsRenditionGroupSettings getHlsRenditionGroupSettings()

Settings specific to audio sources in an HLS alternate rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique audio track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the properties provided, the job fails. If no properties in hlsRenditionGroupSettings are specified, the default audio track within the video segment is chosen. If there is no audio within video segment, the alternative audio with DEFAULT=YES is chosen instead.

Returns:

Settings specific to audio sources in an HLS alternate rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique audio track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the properties provided, the job fails. If no properties in hlsRenditionGroupSettings are specified, the default audio track within the video segment is chosen. If there is no audio within video segment, the alternative audio with DEFAULT=YES is chosen instead.

withHlsRenditionGroupSettings

public AudioSelector withHlsRenditionGroupSettings(HlsRenditionGroupSettings hlsRenditionGroupSettings)

Settings specific to audio sources in an HLS alternate rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique audio track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the properties provided, the job fails. If no properties in hlsRenditionGroupSettings are specified, the default audio track within the video segment is chosen. If there is no audio within video segment, the alternative audio with DEFAULT=YES is chosen instead.

Parameters:

hlsRenditionGroupSettings - Settings specific to audio sources in an HLS alternate rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique audio track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the properties provided, the job fails. If no properties in hlsRenditionGroupSettings are specified, the default audio track within the video segment is chosen. If there is no audio within video segment, the alternative audio with DEFAULT=YES is chosen instead.

Returns:

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

setLanguageCode

public void setLanguageCode(String languageCode)

Selects a specific language code from within an audio source.

Parameters:

languageCode - Selects a specific language code from within an audio source.

See Also:

LanguageCode

getLanguageCode

public String getLanguageCode()

Selects a specific language code from within an audio source.

Returns:

Selects a specific language code from within an audio source.

See Also:

LanguageCode

withLanguageCode

public AudioSelector withLanguageCode(String languageCode)

Selects a specific language code from within an audio source.

Parameters:

languageCode - Selects a specific language code from within an audio source.

Returns:

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

See Also:

LanguageCode

withLanguageCode

public AudioSelector withLanguageCode(LanguageCode languageCode)

Selects a specific language code from within an audio source.

Parameters:

languageCode - Selects a specific language code from within an audio source.

Returns:

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

See Also:

LanguageCode

setOffset

public void setOffset(Integer offset)

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

Parameters:

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

getOffset

public Integer getOffset()

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.

withOffset

public AudioSelector withOffset(Integer offset)

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

Parameters:

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

Returns:

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

getPids

public List<Integer> getPids()

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

Returns:

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

setPids

public void setPids(Collection<Integer> pids)

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

Parameters:

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

withPids

public AudioSelector withPids(Integer... pids)

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

NOTE: This method appends the values to the existing list (if any). Use setPids(java.util.Collection) or withPids(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

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

withPids

public AudioSelector withPids(Collection<Integer> pids)

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

Parameters:

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

Returns:

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

setProgramSelection

public void setProgramSelection(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.

Parameters:

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.

getProgramSelection

public Integer getProgramSelection()

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.

withProgramSelection

public AudioSelector withProgramSelection(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.

Parameters:

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:

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

setRemixSettings

public void setRemixSettings(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.

Parameters:

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.

getRemixSettings

public RemixSettings getRemixSettings()

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.

withRemixSettings

public AudioSelector withRemixSettings(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.

Parameters:

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:

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

setSelectorType

public void setSelectorType(String selectorType)

Specifies the type of the audio selector.

Parameters:

selectorType - Specifies the type of the audio selector.

See Also:

AudioSelectorType

getSelectorType

public String getSelectorType()

Specifies the type of the audio selector.

Returns:

Specifies the type of the audio selector.

See Also:

AudioSelectorType

withSelectorType

public AudioSelector withSelectorType(String selectorType)

Specifies the type of the audio selector.

Parameters:

selectorType - Specifies the type of the audio selector.

Returns:

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

See Also:

AudioSelectorType

withSelectorType

public AudioSelector withSelectorType(AudioSelectorType selectorType)

Specifies the type of the audio selector.

Parameters:

selectorType - Specifies the type of the audio selector.

Returns:

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

See Also:

AudioSelectorType

getTracks

public List<Integer> getTracks()

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

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

setTracks

public void setTracks(Collection<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].

Parameters:

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

withTracks

public AudioSelector withTracks(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].

NOTE: This method appends the values to the existing list (if any). Use setTracks(java.util.Collection) or withTracks(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

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

withTracks

public AudioSelector withTracks(Collection<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].

Parameters:

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

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