mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-11-03 09:01:50 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doxygen: Fix the "all" comments regarding volume helper functions.

Browse source 
Mostly change "Set the volume of all channels" to
"Set the volume of the first n channels" as the first is incorrect,
it doesn't set all the channels and doesn't explain what n was for.
This commit is contained in:
David Fries 2010-10-12 18:22:27 -05:00 • committed by Colin Guthrie
parent 34b568af95
commit 9295e4a0dc
1 changed files with 11 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

21
src/pulse/volume.h
View file

@ -81,12 +81,12 @@
* structure are muted. * structure are muted.
* \li pa_cvolume_is_norm() - Tests if all channels of a pa_cvolume structure * \li pa_cvolume_is_norm() - Tests if all channels of a pa_cvolume structure
* are at a normal volume. * are at a normal volume.
* \li pa_cvolume_set() - Set all channels of a pa_cvolume structure to a * \li pa_cvolume_set() - Set the first n channels of a pa_cvolume structure to
* certain volume. * a certain volume.
* \li pa_cvolume_reset() - Set all channels of a pa_cvolume structure to a * \li pa_cvolume_reset() - Set the first n channels of a pa_cvolume structure
* normal volume. * to a normal volume.
* \li pa_cvolume_mute() - Set all channels of a pa_cvolume structure to a * \li pa_cvolume_mute() - Set the first n channels of a pa_cvolume structure
* muted volume. * to a muted volume.
* \li pa_cvolume_avg() - Return the average volume of all channels. * \li pa_cvolume_avg() - Return the average volume of all channels.
* \li pa_cvolume_snprint() - Pretty print a pa_cvolume structure. * \li pa_cvolume_snprint() - Pretty print a pa_cvolume structure.
*/ */
@ -129,13 +129,13 @@ int pa_cvolume_equal(const pa_cvolume *a, const pa_cvolume *b) PA_GCC_PURE;
* pa_cvolume_valid() will fail for it. \since 0.9.13 */ * pa_cvolume_valid() will fail for it. \since 0.9.13 */
pa_cvolume* pa_cvolume_init(pa_cvolume *a); pa_cvolume* pa_cvolume_init(pa_cvolume *a);
/** Set the volume of all channels to PA_VOLUME_NORM */ /** Set the volume of the first n channels to PA_VOLUME_NORM */
#define pa_cvolume_reset(a, n) pa_cvolume_set((a), (n), PA_VOLUME_NORM) #define pa_cvolume_reset(a, n) pa_cvolume_set((a), (n), PA_VOLUME_NORM)
/** Set the volume of all channels to PA_VOLUME_MUTED */ /** Set the volume of the first n channels to PA_VOLUME_MUTED */
#define pa_cvolume_mute(a, n) pa_cvolume_set((a), (n), PA_VOLUME_MUTED) #define pa_cvolume_mute(a, n) pa_cvolume_set((a), (n), PA_VOLUME_MUTED)
/** Set the volume of all channels to the specified parameter */ /** Set the volume of the specified number of channels to the volume v */
pa_cvolume* pa_cvolume_set(pa_cvolume *a, unsigned channels, pa_volume_t v); pa_cvolume* pa_cvolume_set(pa_cvolume *a, unsigned channels, pa_volume_t v);
/** Maximum length of the strings returned by /** Maximum length of the strings returned by
@ -259,7 +259,8 @@ pa_volume_t pa_sw_volume_from_dB(double f) PA_GCC_CONST;
/** Convert a volume to a decibel value (amplitude, not power). This is only valid for software volumes! */ /** Convert a volume to a decibel value (amplitude, not power). This is only valid for software volumes! */
double pa_sw_volume_to_dB(pa_volume_t v) PA_GCC_CONST; double pa_sw_volume_to_dB(pa_volume_t v) PA_GCC_CONST;
/** Convert a linear factor to a volume. This is only valid for software volumes! */ /** Convert a linear factor to a volume. 0.0 and less is muted while
* 1.0 is PA_VOLUME_NORM. This is only valid for software volumes! */
pa_volume_t pa_sw_volume_from_linear(double v) PA_GCC_CONST; pa_volume_t pa_sw_volume_from_linear(double v) PA_GCC_CONST;
/** Convert a volume to a linear factor. This is only valid for software volumes! */ /** Convert a volume to a linear factor. This is only valid for software volumes! */