Skip navigation links
  • SEARCH: 
 
Package org.vamp_plugins

Class PluginLoader.AdapterFlags

  • java.lang.Object
    • org.vamp_plugins.PluginLoader.AdapterFlags
  • Enclosing class:
    PluginLoader

    public class PluginLoader.AdapterFlags
extends java.lang.Object
    AdapterFlags contains a set of values that may be OR'd together and passed to loadPlugin() to indicate which of the properties of a plugin the host would like PluginLoader to take care of for it, rather than having to handle itself. Use of these flags permits the host to cater more easily for plugins with varying requirements for their input formats, at some expense in flexibility.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int ADAPT_ALL
      ADAPT_ALL - Perform all available adaptations that are meaningful for the plugin.
      static int ADAPT_BUFFER_SIZE
      ADAPT_BUFFER_SIZE - Permit the host to ignore the preferred step and block size reported by the plugin when calling initialise(), and to provide whatever step and block size are most convenient instead.
      static int ADAPT_CHANNEL_COUNT
      ADAPT_CHANNEL_COUNT - Automatically handle any discrepancy between the number of channels supported by the plugin and the number provided by the host when calling Plugin.initialise().
      static int ADAPT_INPUT_DOMAIN
      ADAPT_INPUT_DOMAIN - If the plugin expects frequency domain input, automatically convert it to one that expects time-domain input by interpolating an adapter that carries out the FFT conversion silently.
      static int ADAPT_NONE
      ADAPT_NONE - If passed to loadPlugin as the adapterFlags value, causes no adaptations to be done.

    • Constructor Summary

      Constructors 
      Constructor and Description
      AdapterFlags() 

    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • ADAPT_ALL

        public static final int ADAPT_ALL
        ADAPT_ALL - Perform all available adaptations that are meaningful for the plugin.
        See Also:
        Constant Field Values

      • ADAPT_BUFFER_SIZE

        public static final int ADAPT_BUFFER_SIZE
        ADAPT_BUFFER_SIZE - Permit the host to ignore the preferred step and block size reported by the plugin when calling initialise(), and to provide whatever step and block size are most convenient instead. This may require modifying the sample type and rate specifications for the plugin outputs and modifying the timestamps on the output features in order to obtain correct time stamping.
        See Also:
        Constant Field Values

      • ADAPT_CHANNEL_COUNT

        public static final int ADAPT_CHANNEL_COUNT
        ADAPT_CHANNEL_COUNT - Automatically handle any discrepancy between the number of channels supported by the plugin and the number provided by the host when calling Plugin.initialise(). This enables a host to use plugins that may require the input to be mixed down to mono, etc., without having to worry about doing that itself.
        See Also:
        Constant Field Values

      • ADAPT_INPUT_DOMAIN

        public static final int ADAPT_INPUT_DOMAIN
        ADAPT_INPUT_DOMAIN - If the plugin expects frequency domain input, automatically convert it to one that expects time-domain input by interpolating an adapter that carries out the FFT conversion silently. This enables a host to accommodate time- and frequency-domain plugins without needing to do any conversion itself, but it means the host gets no control over the windowing and FFT methods used. A Hann window is used, and the FFT is unlikely to be the fastest native implementation available.
        See Also:
        Constant Field Values

      • ADAPT_NONE

        public static final int ADAPT_NONE
        ADAPT_NONE - If passed to loadPlugin as the adapterFlags value, causes no adaptations to be done.
        See Also:
        Constant Field Values

    • Constructor Detail

      • AdapterFlags

        public AdapterFlags()
Skip navigation links