blob: 35148154712e7d8eaa59f3fbe9d6ec93e889bb97 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>multifilesrc</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GStreamer Good Plugins 1.0 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-good Elements">
<link rel="prev" href="gst-plugins-good-plugins-multifilesink.html" title="multifilesink">
<link rel="next" href="gst-plugins-good-plugins-multipartdemux.html" title="multipartdemux">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<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>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GStreamer Good Plugins 1.0 Plugins Reference Manual</th>
<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>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gst-plugins-good-plugins-multifilesrc.synopsis" class="shortcut">Top</a>
 | 
<a href="#gst-plugins-good-plugins-multifilesrc.description" class="shortcut">Description</a>
 | 
<a href="#gst-plugins-good-plugins-multifilesrc.object-hierarchy" class="shortcut">Object Hierarchy</a>
 | 
<a href="#gst-plugins-good-plugins-multifilesrc.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="gst-plugins-good-plugins-multifilesrc"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-multifilesrc.top_of_page"></a>multifilesrc</span></h2>
<p>multifilesrc — Read a sequentially named set of files into buffers</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gst-plugins-good-plugins-multifilesrc.synopsis"></a><h2>Synopsis</h2>
<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>;
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-multifilesrc.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSrc.html">GstBaseSrc</a>
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstPushSrc.html">GstPushSrc</a>
+----GstMultiFileSrc
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-multifilesrc.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<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
"<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
"<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
"<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
"<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
"<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
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-multifilesrc.description"></a><h2>Description</h2>
<p>
Reads buffers from sequentially named files. If used together with an image
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
to force to caps containing a framerate. Otherwise image decoders send EOS
after the first picture. We also need a videorate element to set timestamps
on all buffers after the first one in accordance with the framerate.
</p>
<p>
File names are created by replacing "%d" with the index using <code class="function">printf()</code>.
</p>
<p>
</p>
<div class="refsect2">
<a name="idp14352896"></a><h3>Example launch line</h3>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3</pre></td>
<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> 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> \
pngdec <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> videorate <span class="gtkdoc opt">!</span> theoraenc <span class="gtkdoc opt">!</span> oggmux <span class="gtkdoc opt">!</span> \
filesink location<span class="gtkdoc opt">=</span><span class="string">&quot;images.ogg&quot;</span></pre></td>
</tr>
</tbody>
</table>
</div>
This pipeline creates a video file "images.ogg" by joining multiple PNG
files named img.0000.png, img.0001.png, etc.
</div>
<p>
</p>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="refsect2">
<a name="idp6350400"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">plugin</span></p></td>
<td>
<a class="link" href="gst-plugins-good-plugins-plugin-multifile.html#plugin-multifile">multifile</a>
</td>
</tr>
<tr>
<td><p><span class="term">author</span></p></td>
<td>David Schleef &lt;ds@schleef.org&gt;</td>
</tr>
<tr>
<td><p><span class="term">class</span></p></td>
<td>Source/File</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="idp10932960"></a><h3>Element Pads</h3>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>src</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>source</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>ANY</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-multifilesrc.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GstMultiFileSrc-struct"></a><h3>struct GstMultiFileSrc</h3>
<pre class="programlisting">struct GstMultiFileSrc;</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-multifilesrc.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstMultiFileSrc--caps"></a><h3>The <code class="literal">"caps"</code> property</h3>
<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>
<p>Caps describing the format of the data.</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMultiFileSrc--index"></a><h3>The <code class="literal">"index"</code> property</h3>
<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>
<p>Index to use with location property to create file names. The index is incremented by one for each buffer read.</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMultiFileSrc--location"></a><h3>The <code class="literal">"location"</code> property</h3>
<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>
<p>Pattern to create file names of input files. File names are created by calling sprintf() with the pattern and the current index.</p>
<p>Default value: "%05d"</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMultiFileSrc--loop"></a><h3>The <code class="literal">"loop"</code> property</h3>
<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>
<p>Whether to repeat from the beginning when all files have been read.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMultiFileSrc--start-index"></a><h3>The <code class="literal">"start-index"</code> property</h3>
<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>
<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>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMultiFileSrc--stop-index"></a><h3>The <code class="literal">"stop-index"</code> property</h3>
<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>
<p>Stop value of index. The special value -1 means no stop.</p>
<p>Allowed values: &gt;= G_MAXULONG</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-multifilesrc.see-also"></a><h2>See Also</h2>
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-plugins/html/gstreamer-plugins-filesrc.html#GstFileSrc"><span class="type">GstFileSrc</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>