mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-02-04 05:22:30 +00:00
plugins/elements/: Remove short_description. Add basic docs for gsttypefindelement.
Original commit message from CVS: * plugins/elements/gstcapsfilter.c: * plugins/elements/gstfakesink.c: * plugins/elements/gstfakesrc.c: * plugins/elements/gstfdsink.c: * plugins/elements/gstfdsrc.c: * plugins/elements/gstfilesink.c: * plugins/elements/gstfilesrc.c: * plugins/elements/gstidentity.c: * plugins/elements/gstmultiqueue.c: * plugins/elements/gstqueue.c: * plugins/elements/gsttee.c: * plugins/elements/gsttypefindelement.c: Remove short_description. Add basic docs for gsttypefindelement. Simplify markup for fakesrc/fdsrc.
This commit is contained in:
parent
98440eb49d
commit
ef70805d24
13 changed files with 46 additions and 42 deletions
17
ChangeLog
17
ChangeLog
|
@ -1,3 +1,20 @@
|
|||
2008-06-20 Stefan Kost <ensonic@users.sf.net>
|
||||
|
||||
* plugins/elements/gstcapsfilter.c:
|
||||
* plugins/elements/gstfakesink.c:
|
||||
* plugins/elements/gstfakesrc.c:
|
||||
* plugins/elements/gstfdsink.c:
|
||||
* plugins/elements/gstfdsrc.c:
|
||||
* plugins/elements/gstfilesink.c:
|
||||
* plugins/elements/gstfilesrc.c:
|
||||
* plugins/elements/gstidentity.c:
|
||||
* plugins/elements/gstmultiqueue.c:
|
||||
* plugins/elements/gstqueue.c:
|
||||
* plugins/elements/gsttee.c:
|
||||
* plugins/elements/gsttypefindelement.c:
|
||||
Remove short_description. Add basic docs for gsttypefindelement.
|
||||
Simplify markup for fakesrc/fdsrc.
|
||||
|
||||
2008-06-20 Wim Taymans <wim.taymans@collabora.co.uk>
|
||||
|
||||
* plugins/elements/gstfdsrc.c: (gst_fd_src_class_init):
|
||||
|
|
|
@ -21,7 +21,6 @@
|
|||
*/
|
||||
/**
|
||||
* SECTION:element-capsfilter
|
||||
* @short_description: pass data though unmodified, but enforces format limmits
|
||||
*
|
||||
* The element does not modify data as such, but can enforce limmitations on the
|
||||
* data format.
|
||||
|
|
|
@ -21,7 +21,6 @@
|
|||
*/
|
||||
/**
|
||||
* SECTION:element-fakesink
|
||||
* @short_description: black hole for data
|
||||
* @see_also: #GstFakeSrc
|
||||
*
|
||||
* Dummy sink that swallows everything.
|
||||
|
|
|
@ -21,30 +21,23 @@
|
|||
*/
|
||||
/**
|
||||
* SECTION:element-fakesrc
|
||||
* @short_description: Generate (meaningless) buffers
|
||||
* @see_also: #GstFakeSink
|
||||
*
|
||||
* <refsect2>
|
||||
* <para>
|
||||
* The fakesrc element is a multipurpose element that can generate
|
||||
* a wide range of buffers and can operate in various scheduling modes.
|
||||
* </para>
|
||||
* <para>
|
||||
*
|
||||
* It is mostly used as a testing element, one trivial example for testing
|
||||
* basic <application>GStreamer</application> core functionality is:
|
||||
* </para>
|
||||
*
|
||||
* <refsect2>
|
||||
* <title>Example launch line</title>
|
||||
* <para>
|
||||
* <programlisting>
|
||||
* |[
|
||||
* gst-launch -v fakesrc num-buffers=5 ! fakesink
|
||||
* </programlisting>
|
||||
* This pipeline will push 5 empty buffers to the fakesink element and then
|
||||
* ]| This pipeline will push 5 empty buffers to the fakesink element and then
|
||||
* sends an EOS.
|
||||
* </para>
|
||||
* <para>
|
||||
* Last reviewed on 2005-12-02 (0.9.7)
|
||||
* </para>
|
||||
* </refsect2>
|
||||
*
|
||||
* Last reviewed on 2008-06-20 (0.10.21)
|
||||
*/
|
||||
|
||||
#ifdef HAVE_CONFIG_H
|
||||
|
|
|
@ -22,7 +22,6 @@
|
|||
|
||||
/**
|
||||
* SECTION:element-fdsink
|
||||
* @short_description: write to a unix file descriptor
|
||||
* @see_also: #GstFdSrc
|
||||
*
|
||||
* Write data to a unix file descriptor.
|
||||
|
|
|
@ -22,26 +22,15 @@
|
|||
*/
|
||||
/**
|
||||
* SECTION:element-fdsrc
|
||||
* @short_description: read from a unix file descriptor
|
||||
* @see_also: #GstFdSink
|
||||
*
|
||||
* <refsect2>
|
||||
* <para>
|
||||
* Read data from a unix file descriptor.
|
||||
* </para>
|
||||
* <title>Examples</title>
|
||||
* <para>
|
||||
* Here is a simple pipeline to read from the standard input and dump the data
|
||||
* with a fakesink.
|
||||
* <programlisting>
|
||||
* gst-launch -v fdsrc ! fakesink dump=1
|
||||
* </programlisting>
|
||||
*
|
||||
* To generate data, enter some data on the console folowed by enter.
|
||||
* The above mentioned pipeline should dump data packets to the console.
|
||||
* </para>
|
||||
* <para>
|
||||
* If the <link linkend="GstFdSrc--timeout">timeout property</link> is set to a
|
||||
* value bigger than 0, fdsrc will generate an element message named
|
||||
*
|
||||
* If the #GstFdSrc:timeout property is set to a value bigger than 0, fdsrc will
|
||||
* generate an element message named
|
||||
* <classname>"GstFdSrcTimeout"</classname>
|
||||
* if no data was recieved in the given timeout.
|
||||
* The message's structure contains one field:
|
||||
|
@ -54,11 +43,16 @@
|
|||
* </para>
|
||||
* </listitem>
|
||||
* </itemizedlist>
|
||||
* </para>
|
||||
* <para>
|
||||
* Last reviewed on 2008-06-20 (0.10.21)
|
||||
* </para>
|
||||
*
|
||||
* <refsect2>
|
||||
* <title>Example launch line</title>
|
||||
* |[
|
||||
* echo "Hello GStreamer" | gst-launch -v fdsrc ! fakesink dump=true
|
||||
* ]| A simple pipeline to read from the standard input and dump the data
|
||||
* with a fakesink as hex ascii block.
|
||||
* </refsect2>
|
||||
*
|
||||
* Last reviewed on 2008-06-20 (0.10.21)
|
||||
*/
|
||||
|
||||
#ifdef HAVE_CONFIG_H
|
||||
|
|
|
@ -22,7 +22,6 @@
|
|||
*/
|
||||
/**
|
||||
* SECTION:element-filesink
|
||||
* @short_description: write stream to a file
|
||||
* @see_also: #GstFileSrc
|
||||
*
|
||||
* Write incoming data to a file in the local file system.
|
||||
|
|
|
@ -21,7 +21,6 @@
|
|||
*/
|
||||
/**
|
||||
* SECTION:element-filesrc
|
||||
* @short_description: read from arbitrary point in a file
|
||||
* @see_also: #GstFileSrc
|
||||
*
|
||||
* Read data from a file in the local file system.
|
||||
|
|
|
@ -22,7 +22,6 @@
|
|||
*/
|
||||
/**
|
||||
* SECTION:element-identity
|
||||
* @short_description: pass data through without modification
|
||||
*
|
||||
* Dummy element that passes incomming data through unmodified. I has some
|
||||
* useful diagnostic functions, such as offset and timestamp checking.
|
||||
|
|
|
@ -23,7 +23,6 @@
|
|||
|
||||
/**
|
||||
* SECTION:element-multiqueue
|
||||
* @short_description: Asynchronous data queues
|
||||
* @see_also: #GstQueue
|
||||
*
|
||||
* <refsect2>
|
||||
|
|
|
@ -24,7 +24,6 @@
|
|||
|
||||
/**
|
||||
* SECTION:element-queue
|
||||
* @short_description: Simple asynchronous data queue.
|
||||
*
|
||||
* Data is queued until one of the limits specified by the
|
||||
* #GstQueue:max-size-buffers, #GstQueue:max-size-bytes and/or
|
||||
|
|
|
@ -23,7 +23,6 @@
|
|||
|
||||
/**
|
||||
* SECTION:element-tee
|
||||
* @short_description: 1-to-N pipe fitting
|
||||
* @see_also: #GstIdentity
|
||||
*
|
||||
* Split data to multiple pads.
|
||||
|
|
|
@ -18,6 +18,15 @@
|
|||
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
||||
* Boston, MA 02111-1307, USA.
|
||||
*/
|
||||
/**
|
||||
* SECTION:element-typefind
|
||||
*
|
||||
* Determines the media-type of a stream. It applies typefind functions in the
|
||||
* order of their rank. One the type has been deteted it sets its src pad caps
|
||||
* to the found media type.
|
||||
*
|
||||
* Plugins can register custom typefinders by using #GstTypeFindFactory.
|
||||
*/
|
||||
|
||||
/* FIXME: need a better solution for non-seekable streams */
|
||||
|
||||
|
|
Loading…
Reference in a new issue