comparison 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
comparison
equal deleted inserted replaced
16:61887dda7fe0 17:a67eeb9d6341
273 * Positioning in time of the output results. 273 * Positioning in time of the output results.
274 */ 274 */
275 SampleType sampleType; 275 SampleType sampleType;
276 276
277 /** 277 /**
278 * Sample rate of the output results. Undefined if sampleType 278 * Sample rate of the output results, as samples per second.
279 * is OneSamplePerStep. 279 * Undefined if sampleType is OneSamplePerStep.
280 * 280 *
281 * If sampleType is VariableSampleRate and this value is 281 * If sampleType is VariableSampleRate and this value is
282 * non-zero, then it may be used to calculate a resolution for 282 * non-zero, then it may be used to calculate a resolution for
283 * the output (i.e. the "duration" of each sample, in time). 283 * the output (i.e. the "duration" of each sample, in time,
284 * It's recommended to set this to zero if that behaviour is 284 * will be 1/sampleRate seconds). It's recommended to set
285 * not desired. 285 * this to zero if that behaviour is not desired.
286 */ 286 */
287 float sampleRate; 287 float sampleRate;
288 }; 288 };
289 289
290 typedef std::vector<OutputDescriptor> OutputList; 290 typedef std::vector<OutputDescriptor> OutputList;