diff options
| author | Lennart Poettering <lennart@poettering.net> | 2006-04-13 00:56:10 +0000 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2006-04-13 00:56:10 +0000 |
| commit | ceb09d8ae9bd11380ed3dc7d28054812ff0a0f04 (patch) | |
| tree | b4e698a64d85d278f4a4abde643e6a15f7b92baf /src/polyp/volume.h | |
| parent | b33ae7913a51b0a33030912ce789f0328f8caaf1 (diff) | |
Documentation updates
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@696 fefdeb5f-60dc-0310-8127-8f9354f1896f
Diffstat (limited to 'src/polyp/volume.h')
| -rw-r--r-- | src/polyp/volume.h | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/src/polyp/volume.h b/src/polyp/volume.h index 181784f4..a72069eb 100644 --- a/src/polyp/volume.h +++ b/src/polyp/volume.h @@ -53,8 +53,14 @@ * For simple multiplication, pa_sw_volume_multiply() and * pa_sw_cvolume_multiply() can be used. * - * Calculations can only be reliably be performed on software volumes as - * it is commonly unknown what scale hardware volumes use. + * Calculations can only be reliably performed on software volumes + * as it is commonly unknown what scale hardware volumes relate to. + * + * The functions described above are only valid when used with + * software volumes. Hence it is usually a better idea to treat all + * volume values as opaque with a range from PA_VOLUME_MUTE (0%) to + * PA_VOLUME_NORM (100%) and to refrain from any calculations with + * them. * * \section conv_sec Convenience functions * |