docs/plugins/html/gst-plugins-base-plugins-gnomevfssink.html

   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>gnomevfssink</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-base Elements">
   9 <link rel="prev" href="gst-plugins-base-plugins-giostreamsrc.html" title="giostreamsrc">
  10 <link rel="next" href="gst-plugins-base-plugins-gnomevfssrc.html" title="gnomevfssrc">
  11 <meta name="generator" content="GTK-Doc V1.17 (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="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gst-plugins-base-plugins-giostreamsrc.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer Base Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-plugins-gnomevfssrc.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-base-plugins-gnomevfssink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-plugins-gnomevfssink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-plugins-gnomevfssink.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-plugins-gnomevfssink.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-base-plugins-gnomevfssink.properties" class="shortcut">Properties</a>
  33                    |
  34                   <a href="#gst-plugins-base-plugins-gnomevfssink.signals" class="shortcut">Signals</a>
  35 </td></tr>
  36 </table>
  37 <div class="refentry">
  38 <a name="gst-plugins-base-plugins-gnomevfssink"></a><div class="titlepage"></div>
  39 <div class="refnamediv"><table width="100%"><tr>
  40 <td valign="top">
  41 <h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-gnomevfssink.top_of_page"></a>gnomevfssink</span></h2>
  42 <p>gnomevfssink — Write a stream to a GnomeVFS URI</p>
  43 </td>
  44 <td valign="top" align="right"></td>
  45 </tr></table></div>
  46 <div class="refsynopsisdiv">
  47 <a name="gst-plugins-base-plugins-gnomevfssink.synopsis"></a><h2>Synopsis</h2>
  48 <a name="GstGnomeVFSSink"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-gnomevfssink.html#GstGnomeVFSSink-struct" title="struct GstGnomeVFSSink">GstGnomeVFSSink</a>;
  49 </pre>
  50 </div>
  51 <div class="refsect1">
  52 <a name="gst-plugins-base-plugins-gnomevfssink.object-hierarchy"></a><h2>Object Hierarchy</h2>
  53 <pre class="synopsis">
  54   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  55    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  56          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  57                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSink.html">GstBaseSink</a>
  58                      +----GstGnomeVFSSink
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="gst-plugins-base-plugins-gnomevfssink.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  63 <p>
  64 GstGnomeVFSSink implements
  65  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstUriHandler.html#GstURIHandler">GstURIHandler</a>.</p>
  66 </div>
  67 <div class="refsect1">
  68 <a name="gst-plugins-base-plugins-gnomevfssink.properties"></a><h2>Properties</h2>
  69 <pre class="synopsis">
  70   "<a class="link" href="gst-plugins-base-plugins-gnomevfssink.html#GstGnomeVFSSink--handle" title='The "handle" property'>handle</a>"                   <span class="type">GnomeVFSHandle</span>*       : Read / Write
  71   "<a class="link" href="gst-plugins-base-plugins-gnomevfssink.html#GstGnomeVFSSink--location" title='The "location" property'>location</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  72   "<a class="link" href="gst-plugins-base-plugins-gnomevfssink.html#GstGnomeVFSSink--uri" title='The "uri" property'>uri</a>"                      <a href="/usr/share/gtk-doc/html/gnome-vfs-2.0/gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI"><span class="type">GnomeVFSURI</span></a>*          : Read / Write
  73 </pre>
  74 </div>
  75 <div class="refsect1">
  76 <a name="gst-plugins-base-plugins-gnomevfssink.signals"></a><h2>Signals</h2>
  77 <pre class="synopsis">
  78   "<a class="link" href="gst-plugins-base-plugins-gnomevfssink.html#GstGnomeVFSSink-allow-overwrite" title='The "allow-overwrite" signal'>allow-overwrite</a>"                                : Cleanup
  79 </pre>
  80 </div>
  81 <div class="refsect1">
  82 <a name="gst-plugins-base-plugins-gnomevfssink.description"></a><h2>Description</h2>
  83 <p>
  84 This plugin writes incoming data to a local or remote location specified
  85 by an URI. This location can be specified using any protocol supported by
  86 the GnomeVFS library. Common protocols are 'file', 'ftp', or 'smb'.
  87 </p>
  88 <p>
  89 Applications can connect to the <a class="link" href="gst-plugins-base-plugins-gnomevfssink.html#GstGnomeVFSSink-allow-overwrite" title='The "allow-overwrite" signal'><span class="type">"allow-overwrite"</span></a> signal to
  90 receive a callback when an existing file will be overwritten. The return
  91 value of the signal will determine if gnomevfssink will overwrite the
  92 resource or abort with an error.
  93 </p>
  94 <p>
  95 </p>
  96 <div class="refsect2">
  97 <a name="idp11679088"></a><h3>Example launch lines</h3>
  98 <div class="informalexample">
  99   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 100     <tbody>
 101       <tr>
 102         <td class="listing_lines" align="right"><pre>1</pre></td>
 103         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v filesrc location<span class="gtkdoc opt">=</span>input<span class="gtkdoc opt">.</span>xyz <span class="gtkdoc opt">!</span> gnomevfssink location<span class="gtkdoc opt">=</span>file<span class="gtkdoc opt">:</span><span class="gtkdoc slc">///home/joe/out.xyz</span></pre></td>
 104       </tr>
 105     </tbody>
 106   </table>
 107 </div>
 108  The above pipeline will simply copy a local file. Instead of gnomevfssink,
 109 we could just as well have used the filesink element here.
 110 <div class="informalexample">
 111   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 112     <tbody>
 113       <tr>
 114         <td class="listing_lines" align="right"><pre>1</pre></td>
 115         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v filesrc location<span class="gtkdoc opt">=</span>foo<span class="gtkdoc opt">.</span>mp3 <span class="gtkdoc opt">!</span> mad <span class="gtkdoc opt">!</span> flacenc <span class="gtkdoc opt">!</span> gnomevfssink location<span class="gtkdoc opt">=</span>smb<span class="gtkdoc opt">:</span><span class="gtkdoc slc">//othercomputer/foo.flac</span></pre></td>
 116       </tr>
 117     </tbody>
 118   </table>
 119 </div>
 120  The above pipeline will re-encode an mp3 file into FLAC format and store
 121 it on a remote host using the Samba protocol.
 122 </div>
 123 <p>
 124 </p>
 125 <p>
 126 Last reviewed on 2006-02-28 (0.10.4)
 127 </p>
 128 <div class="refsynopsisdiv">
 129 <h2>Synopsis</h2>
 130 <div class="refsect2">
 131 <a name="idp11683472"></a><h3>Element Information</h3>
 132 <div class="variablelist"><table border="0">
 133 <col align="left" valign="top">
 134 <tbody>
 135 <tr>
 136 <td><p><span class="term">plugin</span></p></td>
 137 <td>
 138             <a class="link" href="gst-plugins-base-plugins-plugin-gnomevfs.html#plugin-gnomevfs">gnomevfs</a>
 139           </td>
 140 </tr>
 141 <tr>
 142 <td><p><span class="term">author</span></p></td>
 143 <td>Bastien Nocera &lt;hadess@hadess.net&gt;</td>
 144 </tr>
 145 <tr>
 146 <td><p><span class="term">class</span></p></td>
 147 <td>Sink/File</td>
 148 </tr>
 149 </tbody>
 150 </table></div>
 151 </div>
 152 <hr>
 153 <div class="refsect2">
 154 <a name="idp11690928"></a><h3>Element Pads</h3>
 155 <div class="variablelist"><table border="0">
 156 <col align="left" valign="top">
 157 <tbody>
 158 <tr>
 159 <td><p><span class="term">name</span></p></td>
 160 <td>sink</td>
 161 </tr>
 162 <tr>
 163 <td><p><span class="term">direction</span></p></td>
 164 <td>sink</td>
 165 </tr>
 166 <tr>
 167 <td><p><span class="term">presence</span></p></td>
 168 <td>always</td>
 169 </tr>
 170 <tr>
 171 <td><p><span class="term">details</span></p></td>
 172 <td>ANY</td>
 173 </tr>
 174 </tbody>
 175 </table></div>
 176 </div>
 177 </div>
 178 <p>
 179 </p>
 180 </div>
 181 <div class="refsect1">
 182 <a name="gst-plugins-base-plugins-gnomevfssink.details"></a><h2>Details</h2>
 183 <div class="refsect2">
 184 <a name="GstGnomeVFSSink-struct"></a><h3>struct GstGnomeVFSSink</h3>
 185 <pre class="programlisting">struct GstGnomeVFSSink;</pre>
 186 <p>
 187 Opaque data structure.
 188 </p>
 189 </div>
 190 </div>
 191 <div class="refsect1">
 192 <a name="gst-plugins-base-plugins-gnomevfssink.property-details"></a><h2>Property Details</h2>
 193 <div class="refsect2">
 194 <a name="GstGnomeVFSSink--handle"></a><h3>The <code class="literal">"handle"</code> property</h3>
 195 <pre class="programlisting">  "handle"                   <span class="type">GnomeVFSHandle</span>*       : Read / Write</pre>
 196 <p>Handle for GnomeVFS.</p>
 197 </div>
 198 <hr>
 199 <div class="refsect2">
 200 <a name="GstGnomeVFSSink--location"></a><h3>The <code class="literal">"location"</code> property</h3>
 201 <pre class="programlisting">  "location"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 202 <p>Location of the file to write.</p>
 203 <p>Default value: NULL</p>
 204 </div>
 205 <hr>
 206 <div class="refsect2">
 207 <a name="GstGnomeVFSSink--uri"></a><h3>The <code class="literal">"uri"</code> property</h3>
 208 <pre class="programlisting">  "uri"                      <a href="/usr/share/gtk-doc/html/gnome-vfs-2.0/gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI"><span class="type">GnomeVFSURI</span></a>*          : Read / Write</pre>
 209 <p>URI for GnomeVFS.</p>
 210 </div>
 211 </div>
 212 <div class="refsect1">
 213 <a name="gst-plugins-base-plugins-gnomevfssink.signal-details"></a><h2>Signal Details</h2>
 214 <div class="refsect2">
 215 <a name="GstGnomeVFSSink-allow-overwrite"></a><h3>The <code class="literal">"allow-overwrite"</code> signal</h3>
 216 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="gst-plugins-base-plugins-gnomevfssink.html#GstGnomeVFSSink"><span class="type">GstGnomeVFSSink</span></a> *sink,
 217                                                         <a href="/usr/share/gtk-doc/html/gnome-vfs-2.0/gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI"><span class="type">GnomeVFSURI</span></a>     *uri,
 218                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)      : Cleanup</pre>
 219 <p>
 220 This signal is fired when gnomevfssink is about to overwrite an
 221 existing resource. The application can connect to this signal and ask
 222 the user if the resource may be overwritten.
 223 </p>
 224 <div class="variablelist"><table border="0">
 225 <col align="left" valign="top">
 226 <tbody>
 227 <tr>
 228 <td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
 229 <td>the object which received the signal</td>
 230 </tr>
 231 <tr>
 232 <td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
 233 <td>the URI to be overwritten</td>
 234 </tr>
 235 <tr>
 236 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 237 <td>user data set when the signal handler was connected.</td>
 238 </tr>
 239 <tr>
 240 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 241 <td>A boolean indicating that the resource may be overwritten.</td>
 242 </tr>
 243 </tbody>
 244 </table></div>
 245 </div>
 246 </div>
 247 <div class="refsect1">
 248 <a name="gst-plugins-base-plugins-gnomevfssink.see-also"></a><h2>See Also</h2>
 249 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-plugins/html/gstreamer-plugins-filesink.html#GstFileSink"><span class="type">GstFileSink</span></a>, <a class="link" href="gst-plugins-base-plugins-gnomevfssrc.html#GstGnomeVFSSrc"><span class="type">GstGnomeVFSSrc</span></a>
 250 </div>
 251 </div>
 252 <div class="footer">
 253 <hr>
 254           Generated by GTK-Doc V1.17</div>
 255 </body>
 256 </html>