Chris@1: Chris@1: Chris@1: Chris@1: Chris@3: Chris@6: Chris@6: Chris@1: VampPluginSDK: _VampOutputDescriptor Struct Reference Chris@1: Chris@6: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1:
Chris@1:
VampPluginSDK Chris@6:  2.7 Chris@1:
Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1:
Chris@6: Public Attributes | Chris@6: List of all members
Chris@1:
Chris@1:
_VampOutputDescriptor Struct Reference
Chris@3:
Chris@1:
Chris@3: Chris@1:

#include <vamp.h>

Chris@1: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@1:

Chris@1: Public Attributes

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

Detailed Description

Chris@1:
Chris@6:

Definition at line 118 of file vamp.h.

Chris@6:

Member Data Documentation

Chris@6: Chris@6:

◆ identifier

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
const char* _VampOutputDescriptor::identifier
Chris@6:
Chris@1: Chris@1:

Computer-usable name of the output.

Chris@6:

Must not change. [a-zA-Z0-9_-]

Chris@1: Chris@6:

Definition at line 121 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ name

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
const char* _VampOutputDescriptor::name
Chris@6:
Chris@1: Chris@1:

Human-readable name of the output.

Chris@1:

May be translatable.

Chris@1: Chris@6:

Definition at line 124 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ description

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
const char* _VampOutputDescriptor::description
Chris@6:
Chris@1: Chris@1:

Human-readable short text about the output.

Chris@1:

May be translatable.

Chris@1: Chris@6:

Definition at line 127 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ unit

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
const char* _VampOutputDescriptor::unit
Chris@6:
Chris@1: Chris@1:

Human-readable name of the unit of the output.

Chris@1: Chris@6:

Definition at line 130 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ hasFixedBinCount

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
int _VampOutputDescriptor::hasFixedBinCount
Chris@6:
Chris@1: Chris@1:

1 if output has equal number of values for each returned result.

Chris@1: Chris@6:

Definition at line 133 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ binCount

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
unsigned int _VampOutputDescriptor::binCount
Chris@6:
Chris@1: Chris@1:

Number of values per result, if hasFixedBinCount.

Chris@1: Chris@6:

Definition at line 136 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ binNames

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
const char** _VampOutputDescriptor::binNames
Chris@6:
Chris@1: Chris@1:

Names of returned value bins, if hasFixedBinCount.

Chris@1:

May be NULL.

Chris@1: Chris@6:

Definition at line 139 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ hasKnownExtents

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
int _VampOutputDescriptor::hasKnownExtents
Chris@6:
Chris@1: Chris@1:

1 if each returned value falls within the same fixed min/max range.

Chris@1: Chris@6:

Definition at line 142 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ minValue

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
float _VampOutputDescriptor::minValue
Chris@6:
Chris@1: Chris@1:

Minimum value for a returned result in any bin, if hasKnownExtents.

Chris@1: Chris@6:

Definition at line 145 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ maxValue

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
float _VampOutputDescriptor::maxValue
Chris@6:
Chris@1: Chris@1:

Maximum value for a returned result in any bin, if hasKnownExtents.

Chris@1: Chris@6:

Definition at line 148 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ isQuantized

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
int _VampOutputDescriptor::isQuantized
Chris@6:
Chris@1: Chris@1:

1 if returned results are quantized to a particular resolution.

Chris@1: Chris@6:

Definition at line 151 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ quantizeStep

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
float _VampOutputDescriptor::quantizeStep
Chris@6:
Chris@1: Chris@1:

Quantization resolution for returned results, if isQuantized.

Chris@1: Chris@6:

Definition at line 154 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ sampleType

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
VampSampleType _VampOutputDescriptor::sampleType
Chris@6:
Chris@1: Chris@1:

Time positioning method for returned results (see VampSampleType).

Chris@1: Chris@6:

Definition at line 157 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ sampleRate

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
float _VampOutputDescriptor::sampleRate
Chris@6:
Chris@1: Chris@1:

Sample rate of returned results, if sampleType is vampFixedSampleRate.

Chris@1:

"Resolution" of result, if sampleType is vampVariableSampleRate.

Chris@1: Chris@6:

Definition at line 161 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ hasDuration

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
int _VampOutputDescriptor::hasDuration
Chris@6:
Chris@1: Chris@1:

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

Chris@1:

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.

Chris@1: Chris@6:

Definition at line 170 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@1:
The documentation for this struct was generated from the following file: Chris@3:
Chris@6:
Chris@6: Chris@6: Chris@1: Chris@1: