docs: add new curl plugin and curlsink element to docs

This commit is contained in:
Tim-Philipp Müller 2011-03-01 11:16:56 +00:00
parent 1fe9c8c8ae
commit c6d7071d93
5 changed files with 70 additions and 3 deletions

View file

@ -94,6 +94,7 @@ EXTRA_HFILES = \
$(top_srcdir)/ext/amrwbenc/gstamrwbenc.h \
$(top_srcdir)/ext/celt/gstceltdec.h \
$(top_srcdir)/ext/celt/gstceltenc.h \
$(top_srcdir)/ext/curl/gstcurlsink.h \
$(top_srcdir)/ext/dc1394/gstdc1394.h \
$(top_srcdir)/ext/directfb/dfbvideosink.h \
$(top_srcdir)/ext/dts/gstdtsdec.h \

View file

@ -33,6 +33,7 @@
<xi:include href="xml/element-chromium.xml" />
<xi:include href="xml/element-circle.xml" />
<xi:include href="xml/element-coloreffects.xml" />
<xi:include href="xml/element-curlsink.xml" />
<xi:include href="xml/element-cvdilate.xml" />
<xi:include href="xml/element-cverode.xml" />
<xi:include href="xml/element-cvequalizehist.xml" />
@ -147,6 +148,7 @@
<xi:include href="xml/plugin-cdxaparse.xml" />
<xi:include href="xml/plugin-celt.xml" />
<xi:include href="xml/plugin-coloreffects.xml" />
<xi:include href="xml/plugin-curl.xml" />
<xi:include href="xml/plugin-dataurisrc.xml" />
<xi:include href="xml/plugin-dccp.xml" />
<xi:include href="xml/plugin-debugutilsbad.xml" />

View file

@ -244,6 +244,20 @@ GST_TYPE_COLOR_EFFECTS
gst_color_effects_get_type
</SECTION>
<SECTION>
<FILE>element-curlsink</FILE>
<TITLE>curlsink</TITLE>
GstCurlSink
<SUBSECTION Standard>
GstCurlSinkClass
GST_CURL_SINK
GST_CURL_SINK_CLASS
GST_IS_CURL_SINK
GST_IS_CURL_SINK_CLASS
GST_TYPE_CURL_SINK
gst_curl_sink_get_type
</SECTION>
<SECTION>
<FILE>element-cvdilate</FILE>
<TITLE>cvdilate</TITLE>

View file

@ -0,0 +1,28 @@
<plugin>
<name>curl</name>
<description>libcurl-based elements</description>
<filename>../../ext/curl/.libs/libgstcurl.so</filename>
<basename>libgstcurl.so</basename>
<version>0.10.21.1</version>
<license>LGPL</license>
<source>gst-plugins-bad</source>
<package>GStreamer Bad Plug-ins git</package>
<origin>Unknown package origin</origin>
<elements>
<element>
<name>curlsink</name>
<longname>Curl sink</longname>
<class>Sink/Network</class>
<description>Upload data over the network to a server using libcurl</description>
<author>Patricia Muscalu &lt;patricia@axis.com&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>ANY</details>
</caps>
</pads>
</element>
</elements>
</plugin>

View file

@ -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 */