summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLyndon Brown <jnqnfe@gmail.com>2018-05-27 05:14:04 +0100
committerTanu Kaskinen <tanuk@iki.fi>2018-06-04 13:20:15 +0300
commitc0ea7d2c6138f09f7abd172a9e7f2a170e49c316 (patch)
tree336c2e309b69a52161cd322e41591b3bc0192eb6
parent7340e7fff4dbfec2ebb527788968b65b10fc2758 (diff)
downloadpulseaudio-c0ea7d2c6138f09f7abd172a9e7f2a170e49c316.tar.gz
scache: pa_context_play_sample_with_proplist: clarify proplist param
Existing documentation was unclear about which property list would be the one changed (merged into), making it seem (along with the non-const proplist pointer param, which needs changing seperately), that the proplist object for which a pointer is given will be the one merged into, instead of the internal cached entry's proplist.
-rw-r--r--src/pulse/scache.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/pulse/scache.h b/src/pulse/scache.h
index 2b85854e2..e4b82bc7e 100644
--- a/src/pulse/scache.h
+++ b/src/pulse/scache.h
@@ -116,7 +116,7 @@ pa_operation* pa_context_play_sample_with_proplist(
const char *name /**< Name of the sample to play */,
const char *dev /**< Sink to play this sample on */,
pa_volume_t volume /**< Volume to play this sample with. Starting with 0.9.15 you may pass here PA_VOLUME_INVALID which will leave the decision about the volume to the server side, which is a good idea. */ ,
- pa_proplist *proplist /**< Property list for this sound. The property list of the cached entry will be merged into this property list */,
+ pa_proplist *proplist /**< Property list for this sound. The property list of the cached entry will have this merged into it. */,
pa_context_play_sample_cb_t cb /**< Call this function after successfully starting playback, or NULL */,
void *userdata /**< Userdata to pass to the callback */);