|
| char * | identifier |
| | The name of the output, in computer-usable form.
|
| |
| char * | name |
| | The human-readable name of the output.
|
| |
| char * | description |
| | A human-readable short text describing the output.
|
| |
| char * | unit |
| | The unit of the output, in human-readable form.
|
| |
| bool | hasFixedBinCount |
| | True if the output has the same number of values per sample for every output sample.
|
| |
| bool | hasKnownExtents |
| | True if the results in each output bin fall within a fixed numeric range (minimum and maximum values).
|
| |
| float | minValue |
| | Minimum value of the results in the output.
|
| |
| float | maxValue |
| | Maximum value of the results in the output.
|
| |
| int | sampleType |
| | Positioning in time of the output results.
|
| |
| float | sampleRate |
| | Sample rate of the output results, as samples per second.
|
| |
| bool | hasDuration |
| | True if the returned results for this output are known to have a duration field.
|
| |
Definition at line 156 of file vamp.h.
◆ description
| char* ZVampOutputDescriptor::description |
A human-readable short text describing the output.
May be empty if the name has said it all already. Example: "The number of zero crossing points
per processing block".
Definition at line 180 of file vamp.h.
◆ hasDuration
| bool ZVampOutputDescriptor::hasDuration |
True if the returned results for this output are known to have a duration field.
Definition at line 236 of file vamp.h.
◆ hasFixedBinCount
| bool ZVampOutputDescriptor::hasFixedBinCount |
True if the output has the same number of values per sample for every output sample.
Outputs for which this is false are unlikely to be very useful in a general-purpose host.
Definition at line 193 of file vamp.h.
◆ hasKnownExtents
| bool ZVampOutputDescriptor::hasKnownExtents |
True if the results in each output bin fall within a fixed numeric range (minimum and maximum values).
Undefined if binCount is zero.
Definition at line 200 of file vamp.h.
◆ identifier
| char* ZVampOutputDescriptor::identifier |
The name of the output, in computer-usable form.
Should be reasonably short and without whitespace or punctuation, using the characters [a-zA-Z0-9_-] only. Example: "zero_crossing_count"
Definition at line 165 of file vamp.h.
◆ maxValue
| float ZVampOutputDescriptor::maxValue |
Maximum value of the results in the output.
Undefined if hasKnownExtents is false or binCount is zero.
Definition at line 212 of file vamp.h.
◆ minValue
| float ZVampOutputDescriptor::minValue |
Minimum value of the results in the output.
Undefined if hasKnownExtents is false or binCount is zero.
Definition at line 206 of file vamp.h.
◆ name
| char* ZVampOutputDescriptor::name |
The human-readable name of the output.
Example: "Zero Crossing Counts"
Definition at line 171 of file vamp.h.
◆ sampleRate
| float ZVampOutputDescriptor::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.
Definition at line 230 of file vamp.h.
◆ sampleType
| int ZVampOutputDescriptor::sampleType |
Positioning in time of the output results.
Definition at line 217 of file vamp.h.
◆ unit
| char* ZVampOutputDescriptor::unit |
The unit of the output, in human-readable form.
Definition at line 185 of file vamp.h.
The documentation for this struct was generated from the following file:
1.11.0