Package org.vamp_plugins
Class OutputDescriptor
- java.lang.Object
-
- org.vamp_plugins.OutputDescriptor
-
public class OutputDescriptor extends java.lang.ObjectOutputDescriptor describes the properties of an output of a Vamp plugin. Returned by e.g. Plugin.getOutputDescriptors().
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classOutputDescriptor.SampleType
-
Field Summary
Fields Modifier and Type Field and Description intbinCountThe number of values per result of the output.java.lang.String[]binNamesThe (human-readable) names of each of the bins, if appropriate.java.lang.StringdescriptionA human-readable short text describing the output.booleanhasDurationTrue if the returned results for this output are known to have a duration field.booleanhasFixedBinCountTrue if the output has the same number of values per sample for every output sample.booleanhasKnownExtentsTrue if the results in each output bin fall within a fixed numeric range (minimum and maximum values).java.lang.StringidentifierThe name of the output, in computer-usable form.booleanisQuantizedTrue if the output values are quantized to a particular resolution.floatmaxValueMaximum value of the results in the output.floatminValueMinimum value of the results in the output.java.lang.StringnameThe human-readable name of the output.floatquantizeStepQuantization resolution of the output values (e.g.floatsampleRateSample rate of the output results, as samples per second.OutputDescriptor.SampleTypesampleTypePositioning in time of the output results.java.lang.StringunitThe unit of the output, in human-readable form.
-
-
-
Field Detail
-
binCount
public int binCount
The number of values per result of the output. Undefined if hasFixedBinCount is false. If this is zero, the output is point data (i.e. only the time of each output is of interest, the value list will be empty).
-
binNames
public java.lang.String[] binNames
The (human-readable) names of each of the bins, if appropriate. This is always optional.
-
description
public java.lang.String description
A human-readable short text describing the output. May be empty if the name has said it all already.
-
hasDuration
public boolean hasDuration
True if the returned results for this output are known to have a duration field.
-
hasFixedBinCount
public boolean hasFixedBinCount
True if the output has the same number of values per sample for every output sample.
-
hasKnownExtents
public boolean hasKnownExtents
True if the results in each output bin fall within a fixed numeric range (minimum and maximum values). Undefined if binCount is zero.
-
identifier
public java.lang.String identifier
The name of the output, in computer-usable form. Will contain the characters [a-zA-Z0-9_-] only.
-
isQuantized
public boolean isQuantized
True if the output values are quantized to a particular resolution. Undefined if binCount is zero.
-
maxValue
public float maxValue
Maximum value of the results in the output. Undefined if hasKnownExtents is false or binCount is zero.
-
minValue
public float minValue
Minimum value of the results in the output. Undefined if hasKnownExtents is false or binCount is zero.
-
name
public java.lang.String name
The human-readable name of the output.
-
quantizeStep
public float quantizeStep
Quantization resolution of the output values (e.g. 1.0 if they are all integers). Undefined if isQuantized is false or binCount is zero.
-
sampleRate
public float sampleRate
Sample rate of the output results, as samples per second. Undefined if sampleType is OneSamplePerStep. If sampleType is VariableSampleRate and this value is non-zero, then it may be used to calculate a resolution for the output (i.e. the "duration" of each sample, in time, will be 1/sampleRate seconds). It's recommended to set this to zero if that behaviour is not desired.
-
sampleType
public OutputDescriptor.SampleType sampleType
Positioning in time of the output results.
-
unit
public java.lang.String unit
The unit of the output, in human-readable form.
-
-