Mercurial > hg > svcore

diff base/AudioPlaySource.h @ 1527:710e6250a401 zoom

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge from default branch
author Chris Cannam
date Mon, 17 Sep 2018 13:51:14 +0100
parents 8541563f1fd3
children 618326c4ce4b
line wrap: on
line diff
--- a/base/AudioPlaySource.h	Mon Dec 12 15:18:52 2016 +0000
+++ b/base/AudioPlaySource.h	Mon Sep 17 13:51:14 2018 +0100
@@ -13,8 +13,8 @@
     COPYING included with this distribution for more information.
 */
 
-#ifndef _AUDIO_PLAY_SOURCE_H_
-#define _AUDIO_PLAY_SOURCE_H_
+#ifndef SV_AUDIO_PLAY_SOURCE_H
+#define SV_AUDIO_PLAY_SOURCE_H
 
 #include "BaseTypes.h"
 
@@ -59,7 +59,9 @@
 
     /**
      * Return the current (or thereabouts) output levels in the range
-     * 0.0 -> 1.0, for metering purposes.
+     * 0.0 -> 1.0, for metering purposes.  The values returned are
+     * peak values since the last call to this function was made
+     * (i.e. calling this function also resets them).
      */
     virtual bool getOutputLevels(float &left, float &right) = 0;