• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>curlftpsink: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title>
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual">
8<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
9<link rel="prev" href="gst-plugins-bad-plugins-curlfilesink.html" title="curlfilesink">
10<link rel="next" href="gst-plugins-bad-plugins-curlhttpsink.html" title="curlhttpsink">
11<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
12<link rel="stylesheet" href="style.css" type="text/css">
13</head>
14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16<td width="100%" align="left" class="shortcuts">
17<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span18                  <a href="#gst-plugins-bad-plugins-curlftpsink.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span19                  <a href="#gst-plugins-bad-plugins-curlftpsink.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span20                  <a href="#gst-plugins-bad-plugins-curlftpsink.properties" class="shortcut">Properties</a></span>
21</td>
22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24<td><a accesskey="p" href="gst-plugins-bad-plugins-curlfilesink.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25<td><a accesskey="n" href="gst-plugins-bad-plugins-curlhttpsink.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26</tr></table>
27<div class="refentry">
28<a name="gst-plugins-bad-plugins-curlftpsink"></a><div class="titlepage"></div>
29<div class="refnamediv"><table width="100%"><tr>
30<td valign="top">
31<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-curlftpsink.top_of_page"></a>curlftpsink</span></h2>
32<p>curlftpsink — sink that uploads data to a server using libcurl</p>
33</td>
34<td class="gallery_image" valign="top" align="right"></td>
35</tr></table></div>
36<div class="refsect1">
37<a name="gst-plugins-bad-plugins-curlftpsink.properties"></a><h2>Properties</h2>
38<div class="informaltable"><table class="informaltable" border="0">
39<colgroup>
40<col width="150px" class="properties_type">
41<col width="300px" class="properties_name">
42<col width="200px" class="properties_flags">
43</colgroup>
44<tbody>
45<tr>
46<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
47<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-curlftpsink.html#GstCurlFtpSink--create-dirs" title="The “create-dirs” property">create-dirs</a></td>
48<td class="property_flags">Read / Write</td>
49</tr>
50<tr>
51<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
52<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-curlftpsink.html#GstCurlFtpSink--epsv-mode" title="The “epsv-mode” property">epsv-mode</a></td>
53<td class="property_flags">Read / Write</td>
54</tr>
55<tr>
56<td class="property_type">
57<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
58<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-curlftpsink.html#GstCurlFtpSink--ftp-port" title="The “ftp-port” property">ftp-port</a></td>
59<td class="property_flags">Read / Write</td>
60</tr>
61<tr>
62<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
63<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-curlftpsink.html#GstCurlFtpSink--create-tmp-file" title="The “create-tmp-file” property">create-tmp-file</a></td>
64<td class="property_flags">Read / Write</td>
65</tr>
66<tr>
67<td class="property_type">
68<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
69<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-curlftpsink.html#GstCurlFtpSink--temp-file-name" title="The “temp-file-name” property">temp-file-name</a></td>
70<td class="property_flags">Read / Write</td>
71</tr>
72</tbody>
73</table></div>
74</div>
75<a name="GstCurlFtpSink"></a><div class="refsect1">
76<a name="gst-plugins-bad-plugins-curlftpsink.other"></a><h2>Types and Values</h2>
77<div class="informaltable"><table class="informaltable" width="100%" border="0">
78<colgroup>
79<col width="150px" class="name">
80<col class="description">
81</colgroup>
82<tbody><tr>
83<td class="datatype_keyword">struct</td>
84<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-curlftpsink.html#GstCurlFtpSink-struct" title="struct GstCurlFtpSink">GstCurlFtpSink</a></td>
85</tr></tbody>
86</table></div>
87</div>
88<div class="refsect1">
89<a name="gst-plugins-bad-plugins-curlftpsink.object-hierarchy"></a><h2>Object Hierarchy</h2>
90<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
91    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
92        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
93            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
94                <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseSink.html#GstBaseSink-struct">GstBaseSink</a>
95                    <span class="lineart">╰──</span> GstCurlBaseSink
96                        <span class="lineart">╰──</span> GstCurlTlsSink
97                            <span class="lineart">╰──</span> GstCurlFtpSink
98</pre>
99</div>
100<div class="refsect1">
101<a name="gst-plugins-bad-plugins-curlftpsink.description"></a><h2>Description</h2>
102<p>This is a network sink that uses libcurl as a client to upload data to
103an FTP server.</p>
104<div class="refsect3">
105<a name="id-1.2.40.7.3"></a><h4>Example launch line</h4>
106<p>Upload a JPEG file to /home/test/images * directory)</p>
107<div class="informalexample">
108  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
109    <tbody>
110      <tr>
111        <td class="listing_lines" align="right"><pre>1
1122
1133</pre></td>
114        <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> filesrc location<span class="gtkdoc opt">=</span>image<span class="gtkdoc opt">.</span>jpg <span class="gtkdoc opt">!</span> jpegparse <span class="gtkdoc opt">!</span> curlftpsink  \
115    file<span class="gtkdoc opt">-</span>name<span class="gtkdoc opt">=</span>image<span class="gtkdoc opt">.</span>jpg  \
116    location<span class="gtkdoc opt">=</span>ftp<span class="gtkdoc opt">:</span><span class="gtkdoc slc">//192.168.0.1/images/</span></pre></td>
117      </tr>
118    </tbody>
119  </table>
120</div>
121
122<p></p>
123</div>
124<div class="refsynopsisdiv">
125<h2>Synopsis</h2>
126<div class="refsect2">
127<a name="id-1.2.40.7.4.1"></a><h3>Element Information</h3>
128<div class="variablelist"><table border="0" class="variablelist">
129<colgroup>
130<col align="left" valign="top">
131<col>
132</colgroup>
133<tbody>
134<tr>
135<td><p><span class="term">plugin</span></p></td>
136<td>
137            <a class="link" href="gst-plugins-bad-plugins-plugin-curl.html#plugin-curl">curl</a>
138          </td>
139</tr>
140<tr>
141<td><p><span class="term">author</span></p></td>
142<td>Patricia Muscalu &lt;patricia@axis.com&gt;</td>
143</tr>
144<tr>
145<td><p><span class="term">class</span></p></td>
146<td>Sink/Network</td>
147</tr>
148</tbody>
149</table></div>
150</div>
151<hr>
152<div class="refsect2">
153<a name="id-1.2.40.7.4.2"></a><h3>Element Pads</h3>
154<div class="variablelist"><table border="0" class="variablelist">
155<colgroup>
156<col align="left" valign="top">
157<col>
158</colgroup>
159<tbody>
160<tr>
161<td><p><span class="term">name</span></p></td>
162<td>sink</td>
163</tr>
164<tr>
165<td><p><span class="term">direction</span></p></td>
166<td>sink</td>
167</tr>
168<tr>
169<td><p><span class="term">presence</span></p></td>
170<td>always</td>
171</tr>
172<tr>
173<td><p><span class="term">details</span></p></td>
174<td>ANY</td>
175</tr>
176</tbody>
177</table></div>
178</div>
179</div>
180</div>
181<div class="refsect1">
182<a name="gst-plugins-bad-plugins-curlftpsink.functions_details"></a><h2>Functions</h2>
183<p></p>
184</div>
185<div class="refsect1">
186<a name="gst-plugins-bad-plugins-curlftpsink.other_details"></a><h2>Types and Values</h2>
187<div class="refsect2">
188<a name="GstCurlFtpSink-struct"></a><h3>struct GstCurlFtpSink</h3>
189<pre class="programlisting">struct GstCurlFtpSink;</pre>
190</div>
191</div>
192<div class="refsect1">
193<a name="gst-plugins-bad-plugins-curlftpsink.property-details"></a><h2>Property Details</h2>
194<div class="refsect2">
195<a name="GstCurlFtpSink--create-dirs"></a><h3>The <code class="literal">“create-dirs”</code> property</h3>
196<pre class="programlisting">  “create-dirs”              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
197<p>Attempt to create missing directory included in the path.</p>
198<p>Flags: Read / Write</p>
199<p>Default value: FALSE</p>
200</div>
201<hr>
202<div class="refsect2">
203<a name="GstCurlFtpSink--epsv-mode"></a><h3>The <code class="literal">“epsv-mode”</code> property</h3>
204<pre class="programlisting">  “epsv-mode”                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
205<p>Enable the use of the EPSV command when doing passive FTP transfers.</p>
206<p>Flags: Read / Write</p>
207<p>Default value: TRUE</p>
208</div>
209<hr>
210<div class="refsect2">
211<a name="GstCurlFtpSink--ftp-port"></a><h3>The <code class="literal">“ftp-port”</code> property</h3>
212<pre class="programlisting">  “ftp-port”                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
213<p>The PORT instruction tells the remote server to connect to the IP address.</p>
214<p>Flags: Read / Write</p>
215<p>Default value: ""</p>
216</div>
217<hr>
218<div class="refsect2">
219<a name="GstCurlFtpSink--create-tmp-file"></a><h3>The <code class="literal">“create-tmp-file”</code> property</h3>
220<pre class="programlisting">  “create-tmp-file”          <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
221<p>Use a temporary file name when uploading a a file. When the transfer is complete,            this temporary file is renamed to the final file name. This is useful for ensuring           that remote systems do not read a partially uploaded file.</p>
222<p>Flags: Read / Write</p>
223<p>Default value: FALSE</p>
224</div>
225<hr>
226<div class="refsect2">
227<a name="GstCurlFtpSink--temp-file-name"></a><h3>The <code class="literal">“temp-file-name”</code> property</h3>
228<pre class="programlisting">  “temp-file-name”           <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
229<p>Filename pattern to use when generating a temporary filename for uploads.</p>
230<p>Flags: Read / Write</p>
231<p>Default value: NULL</p>
232</div>
233</div>
234</div>
235<div class="footer">
236<hr>Generated by GTK-Doc V1.28</div>
237</body>
238</html>