# HG changeset patch
# User cannam
# Date 1144432252 0
# Node ID a67eeb9d634130877424d0d50251e1e50999e48d
# Parent  61887dda7fe0c12bbc1ef9f1f61ba8d11761d803
* better docs for sample rate

diff -r 61887dda7fe0 -r a67eeb9d6341 vamp-sdk/Plugin.h
--- 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;
     };