Class InputSettings
- java.lang.Object
-
- software.amazon.awssdk.services.medialive.model.InputSettings
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<InputSettings.Builder,InputSettings>
@Generated("software.amazon.awssdk:codegen") public final class InputSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InputSettings.Builder,InputSettings>
Live Event input parameters. There can be multiple inputs in a single Live Event.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceInputSettings.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<AudioSelector>audioSelectors()Used to select the audio stream to decode for inputs that have multiple available.static InputSettings.Builderbuilder()List<CaptionSelector>captionSelectors()Used to select the caption input to use for inputs that have multiple available.InputDeblockFilterdeblockFilter()Enable or disable the deblock filter when filtering.StringdeblockFilterAsString()Enable or disable the deblock filter when filtering.InputDenoiseFilterdenoiseFilter()Enable or disable the denoise filter when filtering.StringdenoiseFilterAsString()Enable or disable the denoise filter when filtering.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)IntegerfilterStrength()Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAudioSelectors()For responses, this returns true if the service returned a value for the AudioSelectors property.booleanhasCaptionSelectors()For responses, this returns true if the service returned a value for the CaptionSelectors property.inthashCode()InputFilterinputFilter()Turns on the filter for this input.StringinputFilterAsString()Turns on the filter for this input.NetworkInputSettingsnetworkInputSettings()Input settings.Integerscte35Pid()PID from which to read SCTE-35 messages.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends InputSettings.Builder>serializableBuilderClass()Smpte2038DataPreferencesmpte2038DataPreference()Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input.Stringsmpte2038DataPreferenceAsString()Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input.InputSourceEndBehaviorsourceEndBehavior()Loop input if it is a file.StringsourceEndBehaviorAsString()Loop input if it is a file.InputSettings.BuildertoBuilder()StringtoString()Returns a string representation of this object.VideoSelectorvideoSelector()Informs which video elementary stream to decode for input types that have multiple available.-
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
-
hasAudioSelectors
public final boolean hasAudioSelectors()
For responses, this returns true if the service returned a value for the AudioSelectors 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.
-
audioSelectors
public final List<AudioSelector> audioSelectors()
Used to select the audio stream to decode for inputs that have multiple available.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
hasAudioSelectors()method.- Returns:
- Used to select the audio stream to decode for inputs that have multiple available.
-
hasCaptionSelectors
public final boolean hasCaptionSelectors()
For responses, this returns true if the service returned a value for the CaptionSelectors 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.
-
captionSelectors
public final List<CaptionSelector> captionSelectors()
Used to select the caption input to use for inputs that have multiple available.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
hasCaptionSelectors()method.- Returns:
- Used to select the caption input to use for inputs that have multiple available.
-
deblockFilter
public final InputDeblockFilter deblockFilter()
Enable or disable the deblock filter when filtering.If the service returns an enum value that is not available in the current SDK version,
deblockFilterwill returnInputDeblockFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdeblockFilterAsString().- Returns:
- Enable or disable the deblock filter when filtering.
- See Also:
InputDeblockFilter
-
deblockFilterAsString
public final String deblockFilterAsString()
Enable or disable the deblock filter when filtering.If the service returns an enum value that is not available in the current SDK version,
deblockFilterwill returnInputDeblockFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdeblockFilterAsString().- Returns:
- Enable or disable the deblock filter when filtering.
- See Also:
InputDeblockFilter
-
denoiseFilter
public final InputDenoiseFilter denoiseFilter()
Enable or disable the denoise filter when filtering.If the service returns an enum value that is not available in the current SDK version,
denoiseFilterwill returnInputDenoiseFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdenoiseFilterAsString().- Returns:
- Enable or disable the denoise filter when filtering.
- See Also:
InputDenoiseFilter
-
denoiseFilterAsString
public final String denoiseFilterAsString()
Enable or disable the denoise filter when filtering.If the service returns an enum value that is not available in the current SDK version,
denoiseFilterwill returnInputDenoiseFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdenoiseFilterAsString().- Returns:
- Enable or disable the denoise filter when filtering.
- See Also:
InputDenoiseFilter
-
filterStrength
public final Integer filterStrength()
Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).- Returns:
- Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
-
inputFilter
public final InputFilter inputFilter()
Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input typeIf the service returns an enum value that is not available in the current SDK version,
inputFilterwill returnInputFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frominputFilterAsString().- Returns:
- Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type
- See Also:
InputFilter
-
inputFilterAsString
public final String inputFilterAsString()
Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input typeIf the service returns an enum value that is not available in the current SDK version,
inputFilterwill returnInputFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frominputFilterAsString().- Returns:
- Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type
- See Also:
InputFilter
-
networkInputSettings
public final NetworkInputSettings networkInputSettings()
Input settings.- Returns:
- Input settings.
-
scte35Pid
public final Integer scte35Pid()
PID from which to read SCTE-35 messages. If left undefined, EML will select the first SCTE-35 PID found in the input.- Returns:
- PID from which to read SCTE-35 messages. If left undefined, EML will select the first SCTE-35 PID found in the input.
-
smpte2038DataPreference
public final Smpte2038DataPreference smpte2038DataPreference()
Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 messages. - PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any). - IGNORE: Never extract any ancillary data from SMPTE-2038.If the service returns an enum value that is not available in the current SDK version,
smpte2038DataPreferencewill returnSmpte2038DataPreference.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsmpte2038DataPreferenceAsString().- Returns:
- Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 messages. - PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any). - IGNORE: Never extract any ancillary data from SMPTE-2038.
- See Also:
Smpte2038DataPreference
-
smpte2038DataPreferenceAsString
public final String smpte2038DataPreferenceAsString()
Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 messages. - PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any). - IGNORE: Never extract any ancillary data from SMPTE-2038.If the service returns an enum value that is not available in the current SDK version,
smpte2038DataPreferencewill returnSmpte2038DataPreference.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsmpte2038DataPreferenceAsString().- Returns:
- Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 messages. - PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any). - IGNORE: Never extract any ancillary data from SMPTE-2038.
- See Also:
Smpte2038DataPreference
-
sourceEndBehavior
public final InputSourceEndBehavior sourceEndBehavior()
Loop input if it is a file. This allows a file input to be streamed indefinitely.If the service returns an enum value that is not available in the current SDK version,
sourceEndBehaviorwill returnInputSourceEndBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsourceEndBehaviorAsString().- Returns:
- Loop input if it is a file. This allows a file input to be streamed indefinitely.
- See Also:
InputSourceEndBehavior
-
sourceEndBehaviorAsString
public final String sourceEndBehaviorAsString()
Loop input if it is a file. This allows a file input to be streamed indefinitely.If the service returns an enum value that is not available in the current SDK version,
sourceEndBehaviorwill returnInputSourceEndBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsourceEndBehaviorAsString().- Returns:
- Loop input if it is a file. This allows a file input to be streamed indefinitely.
- See Also:
InputSourceEndBehavior
-
videoSelector
public final VideoSelector videoSelector()
Informs which video elementary stream to decode for input types that have multiple available.- Returns:
- Informs which video elementary stream to decode for input types that have multiple available.
-
toBuilder
public InputSettings.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<InputSettings.Builder,InputSettings>
-
builder
public static InputSettings.Builder builder()
-
serializableBuilderClass
public static Class<? extends InputSettings.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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-