[pulseaudio-commits] r1999 - in /trunk/src/pulse: simple.h stream.h

[svnmailer-noreply at 0pointer.de]

Author: lennart
Date: Tue Oct 30 15:17:41 2007
New Revision: 1999

URL: http://0pointer.de/cgi-bin/viewcvs.cgi?rev=1999&root=pulseaudio&view=rev
Log:
rename 'length' parameters in the API to 'bytes', to make their unit clear

Modified:
    trunk/src/pulse/simple.h
    trunk/src/pulse/stream.h

Modified: trunk/src/pulse/simple.h
URL: http://0pointer.de/cgi-bin/viewcvs.cgi/trunk/src/pulse/simple.h?rev=1999&root=pulseaudio&r1=1998&r2=1999&view=diff
==============================================================================
--- trunk/src/pulse/simple.h (original)
+++ trunk/src/pulse/simple.h Tue Oct 30 15:17:41 2007
@@ -130,13 +130,13 @@
 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 */
 pa_usec_t pa_simple_get_latency(pa_simple *s, int *error);

Modified: trunk/src/pulse/stream.h
URL: http://0pointer.de/cgi-bin/viewcvs.cgi/trunk/src/pulse/stream.h?rev=1999&root=pulseaudio&r1=1998&r2=1999&view=diff
==============================================================================
--- trunk/src/pulse/stream.h (original)
+++ trunk/src/pulse/stream.h Tue Oct 30 15:17:41 2007
@@ -271,7 +271,7 @@
 typedef void (*pa_stream_success_cb_t) (pa_stream*s, int success, void *userdata);
 
 /** A generic request callback */
-typedef void (*pa_stream_request_cb_t)(pa_stream *p, size_t length, void *userdata);
+typedef void (*pa_stream_request_cb_t)(pa_stream *p, size_t bytes, void *userdata);
 
 /** A generic notification callback */
 typedef void (*pa_stream_notify_cb_t)(pa_stream *p, void *userdata);
@@ -327,7 +327,7 @@
 int pa_stream_write(
         pa_stream *p             /**< The stream to use */,
         const void *data         /**< The data to write */,
-        size_t length            /**< The length of the data to write */,
+        size_t bytes             /**< The length of the data to write in bytes*/,
         pa_free_cb_t free_cb     /**< A cleanup routine for the data or NULL to request an internal copy */,
         int64_t offset,          /**< Offset for seeking, must be 0 for upload streams */
         pa_seek_mode_t seek      /**< Seek mode, must be PA_SEEK_RELATIVE for upload streams */);
@@ -340,16 +340,16 @@
 int pa_stream_peek(
         pa_stream *p                 /**< The stream to use */,
         const void **data            /**< Pointer to pointer that will point to data */,
-        size_t *length              /**< The length of the data read */);
+        size_t *bytes                /**< The length of the data read in bytes */);
 
 /** Remove the current fragment on record streams. It is invalid to do this without first
  * calling pa_stream_peek(). \since 0.8 */
 int pa_stream_drop(pa_stream *p);
 
-/** Return the nember of bytes that may be written using pa_stream_write() */
+/** Return the nember of bytes that may be written using pa_stream_write(), in bytes */
 size_t pa_stream_writable_size(pa_stream *p);
 
-/** Return the number of bytes that may be read using pa_stream_read() \since 0.8 */
+/** Return the number of bytes that may be read using pa_stream_read(), in bytes \since 0.8 */
 size_t pa_stream_readable_size(pa_stream *p);
 
 /** Drain a playback stream. Use this for notification when the buffer is empty */