diff options
author | Lennart Poettering <lennart@poettering.net> | 2006-02-20 17:09:39 +0000 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2006-02-20 17:09:39 +0000 |
commit | 98cb6aa4a30a993ddf2c15f0a03cb4d94383d4d9 (patch) | |
tree | f55eec2774433bba2fa065260f60ced629a17b43 /src/polyp/scache.h | |
parent | 71e063a69533fedc283c55eed735332e5b00713e (diff) |
* a lot of doxygen updates
* s/pa_operation_callback/pa_operation_callback_t/g
* add more typedefs for function prototypes
* add API to query the channel map used by a pa_stream
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@530 fefdeb5f-60dc-0310-8127-8f9354f1896f
Diffstat (limited to 'src/polyp/scache.h')
-rw-r--r-- | src/polyp/scache.h | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/src/polyp/scache.h b/src/polyp/scache.h index 5bf004d0..3480d876 100644 --- a/src/polyp/scache.h +++ b/src/polyp/scache.h @@ -36,14 +36,21 @@ PA_C_DECL_BEGIN /** Make this stream a sample upload stream */ void pa_stream_connect_upload(pa_stream *s, size_t length); -/** Finish the sample upload, the stream name will become the sample name. You cancel a sample upload by issuing pa_stream_disconnect() */ +/** Finish the sample upload, the stream name will become the sample name. You cancel a samp + * le upload by issuing pa_stream_disconnect() */ void pa_stream_finish_upload(pa_stream *s); /** Play a sample from the sample cache to the specified device. If the latter is NULL use the default sink. Returns an operation object */ -pa_operation* pa_context_play_sample(pa_context *c, const char *name, const char *dev, uint32_t volume, void (*cb)(pa_context *c, int success, void *userdata), void *userdata); +pa_operation* pa_context_play_sample( + pa_context *c /**< Context */, + 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 */ , + pa_context_success_cb_t cb /**< Call this function after successfully starting playback, or NULL */, + void *userdata /**< Userdata to pass to the callback */); /** Remove a sample from the sample cache. Returns an operation object which may be used to cancel the operation while it is running */ -pa_operation* pa_context_remove_sample(pa_context *c, const char *name, void (*cb)(pa_context *c, int success, void *userdata), void *userdata); +pa_operation* pa_context_remove_sample(pa_context *c, const char *name, pa_context_success_cb_t, void *userdata); PA_C_DECL_END |