jVamp

A

ADAPT_ALL - Static variable in class org.vamp_plugins.PluginLoader.AdapterFlags

ADAPT_ALL - Perform all available adaptations that are meaningful for the plugin.

ADAPT_BUFFER_SIZE - Static variable in class org.vamp_plugins.PluginLoader.AdapterFlags

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.

ADAPT_CHANNEL_COUNT - Static variable in class org.vamp_plugins.PluginLoader.AdapterFlags

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().

ADAPT_INPUT_DOMAIN - Static variable in class org.vamp_plugins.PluginLoader.AdapterFlags

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.

ADAPT_NONE - Static variable in class org.vamp_plugins.PluginLoader.AdapterFlags

ADAPT_NONE - If passed to loadPlugin as the adapterFlags value, causes no adaptations to be done.

AdapterFlags() - Constructor for class org.vamp_plugins.PluginLoader.AdapterFlags

 

B

binCount - Variable in class org.vamp_plugins.OutputDescriptor

The number of values per result of the output.

binNames - Variable in class org.vamp_plugins.OutputDescriptor

The (human-readable) names of each of the bins, if appropriate.

D

defaultValue - Variable in class org.vamp_plugins.ParameterDescriptor

The default value of the parameter.

description - Variable in class org.vamp_plugins.OutputDescriptor

A human-readable short text describing the output.

description - Variable in class org.vamp_plugins.ParameterDescriptor

A human-readable short text describing the parameter.

duration - Variable in class org.vamp_plugins.Feature

Duration of the output feature.

dispose() - Method in class org.vamp_plugins.Plugin

Dispose of this Plugin.

F

Feature - Class in org.vamp_plugins

Feature contains a single result returned from Plugin.process() or Plugin.getRemainingFeatures().

frame2RealTime(long, int) - Static method in class org.vamp_plugins.RealTime

 

fromMilliseconds(int) - Static method in class org.vamp_plugins.RealTime

 

fromSeconds(double) - Static method in class org.vamp_plugins.RealTime

 

G

getCopyright() - Method in class org.vamp_plugins.Plugin

Get the copyright statement or licensing summary for the plugin.

getCurrentProgram() - Method in class org.vamp_plugins.Plugin

Get the current program (if any).

getDescription() - Method in class org.vamp_plugins.Plugin

Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name".

getIdentifier() - Method in class org.vamp_plugins.Plugin

Get the computer-usable name of the plugin.

getInputDomain() - Method in class org.vamp_plugins.Plugin

Get the plugin's required input domain.

getInstance() - Static method in class org.vamp_plugins.PluginLoader

PluginLoader is a singleton.

getMaker() - Method in class org.vamp_plugins.Plugin

Get the name of the author or vendor of the plugin in human-readable form.

getMaxChannelCount() - Method in class org.vamp_plugins.Plugin

Get the maximum supported number of input channels.

getMinChannelCount() - Method in class org.vamp_plugins.Plugin

Get the minimum supported number of input channels.

getName() - Method in class org.vamp_plugins.Plugin

Get a human-readable name or title of the plugin.

getOutputDescriptors() - Method in class org.vamp_plugins.Plugin

Get the outputs of this plugin.

getParameter(String) - Method in class org.vamp_plugins.Plugin

Get the value of a named parameter.

getParameterDescriptors() - Method in class org.vamp_plugins.Plugin

Get the controllable parameters of this plugin.

getPluginCategory(String) - Method in class org.vamp_plugins.PluginLoader

Return the category hierarchy for a Vamp plugin, given its identifying key.

getPluginPath() - Method in class org.vamp_plugins.PluginLoader

Return the plugin path, that is, the series of local file folders that will be searched for plugin files.

getPluginVersion() - Method in class org.vamp_plugins.Plugin

Get the version number of the plugin.

getPreferredBlockSize() - Method in class org.vamp_plugins.Plugin

Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).

getPreferredStepSize() - Method in class org.vamp_plugins.Plugin

Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.

getPrograms() - Method in class org.vamp_plugins.Plugin

Get the program settings available in this plugin.

getRemainingFeatures() - Method in class org.vamp_plugins.Plugin

After all blocks have been processed, calculate and return any remaining features derived from the complete input.

getVampApiVersion() - Method in class org.vamp_plugins.Plugin

Get the Vamp API compatibility level of the plugin.

H

hasDuration - Variable in class org.vamp_plugins.Feature

True if an output feature has a specified duration.

hasDuration - Variable in class org.vamp_plugins.OutputDescriptor

True if the returned results for this output are known to have a duration field.

hasFixedBinCount - Variable in class org.vamp_plugins.OutputDescriptor

True if the output has the same number of values per sample for every output sample.

hasKnownExtents - Variable in class org.vamp_plugins.OutputDescriptor

True if the results in each output bin fall within a fixed numeric range (minimum and maximum values).

hasTimestamp - Variable in class org.vamp_plugins.Feature

True if an output feature has its own timestamp.

I

identifier - Variable in class org.vamp_plugins.OutputDescriptor

The name of the output, in computer-usable form.

identifier - Variable in class org.vamp_plugins.ParameterDescriptor

The name of the parameter, in computer-usable form.

isQuantized - Variable in class org.vamp_plugins.OutputDescriptor

True if the output values are quantized to a particular resolution.

isQuantized - Variable in class org.vamp_plugins.ParameterDescriptor

True if the parameter values are quantized to a particular resolution.

initialise(int, int, int) - Method in class org.vamp_plugins.Plugin

Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).

L

label - Variable in class org.vamp_plugins.Feature

Label for the sample of this feature.

LoadFailedException() - Constructor for exception org.vamp_plugins.PluginLoader.LoadFailedException

 

listPlugins() - Method in class org.vamp_plugins.PluginLoader

Search for all available Vamp plugins, and return a list of their plugin keys (suitable for passing to loadPlugin) in the order in which they were found.

loadPlugin(String, float, int) - Method in class org.vamp_plugins.PluginLoader

Load a native Vamp plugin from the plugin path.

M

maxValue - Variable in class org.vamp_plugins.OutputDescriptor

Maximum value of the results in the output.

maxValue - Variable in class org.vamp_plugins.ParameterDescriptor

The maximum value of the parameter.

minValue - Variable in class org.vamp_plugins.OutputDescriptor

Minimum value of the results in the output.

minValue - Variable in class org.vamp_plugins.ParameterDescriptor

The minimum value of the parameter.

msec() - Method in class org.vamp_plugins.RealTime

 

N

name - Variable in class org.vamp_plugins.OutputDescriptor

The human-readable name of the output.

name - Variable in class org.vamp_plugins.ParameterDescriptor

The human-readable name of the parameter.

nsec() - Method in class org.vamp_plugins.RealTime

 

O

org.vamp_plugins - package org.vamp_plugins

 

OutputDescriptor - Class in org.vamp_plugins

OutputDescriptor describes the properties of an output of a Vamp plugin.

OutputDescriptor.SampleType - Enum in org.vamp_plugins

 

P

ParameterDescriptor - Class in org.vamp_plugins

ParameterDescriptor describes the properties of a configurable parameter of a Plugin.

Plugin - Class in org.vamp_plugins

A Java wrapper for a native-code Vamp plugin.

PluginLoader - Class in org.vamp_plugins

PluginLoader loads a Vamp plugin by searching the standard Vamp installation path, and returns a Plugin object wrapping the native plugin.

PluginLoader.AdapterFlags - Class in org.vamp_plugins

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.

PluginLoader.LoadFailedException - Exception in org.vamp_plugins

 

Plugin.InputDomain - Enum in org.vamp_plugins

 

Plugin(long) - Constructor for class org.vamp_plugins.Plugin

 

process(float[][], int, RealTime) - Method in class org.vamp_plugins.Plugin

As process() above, but taking input data starting at the given offset from within each of the channel arrays.

process(float[][], RealTime) - Method in class org.vamp_plugins.Plugin

Process a single block of input data.

Q

quantizeStep - Variable in class org.vamp_plugins.OutputDescriptor

Quantization resolution of the output values (e.g.

quantizeStep - Variable in class org.vamp_plugins.ParameterDescriptor

Quantization resolution of the parameter values (e.g.

R

RealTime - Class in org.vamp_plugins

RealTime class, corresponding to the C++ Vamp::RealTime.

RealTime(int, int) - Constructor for class org.vamp_plugins.RealTime

 

realTime2Frame(RealTime, int) - Static method in class org.vamp_plugins.RealTime

 

reset() - Method in class org.vamp_plugins.Plugin

Reset the plugin after use, to prepare it for another clean run.

S

sampleRate - Variable in class org.vamp_plugins.OutputDescriptor

Sample rate of the output results, as samples per second.

sampleType - Variable in class org.vamp_plugins.OutputDescriptor

Positioning in time of the output results.

sec() - Method in class org.vamp_plugins.RealTime

 

selectProgram(String) - Method in class org.vamp_plugins.Plugin

Select a program.

setParameter(String, float) - Method in class org.vamp_plugins.Plugin

Set a named parameter.

T

timestamp - Variable in class org.vamp_plugins.Feature

Timestamp of the output feature.

toString() - Method in class org.vamp_plugins.RealTime

 

toText() - Method in class org.vamp_plugins.RealTime

 

U

unit - Variable in class org.vamp_plugins.OutputDescriptor

The unit of the output, in human-readable form.

unit - Variable in class org.vamp_plugins.ParameterDescriptor

The unit of the parameter, in human-readable form.

usec() - Method in class org.vamp_plugins.RealTime

 

V

valueNames - Variable in class org.vamp_plugins.ParameterDescriptor

Names for the quantized values.

values - Variable in class org.vamp_plugins.Feature

Results for a single sample of this feature.

valueOf(String) - Static method in enum org.vamp_plugins.OutputDescriptor.SampleType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.vamp_plugins.Plugin.InputDomain

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.vamp_plugins.OutputDescriptor.SampleType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.vamp_plugins.Plugin.InputDomain

Returns an array containing the constants of this enum type, in the order they are declared.