docs/plugins/html/gst-plugins-good-plugins-multifilesink.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>multifilesink</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-good Elements">
   9 <link rel="prev" href="gst-plugins-good-plugins-mulawenc.html" title="mulawenc">
  10 <link rel="next" href="gst-plugins-good-plugins-multifilesrc.html" title="multifilesrc">
  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-good-plugins-mulawenc.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 Good Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-good-plugins-multifilesrc.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-good-plugins-multifilesink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-multifilesink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-multifilesink.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-multifilesink.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-multifilesink"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-multifilesink.top_of_page"></a>multifilesink</span></h2>
  38 <p>multifilesink — Write buffers to a sequentially named set of files</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="gst-plugins-good-plugins-multifilesink.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstMultiFileSink"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-multifilesink.html#GstMultiFileSink-struct" title="struct GstMultiFileSink">GstMultiFileSink</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-multifilesink.object-hierarchy"></a><h2>Object Hierarchy</h2>
  49 <pre class="synopsis">
  50   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  51    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  52          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  53                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSink.html">GstBaseSink</a>
  54                      +----GstMultiFileSink
  55 </pre>
  56 </div>
  57 <div class="refsect1">
  58 <a name="gst-plugins-good-plugins-multifilesink.properties"></a><h2>Properties</h2>
  59 <pre class="synopsis">
  60   "<a class="link" href="gst-plugins-good-plugins-multifilesink.html#GstMultiFileSink--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
  61   "<a class="link" href="gst-plugins-good-plugins-multifilesink.html#GstMultiFileSink--index" title='The "index" property'>index</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  62   "<a class="link" href="gst-plugins-good-plugins-multifilesink.html#GstMultiFileSink--next-file" title='The "next-file" property'>next-file</a>"                <span class="type">GstMultiFileSinkNext</span>  : Read / Write
  63   "<a class="link" href="gst-plugins-good-plugins-multifilesink.html#GstMultiFileSink--post-messages" title='The "post-messages" property'>post-messages</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  64 </pre>
  65 </div>
  66 <div class="refsect1">
  67 <a name="gst-plugins-good-plugins-multifilesink.description"></a><h2>Description</h2>
  68 <p>
  69 Write incoming data to a series of sequentially-named files.
  70 </p>
  71 <p>
  72 The filename property should contain a string with a %d placeholder that will
  73 be substituted with the index for each filename.
  74 </p>
  75 <p>
  76 If the <a class="link" href="gst-plugins-good-plugins-multifilesink.html#GstMultiFileSink--post-messages" title='The "post-messages" property'><span class="type">"post-messages"</span></a> property is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a>, it sends an application
  77 message named
  78 <code class="classname">"GstMultiFileSink"</code> after writing each
  79 buffer.
  80 </p>
  81 <p>
  82 The message's structure contains these fields:
  83 </p>
  84 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
  85 <li class="listitem"><p>
  86   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *
  87   <code class="classname">"filename"</code>:
  88   the filename where the buffer was written.
  89   </p></li>
  90 <li class="listitem"><p>
  91   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>
  92   <code class="classname">"index"</code>:
  93   the index of the buffer.
  94   </p></li>
  95 <li class="listitem"><p>
  96   <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a>
  97   <code class="classname">"timestamp"</code>:
  98   the timestamp of the buffer.
  99   </p></li>
 100 <li class="listitem"><p>
 101   <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a>
 102   <code class="classname">"stream-time"</code>:
 103   the stream time of the buffer.
 104   </p></li>
 105 <li class="listitem"><p>
 106   <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a>
 107   <code class="classname">"running-time"</code>:
 108   the running_time of the buffer.
 109   </p></li>
 110 <li class="listitem"><p>
 111   <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a>
 112   <code class="classname">"duration"</code>:
 113   the duration of the buffer.
 114   </p></li>
 115 <li class="listitem"><p>
 116   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>
 117   <code class="classname">"offset"</code>:
 118   the offset of the buffer that triggered the message.
 119   </p></li>
 120 <li class="listitem"><p>
 121   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>
 122   <code class="classname">"offset-end"</code>:
 123   the offset-end of the buffer that triggered the message.
 124   </p></li>
 125 </ul></div>
 126 <p>
 127 </p>
 128 <p>
 129 </p>
 130 <div class="refsect2">
 131 <a name="idp15049792"></a><h3>Example launch line</h3>
 132 <div class="informalexample">
 133   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 134     <tbody>
 135       <tr>
 136         <td class="listing_lines" align="right"><pre>1
 137 2</pre></td>
 138         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch audiotestsrc <span class="gtkdoc opt">!</span> multifilesink
 139 gst<span class="gtkdoc opt">-</span>launch videotestsrc <span class="gtkdoc opt">!</span> multifilesink post<span class="gtkdoc opt">-</span>messages<span class="gtkdoc opt">=</span><span class="keyword">true</span> filename<span class="gtkdoc opt">=</span><span class="string">&quot;frame%d&quot;</span></pre></td>
 140       </tr>
 141     </tbody>
 142   </table>
 143 </div>
 144
 145 </div>
 146 <p>
 147 </p>
 148 <p>
 149 Last reviewed on 2009-09-11 (0.10.17)
 150 </p>
 151 <div class="refsynopsisdiv">
 152 <h2>Synopsis</h2>
 153 <div class="refsect2">
 154 <a name="idp18698080"></a><h3>Element Information</h3>
 155 <div class="variablelist"><table border="0">
 156 <col align="left" valign="top">
 157 <tbody>
 158 <tr>
 159 <td><p><span class="term">plugin</span></p></td>
 160 <td>
 161             <a class="link" href="gst-plugins-good-plugins-plugin-multifile.html#plugin-multifile">multifile</a>
 162           </td>
 163 </tr>
 164 <tr>
 165 <td><p><span class="term">author</span></p></td>
 166 <td>David Schleef &lt;ds@schleef.org&gt;</td>
 167 </tr>
 168 <tr>
 169 <td><p><span class="term">class</span></p></td>
 170 <td>Sink/File</td>
 171 </tr>
 172 </tbody>
 173 </table></div>
 174 </div>
 175 <hr>
 176 <div class="refsect2">
 177 <a name="idp17348304"></a><h3>Element Pads</h3>
 178 <div class="variablelist"><table border="0">
 179 <col align="left" valign="top">
 180 <tbody>
 181 <tr>
 182 <td><p><span class="term">name</span></p></td>
 183 <td>sink</td>
 184 </tr>
 185 <tr>
 186 <td><p><span class="term">direction</span></p></td>
 187 <td>sink</td>
 188 </tr>
 189 <tr>
 190 <td><p><span class="term">presence</span></p></td>
 191 <td>always</td>
 192 </tr>
 193 <tr>
 194 <td><p><span class="term">details</span></p></td>
 195 <td>ANY</td>
 196 </tr>
 197 </tbody>
 198 </table></div>
 199 </div>
 200 </div>
 201 <p>
 202 </p>
 203 </div>
 204 <div class="refsect1">
 205 <a name="gst-plugins-good-plugins-multifilesink.details"></a><h2>Details</h2>
 206 <div class="refsect2">
 207 <a name="GstMultiFileSink-struct"></a><h3>struct GstMultiFileSink</h3>
 208 <pre class="programlisting">struct GstMultiFileSink;</pre>
 209 <p>
 210 </p>
 211 </div>
 212 </div>
 213 <div class="refsect1">
 214 <a name="gst-plugins-good-plugins-multifilesink.property-details"></a><h2>Property Details</h2>
 215 <div class="refsect2">
 216 <a name="GstMultiFileSink--location"></a><h3>The <code class="literal">"location"</code> property</h3>
 217 <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>
 218 <p>Location of the file to write.</p>
 219 <p>Default value: NULL</p>
 220 </div>
 221 <hr>
 222 <div class="refsect2">
 223 <a name="GstMultiFileSink--index"></a><h3>The <code class="literal">"index"</code> property</h3>
 224 <pre class="programlisting">  "index"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 225 <p>Index to use with location property to create file names.  The index is incremented by one for each buffer written.</p>
 226 <p>Allowed values: &gt;= 0</p>
 227 <p>Default value: 0</p>
 228 </div>
 229 <hr>
 230 <div class="refsect2">
 231 <a name="GstMultiFileSink--next-file"></a><h3>The <code class="literal">"next-file"</code> property</h3>
 232 <pre class="programlisting">  "next-file"                <span class="type">GstMultiFileSinkNext</span>  : Read / Write</pre>
 233 <p>
 234 When to start a new file.
 235 </p>
 236 <p>Default value: New file for each buffer</p>
 237 <p class="since">Since 0.10.17</p>
 238 </div>
 239 <hr>
 240 <div class="refsect2">
 241 <a name="GstMultiFileSink--post-messages"></a><h3>The <code class="literal">"post-messages"</code> property</h3>
 242 <pre class="programlisting">  "post-messages"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 243 <p>
 244 Post a message on the GstBus for each file.
 245 </p>
 246 <p>Default value: FALSE</p>
 247 <p class="since">Since 0.10.17</p>
 248 </div>
 249 </div>
 250 <div class="refsect1">
 251 <a name="gst-plugins-good-plugins-multifilesink.see-also"></a><h2>See Also</h2>
 252 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-plugins/html/gstreamer-plugins-filesrc.html#GstFileSrc"><span class="type">GstFileSrc</span></a>
 253 </div>
 254 </div>
 255 <div class="footer">
 256 <hr>
 257           Generated by GTK-Doc V1.17</div>
 258 </body>
 259 </html>