summaryrefslogtreecommitdiffstats
path: root/gst/multipart/multipartmux.c
diff options
context:
space:
mode:
authorJulien Moutte <julien@moutte.net>2005-12-08 16:27:12 +0000
committerJulien Moutte <julien@moutte.net>2005-12-08 16:27:12 +0000
commit207aced76da0526d2bd60e874896623cf8714423 (patch)
tree2abfaa52946e25603351177aa783bd46fcba230a /gst/multipart/multipartmux.c
parent82d3a26a560081a4b23afa7db1cccb1249293835 (diff)
docs/plugins/Makefile.am: Add multipart elements.
Original commit message from CVS: 2005-12-08 Julien MOUTTE <julien@moutte.net> * docs/plugins/Makefile.am: Add multipart elements. * docs/plugins/gst-plugins-good-plugins-docs.sgml: * docs/plugins/gst-plugins-good-plugins-sections.txt: Fix flac. * docs/plugins/gst-plugins-good-plugins.hierarchy: * gst/multipart/multipartdemux.c: * gst/multipart/multipartmux.c: Add docs.
Diffstat (limited to 'gst/multipart/multipartmux.c')
-rw-r--r--gst/multipart/multipartmux.c27
1 files changed, 27 insertions, 0 deletions
diff --git a/gst/multipart/multipartmux.c b/gst/multipart/multipartmux.c
index 74ee8688..8bcad113 100644
--- a/gst/multipart/multipartmux.c
+++ b/gst/multipart/multipartmux.c
@@ -17,6 +17,28 @@
* Boston, MA 02111-1307, USA.
*/
+/**
+ * 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>
+ * <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>
+ * </refsect2>
+ */
+
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
@@ -47,6 +69,11 @@ typedef struct
}
GstMultipartPad;
+/**
+ * GstMultipartMux:
+ *
+ * The opaque #GstMultipartMux structure.
+ */
struct _GstMultipartMux
{
GstElement element;