mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-07-03 21:25:54 +00:00
Code Issues 1 Projects Releases Wiki Activity

Slightly polish docs for GstAdapter.

Browse source 
Original commit message from CVS:
Slightly polish docs for GstAdapter.
This commit is contained in:
Michael Smith 2005-11-09 18:41:53 +00:00
parent 7f6d267bdc
commit a28a3fdd04
2 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
gst/base/gstadapter.c
View file

@ -176,7 +176,7 @@ gst_adapter_clear (GstAdapter * adapter)
/** /**
* gst_adapter_push: * gst_adapter_push:
* @adapter: a #GstAdapter * @adapter: a #GstAdapter
* @buf: the #GstBuffer to queue into the adapter * @buf: a #GstBuffer to add to queue in the adapter
* *
* Adds the data from @buf to the data stored inside @adapter and takes * Adds the data from @buf to the data stored inside @adapter and takes
* ownership of the buffer. * ownership of the buffer.
@ -263,7 +263,8 @@ gst_adapter_peek (GstAdapter * adapter, guint size)
* @adapter: a #GstAdapter * @adapter: a #GstAdapter
* @flush: the number of bytes to flush * @flush: the number of bytes to flush
* *
* Flushes the first @flush bytes out of @adapter. * Flushes the first @flush bytes in the @adapter. The caller must ensure that
* at least this many bytes are available.
* *
* See also: gst_adapter_peek(). * See also: gst_adapter_peek().
*/ */
@ -352,10 +353,10 @@ gst_adapter_available (GstAdapter * adapter)
* gst_adapter_available_fast: * gst_adapter_available_fast:
* @adapter: a #GstAdapter * @adapter: a #GstAdapter
* *
* Gets the maximum amount of bytes available without the need to do expensive * Gets the maximum number of bytes available without the need to do expensive
* operations (like copying the data into a temporary buffer). * operations (like copying the data into a temporary buffer).
* *
* Returns: amount of bytes available in @adapter without expensive operations * Returns: number of bytes available in @adapter without expensive operations
*/ */
guint guint
gst_adapter_available_fast (GstAdapter * adapter) gst_adapter_available_fast (GstAdapter * adapter)

9
libs/gst/base/gstadapter.c
View file

@ -176,7 +176,7 @@ gst_adapter_clear (GstAdapter * adapter)
/** /**
* gst_adapter_push: * gst_adapter_push:
* @adapter: a #GstAdapter * @adapter: a #GstAdapter
* @buf: the #GstBuffer to queue into the adapter * @buf: a #GstBuffer to add to queue in the adapter
* *
* Adds the data from @buf to the data stored inside @adapter and takes * Adds the data from @buf to the data stored inside @adapter and takes
* ownership of the buffer. * ownership of the buffer.
@ -263,7 +263,8 @@ gst_adapter_peek (GstAdapter * adapter, guint size)
* @adapter: a #GstAdapter * @adapter: a #GstAdapter
* @flush: the number of bytes to flush * @flush: the number of bytes to flush
* *
* Flushes the first @flush bytes out of @adapter. * Flushes the first @flush bytes in the @adapter. The caller must ensure that
* at least this many bytes are available.
* *
* See also: gst_adapter_peek(). * See also: gst_adapter_peek().
*/ */
@ -352,10 +353,10 @@ gst_adapter_available (GstAdapter * adapter)
* gst_adapter_available_fast: * gst_adapter_available_fast:
* @adapter: a #GstAdapter * @adapter: a #GstAdapter
* *
* Gets the maximum amount of bytes available without the need to do expensive * Gets the maximum number of bytes available without the need to do expensive
* operations (like copying the data into a temporary buffer). * operations (like copying the data into a temporary buffer).
* *
* Returns: amount of bytes available in @adapter without expensive operations * Returns: number of bytes available in @adapter without expensive operations
*/ */
guint guint
gst_adapter_available_fast (GstAdapter * adapter) gst_adapter_available_fast (GstAdapter * adapter)