ParameterDescriptor - jVamp - Sound Software .ac.uk

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.vamp_plugins
Class ParameterDescriptor

java.lang.Object
  org.vamp_plugins.ParameterDescriptor

public class ParameterDescriptor
extends java.lang.Object
extends java.lang.Object

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

Field Summary
`float`	`defaultValue` The default value of the parameter.
`java.lang.String`	`description` A human-readable short text describing the parameter.
`java.lang.String`	`identifier` The name of the parameter, in computer-usable form.
`boolean`	`isQuantized` True if the parameter values are quantized to a particular resolution.
`float`	`maxValue` The maximum value of the parameter.
`float`	`minValue` The minimum value of the parameter.
`java.lang.String`	`name` The human-readable name of the parameter.
`float`	`quantizeStep` Quantization resolution of the parameter values (e.g.
`java.lang.String`	`unit` The unit of the parameter, in human-readable form.
`java.lang.String[]`	`valueNames` Names for the quantized values.

Method Summary

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

identifier

public java.lang.String identifier

The name of the parameter, in computer-usable form. Will contain only the characters [a-zA-Z0-9_-].

name

public java.lang.String name

The human-readable name of the parameter.

description

public java.lang.String description

A human-readable short text describing the parameter. May be empty if the name has said it all already.

unit

public java.lang.String unit

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

minValue

public float minValue

The minimum value of the parameter.

maxValue

public float maxValue

The maximum value of the parameter.

defaultValue

public float defaultValue

The default value of the parameter. The plugin should ensure that parameters have this value on initialisation (i.e. the host is not required to explicitly set parameters if it wants to use their default values).

isQuantized

public boolean isQuantized

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

quantizeStep

public float quantizeStep

Quantization resolution of the parameter values (e.g. 1.0 if they are all integers). Undefined if isQuantized is false.

valueNames

public java.lang.String[] valueNames

Names for the quantized values. If isQuantized is true, this may either be empty or contain one string for each of the quantize steps from minValue up to maxValue inclusive. Undefined if isQuantized is false. If these names are provided, they should be shown to the user in preference to the values themselves. The user may never see the actual numeric values unless they are also encoded in the names.