summaryrefslogtreecommitdiff
path: root/ext/curl
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim.muller@collabora.co.uk>2011-03-01 11:16:56 +0000
committerTim-Philipp Müller <tim.muller@collabora.co.uk>2011-03-01 11:16:56 +0000
commitc6d7071d938d2acb5481f5e8ea9cf0e671a5c2b4 (patch)
tree7c8053b78b3a8060e6ab7441d65bcabd0a7205d4 /ext/curl
parent1fe9c8c8ae2bf8456b5ac9b411a52de53ba95c3e (diff)
downloadgstreamer-plugins-bad-c6d7071d938d2acb5481f5e8ea9cf0e671a5c2b4.tar.gz
docs: add new curl plugin and curlsink element to docs
Diffstat (limited to 'ext/curl')
-rw-r--r--ext/curl/gstcurlsink.c28
1 files changed, 25 insertions, 3 deletions
diff --git a/ext/curl/gstcurlsink.c b/ext/curl/gstcurlsink.c
index 77fa1c483..f234e3777 100644
--- a/ext/curl/gstcurlsink.c
+++ b/ext/curl/gstcurlsink.c
@@ -17,6 +17,31 @@
* Boston, MA 02111-1307, USA.
*/
+/**
+ * SECTION:element-curlsink
+ * @short_description: sink that uploads data to a server using libcurl
+ * @see_also:
+ *
+ * This is a network sink that uses libcurl as a client to upload data to
+ * a server (e.g. a HTTP/FTP server).
+ *
+ * <refsect2>
+ * <title>Example launch line (upload a JPEG file to an HTTP server)</title>
+ * |[
+ * gst-launch filesrc filesrc location=image.jpg ! jpegparse ! curlsink \
+ * file-name=image.jpg \
+ * location=http://192.168.0.1:8080/cgi-bin/patupload.cgi/ \
+ * user=test passwd=test \
+ * content-type=image/jpeg \
+ * use-content-length=false
+ * ]|
+ * </refsect2>
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
#include <curl/curl.h>
#include <string.h>
#include <stdio.h>
@@ -30,9 +55,6 @@
#include <sys/stat.h>
#include <fcntl.h>
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
#include "gstcurlsink.h"
/* Default values */