cannam@0: cannam@0: cannam@0: VampPluginSDK: _VampOutputDescriptor Struct Reference cannam@0: cannam@0: cannam@0: cannam@21: cannam@0: cannam@0:
cannam@0:

_VampOutputDescriptor Struct Reference

#include <vamp.h> cannam@0:

cannam@0: cannam@0:

cannam@0: List of all members.

Detailed Description

cannam@0: cannam@0:

Definition at line 118 of file vamp.h.

cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@21: cannam@21: cannam@21: cannam@0:

Public Attributes

const char * identifier
 Computer-usable name of the output.
const char * name
 Human-readable name of the output.
const char * description
 Human-readable short text about the output.
const char * unit
 Human-readable name of the unit of the output.
int hasFixedBinCount
 1 if output has equal number of values for each returned result.
unsigned int binCount
 Number of values per result, if hasFixedBinCount.
const char ** binNames
 Names of returned value bins, if hasFixedBinCount.
int hasKnownExtents
 1 if each returned value falls within the same fixed min/max range.
float minValue
 Minimum value for a returned result in any bin, if hasKnownExtents.
float maxValue
 Maximum value for a returned result in any bin, if hasKnownExtents.
int isQuantized
 1 if returned results are quantized to a particular resolution.
float quantizeStep
 Quantization resolution for returned results, if isQuantized.
VampSampleType sampleType
 Time positioning method for returned results (see VampSampleType).
float sampleRate
 Sample rate of returned results, if sampleType is vampFixedSampleRate.
int hasDuration
 1 if the returned results for this output are known to have a duration field.
cannam@0:

Member Data Documentation

cannam@0: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
const char* _VampOutputDescriptor::identifier
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: Computer-usable name of the output. cannam@0:

cannam@0: Must not change. [a-zA-Z0-9_] cannam@0:

Definition at line 121 of file vamp.h.

cannam@0: cannam@0:
cannam@0:

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
const char* _VampOutputDescriptor::name
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: Human-readable name of the output. cannam@0:

cannam@0: May be translatable. cannam@0:

Definition at line 124 of file vamp.h.

cannam@0: cannam@0:
cannam@0:

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
const char* _VampOutputDescriptor::description
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: Human-readable short text about the output. cannam@0:

cannam@0: May be translatable. cannam@0:

Definition at line 127 of file vamp.h.

cannam@0: cannam@0:
cannam@0:

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
const char* _VampOutputDescriptor::unit
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: Human-readable name of the unit of the output. cannam@0:

cannam@0: cannam@0:

Definition at line 130 of file vamp.h.

cannam@0: cannam@0:
cannam@0:

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
int _VampOutputDescriptor::hasFixedBinCount
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: 1 if output has equal number of values for each returned result. cannam@0:

cannam@0: cannam@0:

Definition at line 133 of file vamp.h.

cannam@0: cannam@0:
cannam@0:

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
unsigned int _VampOutputDescriptor::binCount
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: Number of values per result, if hasFixedBinCount. cannam@0:

cannam@0: cannam@0:

Definition at line 136 of file vamp.h.

cannam@0: cannam@0:
cannam@0:

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
const char** _VampOutputDescriptor::binNames
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: Names of returned value bins, if hasFixedBinCount. cannam@0:

cannam@0: May be NULL. cannam@0:

Definition at line 139 of file vamp.h.

cannam@0: cannam@0:
cannam@0:

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
int _VampOutputDescriptor::hasKnownExtents
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: 1 if each returned value falls within the same fixed min/max range. cannam@0:

cannam@0: cannam@0:

Definition at line 142 of file vamp.h.

cannam@0: cannam@0:
cannam@0:

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
float _VampOutputDescriptor::minValue
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: Minimum value for a returned result in any bin, if hasKnownExtents. cannam@0:

cannam@0: cannam@0:

Definition at line 145 of file vamp.h.

cannam@0: cannam@0:
cannam@0:

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
float _VampOutputDescriptor::maxValue
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: Maximum value for a returned result in any bin, if hasKnownExtents. cannam@0:

cannam@0: cannam@0:

Definition at line 148 of file vamp.h.

cannam@0: cannam@0:
cannam@0:

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
int _VampOutputDescriptor::isQuantized
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: 1 if returned results are quantized to a particular resolution. cannam@0:

cannam@0: cannam@0:

Definition at line 151 of file vamp.h.

cannam@0: cannam@0:
cannam@0:

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
float _VampOutputDescriptor::quantizeStep
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: Quantization resolution for returned results, if isQuantized. cannam@0:

cannam@0: cannam@0:

Definition at line 154 of file vamp.h.

cannam@0: cannam@0:
cannam@0:

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
VampSampleType _VampOutputDescriptor::sampleType
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: Time positioning method for returned results (see VampSampleType). cannam@0:

cannam@0: cannam@0:

Definition at line 157 of file vamp.h.

cannam@0: cannam@0:
cannam@0:

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
float _VampOutputDescriptor::sampleRate
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: Sample rate of returned results, if sampleType is vampFixedSampleRate. cannam@0:

cannam@0: "Resolution" of result, if sampleType is vampVariableSampleRate. cannam@0:

Definition at line 161 of file vamp.h.

cannam@0: cannam@21:
cannam@21:

cannam@21: cannam@21:

cannam@21:
cannam@21: cannam@21: cannam@21: cannam@21: cannam@21:
int _VampOutputDescriptor::hasDuration
cannam@21:
cannam@21:
cannam@21: cannam@21:

cannam@21: 1 if the returned results for this output are known to have a duration field. cannam@21:

cannam@21: This field is new in Vamp API version 2; it must not be tested for plugins that report an older API version in their plugin descriptor. cannam@21:

Definition at line 170 of file vamp.h.

cannam@0: cannam@0:
cannam@0:

cannam@0:

The documentation for this struct was generated from the following file: cannam@0:
cannam@21:
Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by  cannam@0: cannam@21: doxygen 1.5.6
cannam@0: cannam@0: