docs/plugins/html/gst-plugins-good-plugins-multifilesrc.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>multifilesrc</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   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-multifilesink.html" title="multifilesink">
  10 <link rel="next" href="gst-plugins-good-plugins-multipartdemux.html" title="multipartdemux">
  11 <meta name="generator" content="GTK-Doc V1.18 (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-multifilesink.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-multipartdemux.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-multifilesrc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-multifilesrc.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-multifilesrc.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-multifilesrc.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-multifilesrc"></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-multifilesrc.top_of_page"></a>multifilesrc</span></h2>
  38 <p>multifilesrc — Read a sequentially named set of files into buffers</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-multifilesrc.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstMultiFileSrc"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-multifilesrc.html#GstMultiFileSrc-struct" title="struct GstMultiFileSrc">GstMultiFileSrc</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-multifilesrc.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/GstBaseSrc.html">GstBaseSrc</a>
  54                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstPushSrc.html">GstPushSrc</a>
  55                            +----GstMultiFileSrc
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="gst-plugins-good-plugins-multifilesrc.properties"></a><h2>Properties</h2>
  60 <pre class="synopsis">
  61   "<a class="link" href="gst-plugins-good-plugins-multifilesrc.html#GstMultiFileSrc--caps" title='The "caps" property'>caps</a>"                     <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>*              : Read / Write
  62   "<a class="link" href="gst-plugins-good-plugins-multifilesrc.html#GstMultiFileSrc--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
  63   "<a class="link" href="gst-plugins-good-plugins-multifilesrc.html#GstMultiFileSrc--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
  64   "<a class="link" href="gst-plugins-good-plugins-multifilesrc.html#GstMultiFileSrc--loop" title='The "loop" property'>loop</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  65   "<a class="link" href="gst-plugins-good-plugins-multifilesrc.html#GstMultiFileSrc--start-index" title='The "start-index" property'>start-index</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  66   "<a class="link" href="gst-plugins-good-plugins-multifilesrc.html#GstMultiFileSrc--stop-index" title='The "stop-index" property'>stop-index</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  67 </pre>
  68 </div>
  69 <div class="refsect1">
  70 <a name="gst-plugins-good-plugins-multifilesrc.description"></a><h2>Description</h2>
  71 <p>
  72 Reads buffers from sequentially named files. If used together with an image
  73 decoder, one needs to use the <a class="link" href="gst-plugins-good-plugins-multifilesrc.html#GstMultiFileSrc--caps" title='The "caps" property'><span class="type">"caps"</span></a> property or a capsfilter
  74 to force to caps containing a framerate. Otherwise image decoders send EOS
  75 after the first picture.
  76 </p>
  77 <p>
  78 File names are created by replacing "%d" with the index using <code class="function">printf()</code>.
  79 </p>
  80 <p>
  81 </p>
  82 <div class="refsect2">
  83 <a name="idp5559360"></a><h3>Example launch line</h3>
  84 <div class="informalexample">
  85   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  86     <tbody>
  87       <tr>
  88         <td class="listing_lines" align="right"><pre>1
  89 2
  90 3</pre></td>
  91         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch multifilesrc location<span class="gtkdoc opt">=</span><span class="string">&quot;img.%04d.png&quot;</span> index<span class="gtkdoc opt">=</span><span class="number">0</span> caps<span class="gtkdoc opt">=</span><span class="string">&quot;image/png,framerate=\(fraction\)12/1&quot;</span> <span class="gtkdoc opt">!</span> \
  92     pngdec <span class="gtkdoc opt">!</span> ffmpegcolorspace <span class="gtkdoc opt">!</span> theoraenc <span class="gtkdoc opt">!</span> oggmux <span class="gtkdoc opt">!</span> \
  93     filesink location<span class="gtkdoc opt">=</span><span class="string">&quot;images.ogg&quot;</span></pre></td>
  94       </tr>
  95     </tbody>
  96   </table>
  97 </div>
  98  This pipeline creates a video file "images.ogg" by joining multiple PNG
  99 files named img.0000.png, img.0001.png, etc.
 100 </div>
 101 <p>
 102 </p>
 103 <div class="refsynopsisdiv">
 104 <h2>Synopsis</h2>
 105 <div class="refsect2">
 106 <a name="idp14725200"></a><h3>Element Information</h3>
 107 <div class="variablelist"><table border="0">
 108 <col align="left" valign="top">
 109 <tbody>
 110 <tr>
 111 <td><p><span class="term">plugin</span></p></td>
 112 <td>
 113             <a class="link" href="gst-plugins-good-plugins-plugin-multifile.html#plugin-multifile">multifile</a>
 114           </td>
 115 </tr>
 116 <tr>
 117 <td><p><span class="term">author</span></p></td>
 118 <td>David Schleef &lt;ds@schleef.org&gt;</td>
 119 </tr>
 120 <tr>
 121 <td><p><span class="term">class</span></p></td>
 122 <td>Source/File</td>
 123 </tr>
 124 </tbody>
 125 </table></div>
 126 </div>
 127 <hr>
 128 <div class="refsect2">
 129 <a name="idp17143520"></a><h3>Element Pads</h3>
 130 <div class="variablelist"><table border="0">
 131 <col align="left" valign="top">
 132 <tbody>
 133 <tr>
 134 <td><p><span class="term">name</span></p></td>
 135 <td>src</td>
 136 </tr>
 137 <tr>
 138 <td><p><span class="term">direction</span></p></td>
 139 <td>source</td>
 140 </tr>
 141 <tr>
 142 <td><p><span class="term">presence</span></p></td>
 143 <td>always</td>
 144 </tr>
 145 <tr>
 146 <td><p><span class="term">details</span></p></td>
 147 <td>ANY</td>
 148 </tr>
 149 </tbody>
 150 </table></div>
 151 </div>
 152 </div>
 153 <p>
 154 </p>
 155 </div>
 156 <div class="refsect1">
 157 <a name="gst-plugins-good-plugins-multifilesrc.details"></a><h2>Details</h2>
 158 <div class="refsect2">
 159 <a name="GstMultiFileSrc-struct"></a><h3>struct GstMultiFileSrc</h3>
 160 <pre class="programlisting">struct GstMultiFileSrc;</pre>
 161 <p>
 162 </p>
 163 </div>
 164 </div>
 165 <div class="refsect1">
 166 <a name="gst-plugins-good-plugins-multifilesrc.property-details"></a><h2>Property Details</h2>
 167 <div class="refsect2">
 168 <a name="GstMultiFileSrc--caps"></a><h3>The <code class="literal">"caps"</code> property</h3>
 169 <pre class="programlisting">  "caps"                     <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>*              : Read / Write</pre>
 170 <p>Caps describing the format of the data.</p>
 171 </div>
 172 <hr>
 173 <div class="refsect2">
 174 <a name="GstMultiFileSrc--index"></a><h3>The <code class="literal">"index"</code> property</h3>
 175 <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>
 176 <p>Index to use with location property to create file names.  The index is incremented by one for each buffer read.</p>
 177 <p>Allowed values: &gt;= 0</p>
 178 <p>Default value: 0</p>
 179 </div>
 180 <hr>
 181 <div class="refsect2">
 182 <a name="GstMultiFileSrc--location"></a><h3>The <code class="literal">"location"</code> property</h3>
 183 <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>
 184 <p>Pattern to create file names of input files.  File names are created by calling sprintf() with the pattern and the current index.</p>
 185 <p>Default value: "%05d"</p>
 186 </div>
 187 <hr>
 188 <div class="refsect2">
 189 <a name="GstMultiFileSrc--loop"></a><h3>The <code class="literal">"loop"</code> property</h3>
 190 <pre class="programlisting">  "loop"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 191 <p>Whether to repeat from the beginning when all files have been read.</p>
 192 <p>Default value: FALSE</p>
 193 </div>
 194 <hr>
 195 <div class="refsect2">
 196 <a name="GstMultiFileSrc--start-index"></a><h3>The <code class="literal">"start-index"</code> property</h3>
 197 <pre class="programlisting">  "start-index"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 198 <p>Start value of index.  The initial value of index can be set either by setting index or start-index.  When the end of the loop is reached, the index will be set to the value start-index.</p>
 199 <p>Allowed values: &gt;= 0</p>
 200 <p>Default value: 0</p>
 201 </div>
 202 <hr>
 203 <div class="refsect2">
 204 <a name="GstMultiFileSrc--stop-index"></a><h3>The <code class="literal">"stop-index"</code> property</h3>
 205 <pre class="programlisting">  "stop-index"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 206 <p>Stop value of index.  The special value -1 means no stop.</p>
 207 <p>Allowed values: &gt;= G_MAXULONG</p>
 208 <p>Default value: 0</p>
 209 </div>
 210 </div>
 211 <div class="refsect1">
 212 <a name="gst-plugins-good-plugins-multifilesrc.see-also"></a><h2>See Also</h2>
 213 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-plugins/html/gstreamer-plugins-filesrc.html#GstFileSrc"><span class="type">GstFileSrc</span></a>
 214 </div>
 215 </div>
 216 <div class="footer">
 217 <hr>
 218           Generated by GTK-Doc V1.18</div>
 219 </body>
 220 </html>