Class InputSettings

    • 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 the isEmpty() 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 the isEmpty() 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.
      • 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 type

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

        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 type

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

        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, smpte2038DataPreference will return Smpte2038DataPreference.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from smpte2038DataPreferenceAsString().

        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, smpte2038DataPreference will return Smpte2038DataPreference.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from smpte2038DataPreferenceAsString().

        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
      • 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.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)