diff options
Diffstat (limited to 'src/pulse/simple.h')
| -rw-r--r-- | src/pulse/simple.h | 33 |
1 files changed, 19 insertions, 14 deletions
diff --git a/src/pulse/simple.h b/src/pulse/simple.h index 0438d319..ecffe4fa 100644 --- a/src/pulse/simple.h +++ b/src/pulse/simple.h @@ -1,21 +1,22 @@ #ifndef foosimplehfoo #define foosimplehfoo -/* $Id$ */ - /*** This file is part of PulseAudio. - + + Copyright 2004-2006 Lennart Poettering + Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB + PulseAudio is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published - by the Free Software Foundation; either version 2 of the License, + by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. - + PulseAudio is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - + You should have received a copy of the GNU Lesser General Public License along with PulseAudio; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 @@ -28,6 +29,7 @@ #include <pulse/channelmap.h> #include <pulse/def.h> #include <pulse/cdecl.h> +#include <pulse/version.h> /** \page simple Simple API * @@ -48,7 +50,7 @@ * pa_simple *s; * pa_sample_spec ss; * - * ss.format = PA_SAMPLE_S16_NE; + * ss.format = PA_SAMPLE_S16NE; * ss.channels = 2; * ss.rate = 44100; * @@ -80,8 +82,8 @@ * * \li pa_simple_drain() - Will wait for all sent data to finish playing. * \li pa_simple_flush() - Will throw away all data currently in buffers. - * \li pa_simple_get_playback_latency() - Will return the total latency of - * the playback pipeline. + * \li pa_simple_get_latency() - Will return the total latency of + * the playback pipeline. * * \section cleanup_sec Cleanup * @@ -96,7 +98,10 @@ /** \file * A simple but limited synchronous playback and recording * API. This is a synchronous, simplified wrapper around the standard - * asynchronous API. */ + * asynchronous API. + * + * See also \subpage simple + */ /** \example pacat-simple.c * A simple playback tool using the simple API */ @@ -127,18 +132,18 @@ pa_simple* pa_simple_new( void pa_simple_free(pa_simple *s); /** Write some data to the server */ -int pa_simple_write(pa_simple *s, const void*data, size_t length, int *error); +int pa_simple_write(pa_simple *s, const void*data, size_t bytes, int *error); /** Wait until all data already written is played by the daemon */ int pa_simple_drain(pa_simple *s, int *error); /** Read some data from the server */ -int pa_simple_read(pa_simple *s, void*data, size_t length, int *error); +int pa_simple_read(pa_simple *s, void*data, size_t bytes, int *error); -/** Return the playback latency. \since 0.5 */ +/** Return the playback latency. */ pa_usec_t pa_simple_get_latency(pa_simple *s, int *error); -/** Flush the playback buffer. \since 0.5 */ +/** Flush the playback buffer. This discards any audio in the buffer. */ int pa_simple_flush(pa_simple *s, int *error); PA_C_DECL_END |