Class AudioSelector
- java.lang.Object
-
- software.amazon.awssdk.services.mediaconvert.model.AudioSelector
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AudioSelector.Builder,AudioSelector>
@Generated("software.amazon.awssdk:codegen") public final class AudioSelector extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AudioSelector.Builder,AudioSelector>
Use Audio selectors 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 Description static interfaceAudioSelector.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AudioDurationCorrectionaudioDurationCorrection()Apply audio timing corrections to help synchronize audio and video in your output.StringaudioDurationCorrectionAsString()Apply audio timing corrections to help synchronize audio and video in your output.static AudioSelector.Builderbuilder()StringcustomLanguageCode()Selects a specific language code from within an audio source, using the ISO 639-2 or ISO 639-3 three-letter language codeAudioDefaultSelectiondefaultSelection()Enable this setting on one audio selector to set it as the default for the job.StringdefaultSelectionAsString()Enable this setting on one audio selector to set it as the default for the job.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringexternalAudioFileInput()Specifies audio data from an external file source.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasPids()For responses, this returns true if the service returned a value for the Pids property.booleanhasTracks()For responses, this returns true if the service returned a value for the Tracks property.HlsRenditionGroupSettingshlsRenditionGroupSettings()Settings specific to audio sources in an HLS alternate rendition group.LanguageCodelanguageCode()Selects a specific language code from within an audio source.StringlanguageCodeAsString()Selects a specific language code from within an audio source.Integeroffset()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.IntegerprogramSelection()Use this setting for input streams that contain Dolby E, to have the service extract specific program data from the track.RemixSettingsremixSettings()Use these settings to reorder the audio channels of one input to match those of another input.List<SdkField<?>>sdkFields()AudioSelectorTypeselectorType()Specifies the type of the audio selector.StringselectorTypeAsString()Specifies the type of the audio selector.static Class<? extends AudioSelector.Builder>serializableBuilderClass()AudioSelector.BuildertoBuilder()StringtoString()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
-
audioDurationCorrection
public final AudioDurationCorrection audioDurationCorrection()
Apply audio timing corrections to help synchronize audio and video in your output. To apply timing corrections, your input must meet the following requirements: * Container: MP4, or MOV, with an accurate time-to-sample (STTS) table. * Audio track: AAC. Choose from the following audio timing correction settings: * Disabled (Default): Apply no correction. * Auto: Recommended for most inputs. MediaConvert analyzes the audio timing in your input and determines which correction setting to use, if needed. * Track: Adjust the duration of each audio frame by a constant amount to align the audio track length with STTS duration. Track-level correction does not affect pitch, and is recommended for tonal audio content such as music. * Frame: Adjust the duration of each audio frame by a variable amount to align audio frames with STTS timestamps. No corrections are made to already-aligned frames. Frame-level correction may affect the pitch of corrected frames, and is recommended for atonal audio content such as speech or percussion.If the service returns an enum value that is not available in the current SDK version,
audioDurationCorrectionwill returnAudioDurationCorrection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromaudioDurationCorrectionAsString().- Returns:
- Apply audio timing corrections to help synchronize audio and video in your output. To apply timing corrections, your input must meet the following requirements: * Container: MP4, or MOV, with an accurate time-to-sample (STTS) table. * Audio track: AAC. Choose from the following audio timing correction settings: * Disabled (Default): Apply no correction. * Auto: Recommended for most inputs. MediaConvert analyzes the audio timing in your input and determines which correction setting to use, if needed. * Track: Adjust the duration of each audio frame by a constant amount to align the audio track length with STTS duration. Track-level correction does not affect pitch, and is recommended for tonal audio content such as music. * Frame: Adjust the duration of each audio frame by a variable amount to align audio frames with STTS timestamps. No corrections are made to already-aligned frames. Frame-level correction may affect the pitch of corrected frames, and is recommended for atonal audio content such as speech or percussion.
- See Also:
AudioDurationCorrection
-
audioDurationCorrectionAsString
public final String audioDurationCorrectionAsString()
Apply audio timing corrections to help synchronize audio and video in your output. To apply timing corrections, your input must meet the following requirements: * Container: MP4, or MOV, with an accurate time-to-sample (STTS) table. * Audio track: AAC. Choose from the following audio timing correction settings: * Disabled (Default): Apply no correction. * Auto: Recommended for most inputs. MediaConvert analyzes the audio timing in your input and determines which correction setting to use, if needed. * Track: Adjust the duration of each audio frame by a constant amount to align the audio track length with STTS duration. Track-level correction does not affect pitch, and is recommended for tonal audio content such as music. * Frame: Adjust the duration of each audio frame by a variable amount to align audio frames with STTS timestamps. No corrections are made to already-aligned frames. Frame-level correction may affect the pitch of corrected frames, and is recommended for atonal audio content such as speech or percussion.If the service returns an enum value that is not available in the current SDK version,
audioDurationCorrectionwill returnAudioDurationCorrection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromaudioDurationCorrectionAsString().- Returns:
- Apply audio timing corrections to help synchronize audio and video in your output. To apply timing corrections, your input must meet the following requirements: * Container: MP4, or MOV, with an accurate time-to-sample (STTS) table. * Audio track: AAC. Choose from the following audio timing correction settings: * Disabled (Default): Apply no correction. * Auto: Recommended for most inputs. MediaConvert analyzes the audio timing in your input and determines which correction setting to use, if needed. * Track: Adjust the duration of each audio frame by a constant amount to align the audio track length with STTS duration. Track-level correction does not affect pitch, and is recommended for tonal audio content such as music. * Frame: Adjust the duration of each audio frame by a variable amount to align audio frames with STTS timestamps. No corrections are made to already-aligned frames. Frame-level correction may affect the pitch of corrected frames, and is recommended for atonal audio content such as speech or percussion.
- See Also:
AudioDurationCorrection
-
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,
defaultSelectionwill returnAudioDefaultSelection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdefaultSelectionAsString().- 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,
defaultSelectionwill returnAudioDefaultSelection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdefaultSelectionAsString().- 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.
-
hlsRenditionGroupSettings
public final 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.- 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.
-
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,
languageCodewill returnLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlanguageCodeAsString().- 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,
languageCodewill returnLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlanguageCodeAsString().- 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()
For responses, this returns true if the service returned a value for the Pids property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPids()method.- 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 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 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,
selectorTypewill returnAudioSelectorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromselectorTypeAsString().- 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,
selectorTypewill returnAudioSelectorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromselectorTypeAsString().- Returns:
- Specifies the type of the audio selector.
- See Also:
AudioSelectorType
-
hasTracks
public final boolean hasTracks()
For responses, this returns true if the service returned a value for the Tracks property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
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 example, type "1,2,3" to include tracks 1 through 3.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTracks()method.- 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 example, type "1,2,3" to include tracks 1 through 3.
-
toBuilder
public AudioSelector.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AudioSelector.Builder,AudioSelector>
-
builder
public static AudioSelector.Builder builder()
-
serializableBuilderClass
public static Class<? extends AudioSelector.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-