summaryrefslogtreecommitdiff
path: root/sys/shm
diff options
context:
space:
mode:
Diffstat (limited to 'sys/shm')
-rw-r--r--sys/shm/gstshmsink.c14
-rw-r--r--sys/shm/gstshmsrc.c18
2 files changed, 28 insertions, 4 deletions
diff --git a/sys/shm/gstshmsink.c b/sys/shm/gstshmsink.c
index d37c28d85..605e79871 100644
--- a/sys/shm/gstshmsink.c
+++ b/sys/shm/gstshmsink.c
@@ -18,8 +18,18 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
-
-
+/**
+ * SECTION:element-shmsink
+ *
+ * Send data over shared memory to the matching source.
+ *
+ * <refsect2>
+ * <title>Example launch lines</title>
+ * |[
+ * gst-launch -v videotestsrc ! shmsink socket-path=/tmp/blah shm-size=1000000
+ * ]| Send video to shm buffers.
+ * </refsect2>
+ */
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
diff --git a/sys/shm/gstshmsrc.c b/sys/shm/gstshmsrc.c
index b7537f436..672f4f3a4 100644
--- a/sys/shm/gstshmsrc.c
+++ b/sys/shm/gstshmsrc.c
@@ -18,6 +18,20 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
+/**
+ * SECTION:element-shmsrc
+ *
+ * Receive data from the shared memory sink.
+ *
+ * <refsect2>
+ * <title>Example launch lines</title>
+ * |[
+ * gst-launch shmsrc socket-path=/tmp/blah ! \
+ * "video/x-raw-yuv, format=(fourcc)YUY2, color-matrix=(string)sdtv, \
+ * chroma-site=(string)mpeg2, width=(int)320, height=(int)240, framerate=(fraction)30/1" ! autovideosink
+ * ]| Render video from shm buffers.
+ * </refsect2>
+ */
#ifdef HAVE_CONFIG_H
#include "config.h"
@@ -120,10 +134,10 @@ gst_shm_src_class_init (GstShmSrcClass * klass)
gst_element_class_add_pad_template (gstelement_class,
gst_static_pad_template_get (&srctemplate));
- gst_element_class_set_details_simple (gstelement_class,
+ gst_element_class_set_details_simple (element_class,
"Shared Memory Source",
"Source",
- "Receive data from the sharem memory sink",
+ "Receive data from the shared memory sink",
"Olivier Crete <olivier.crete@collabora.co.uk>");
GST_DEBUG_CATEGORY_INIT (shmsrc_debug, "shmsrc", 0, "Shared Memory Source");