diff options
author | Stefan Kost <ensonic@users.sf.net> | 2009-01-28 12:29:42 +0200 |
---|---|---|
committer | Stefan Kost <ensonic@users.sf.net> | 2009-01-28 12:32:59 +0200 |
commit | a99d3f8769ed3fd1266d5216ecefebfd1bdcf663 (patch) | |
tree | 4a5cf5e0f2f44b1f9ccea5344c38ef98f0a92990 /gst/multipart | |
parent | 00fdca0c14eb9a5fe6b8b9f2d5ce2313e3b32f23 (diff) |
Update and add documentation for plugins with no deps (gst).
Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered.
Diffstat (limited to 'gst/multipart')
-rw-r--r-- | gst/multipart/multipartdemux.c | 33 | ||||
-rw-r--r-- | gst/multipart/multipartmux.c | 16 |
2 files changed, 18 insertions, 31 deletions
diff --git a/gst/multipart/multipartdemux.c b/gst/multipart/multipartdemux.c index 3d0cfd72..8a6be443 100644 --- a/gst/multipart/multipartdemux.c +++ b/gst/multipart/multipartdemux.c @@ -22,34 +22,27 @@ /** * SECTION:element-multipartdemux - * @short_description: Demuxer that takes a multipart digital stream as input - * and demuxes one or many digital streams from it. * @see_also: #GstMultipartMux * - * <refsect2> - * <para> * MultipartDemux uses the Content-type field of incoming buffers to demux and * push data to dynamic source pads. Most of the time multipart streams are * sequential JPEG frames generated from a live source such as a network source * or a camera. - * </para> + * + * The output buffers of the multipartdemux typically have no timestamps and are + * usually played as fast as possible (at the rate that the source provides the + * data). + * + * the content in multipart files is separated with a boundary string that can + * be configured specifically with the #GstMultipartDemux:boundary property + * otherwise it will be autodetected. + * + * <refsect2> * <title>Sample pipelines</title> - * <para> - * Here is a simple pipeline to demux a multipart file muxed with - * #GstMultipartMux containing JPEG frames: - * <programlisting> + * |[ * gst-launch filesrc location=/tmp/test.multipart ! multipartdemux ! jpegdec ! ffmpegcolorspace ! ximagesink - * </programlisting> - * </para> - * <para> - * The output buffers of the multipartdemux typically have no timestamps and are usually - * played as fast as possible (at the rate that the source provides the data). - * </para> - * <para> - * the content in multipart files is separated with a boundary string that can be - * configured specifically with the "boundary" property otherwise it will be - * autodetected. - * </para> + * ]| a simple pipeline to demux a multipart file muxed with #GstMultipartMux + * containing JPEG frames. * </refsect2> */ diff --git a/gst/multipart/multipartmux.c b/gst/multipart/multipartmux.c index 45bc4bd7..c1916a96 100644 --- a/gst/multipart/multipartmux.c +++ b/gst/multipart/multipartmux.c @@ -19,23 +19,17 @@ /** * SECTION:element-multipartmux - * @short_description: Muxer that takes one or several digital streams - * and muxes them to a single multipart stream. * - * <refsect2> - * <para> * MultipartMux uses the #GstCaps of the sink pad as the Content-type field for * incoming buffers when muxing them to a multipart stream. Most of the time * multipart streams are sequential JPEG frames. - * </para> + * + * <refsect2> * <title>Sample pipelines</title> - * <para> - * Here is a simple pipeline to mux 5 JPEG frames per second into a multipart - * stream stored to a file : - * <programlisting> + * |[ * gst-launch videotestsrc ! video/x-raw-yuv, framerate=(fraction)5/1 ! jpegenc ! multipartmux ! filesink location=/tmp/test.multipart - * </programlisting> - * </para> + * ]| a simple pipeline to mux 5 JPEG frames per second into a multipart stream + * stored to a file. * </refsect2> */ |