Mercurial > hg > vamp-plugin-sdk
diff vamp-sdk/Plugin.h @ 17:a67eeb9d6341
* better docs for sample rate
| author | cannam |
|---|---|
| date | Fri, 07 Apr 2006 17:50:52 +0000 |
| parents | 44113b1e296b |
| children | 68b8b32a2070 |
line wrap: on
line diff
--- a/vamp-sdk/Plugin.h Fri Apr 07 15:32:10 2006 +0000 +++ b/vamp-sdk/Plugin.h Fri Apr 07 17:50:52 2006 +0000 @@ -275,14 +275,14 @@ SampleType sampleType; /** - * Sample rate of the output results. Undefined if sampleType - * is OneSamplePerStep. + * 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). - * It's recommended to set this to zero if that behaviour is - * not desired. + * 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. */ float sampleRate; };