/usr/share/gtk-doc/html/gst-plugins-good-plugins-0.10/gst-plugins-good-plugins-multifilesink.html is in gstreamer0.10-plugins-good-doc 0.10.31-1ubuntu1.5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>multifilesink</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-good Elements">
<link rel="prev" href="gst-plugins-good-plugins-mulawenc.html" title="mulawenc">
<link rel="next" href="gst-plugins-good-plugins-multifilesrc.html" title="multifilesrc">
<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-mulawenc.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 0.10 Plugins Reference Manual</th>
<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>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gst-plugins-good-plugins-multifilesink.synopsis" class="shortcut">Top</a>
|
<a href="#gst-plugins-good-plugins-multifilesink.description" class="shortcut">Description</a>
|
<a href="#gst-plugins-good-plugins-multifilesink.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#gst-plugins-good-plugins-multifilesink.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="gst-plugins-good-plugins-multifilesink"></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-multifilesink.top_of_page"></a>multifilesink</span></h2>
<p>multifilesink — Write buffers to a sequentially named set of files</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gst-plugins-good-plugins-multifilesink.synopsis"></a><h2>Synopsis</h2>
<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>;
enum <a class="link" href="gst-plugins-good-plugins-multifilesink.html#GstMultiFileSinkNext" title="enum GstMultiFileSinkNext">GstMultiFileSinkNext</a>;
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-multifilesink.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstObject.html">GstObject</a>
+----<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstElement.html">GstElement</a>
+----<a href="/usr/share/gtk-doc/html/gstreamer-libs-0.10/GstBaseSink.html">GstBaseSink</a>
+----GstMultiFileSink
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-multifilesink.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="gst-plugins-good-plugins-multifilesink.html#GstMultiFileSink--location" title='The "location" property'>location</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a class="link" href="gst-plugins-good-plugins-multifilesink.html#GstMultiFileSink--index" title='The "index" property'>index</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
"<a class="link" href="gst-plugins-good-plugins-multifilesink.html#GstMultiFileSink--next-file" title='The "next-file" property'>next-file</a>" <a class="link" href="gst-plugins-good-plugins-multifilesink.html#GstMultiFileSinkNext" title="enum GstMultiFileSinkNext"><span class="type">GstMultiFileSinkNext</span></a> : Read / Write
"<a class="link" href="gst-plugins-good-plugins-multifilesink.html#GstMultiFileSink--post-messages" title='The "post-messages" property'>post-messages</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
"<a class="link" href="gst-plugins-good-plugins-multifilesink.html#GstMultiFileSink--max-files" title='The "max-files" property'>max-files</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
"<a class="link" href="gst-plugins-good-plugins-multifilesink.html#GstMultiFileSink--max-file-size" title='The "max-file-size" property'>max-file-size</a>" <span class="type">guint64</span> : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-multifilesink.description"></a><h2>Description</h2>
<p>
Write incoming data to a series of sequentially-named files.
</p>
<p>
The filename property should contain a string with a %d placeholder that will
be substituted with the index for each filename.
</p>
<p>
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="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a>, it sends an application
message named
<code class="classname">"GstMultiFileSink"</code> after writing each
buffer.
</p>
<p>
The message's structure contains these fields:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem"><p>
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *
<code class="classname">"filename"</code>:
the filename where the buffer was written.
</p></li>
<li class="listitem"><p>
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>
<code class="classname">"index"</code>:
the index of the buffer.
</p></li>
<li class="listitem"><p>
<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a>
<code class="classname">"timestamp"</code>:
the timestamp of the buffer.
</p></li>
<li class="listitem"><p>
<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a>
<code class="classname">"stream-time"</code>:
the stream time of the buffer.
</p></li>
<li class="listitem"><p>
<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a>
<code class="classname">"running-time"</code>:
the running_time of the buffer.
</p></li>
<li class="listitem"><p>
<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a>
<code class="classname">"duration"</code>:
the duration of the buffer.
</p></li>
<li class="listitem"><p>
<span class="type">guint64</span>
<code class="classname">"offset"</code>:
the offset of the buffer that triggered the message.
</p></li>
<li class="listitem"><p>
<span class="type">guint64</span>
<code class="classname">"offset-end"</code>:
the offset-end of the buffer that triggered the message.
</p></li>
</ul></div>
<p>
</p>
<p>
</p>
<div class="refsect2">
<a name="idp8423000"></a><h3>Example launch line</h3>
<div class="informalexample"><pre class="programlisting">
gst-launch audiotestsrc ! multifilesink
gst-launch videotestsrc ! multifilesink post-messages=true filename="frame%d"
</pre></div>
</div>
<p>
</p>
<p>
Last reviewed on 2009-09-11 (0.10.17)
</p>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="refsect2">
<a name="idp10214704"></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 <ds@schleef.org></td>
</tr>
<tr>
<td><p><span class="term">class</span></p></td>
<td>Sink/File</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="idp10039808"></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>sink</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>sink</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-multifilesink.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GstMultiFileSink-struct"></a><h3>struct GstMultiFileSink</h3>
<pre class="programlisting">struct GstMultiFileSink;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMultiFileSinkNext"></a><h3>enum GstMultiFileSinkNext</h3>
<pre class="programlisting">typedef enum {
GST_MULTI_FILE_SINK_NEXT_BUFFER,
GST_MULTI_FILE_SINK_NEXT_DISCONT,
GST_MULTI_FILE_SINK_NEXT_KEY_FRAME,
GST_MULTI_FILE_SINK_NEXT_KEY_UNIT_EVENT,
GST_MULTI_FILE_SINK_NEXT_MAX_SIZE
} GstMultiFileSinkNext;
</pre>
<p>
File splitting modes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GST-MULTI-FILE-SINK-NEXT-BUFFER:CAPS"></a><span class="term"><code class="literal">GST_MULTI_FILE_SINK_NEXT_BUFFER</code></span></p></td>
<td>New file for each buffer
</td>
</tr>
<tr>
<td><p><a name="GST-MULTI-FILE-SINK-NEXT-DISCONT:CAPS"></a><span class="term"><code class="literal">GST_MULTI_FILE_SINK_NEXT_DISCONT</code></span></p></td>
<td>New file after each discontinuity
</td>
</tr>
<tr>
<td><p><a name="GST-MULTI-FILE-SINK-NEXT-KEY-FRAME:CAPS"></a><span class="term"><code class="literal">GST_MULTI_FILE_SINK_NEXT_KEY_FRAME</code></span></p></td>
<td>New file at each key frame
(Useful for MPEG-TS segmenting)
</td>
</tr>
<tr>
<td><p><a name="GST-MULTI-FILE-SINK-NEXT-KEY-UNIT-EVENT:CAPS"></a><span class="term"><code class="literal">GST_MULTI_FILE_SINK_NEXT_KEY_UNIT_EVENT</code></span></p></td>
<td>New file after a force key unit
event (Since: 0.10.31)
</td>
</tr>
<tr>
<td><p><a name="GST-MULTI-FILE-SINK-NEXT-MAX-SIZE:CAPS"></a><span class="term"><code class="literal">GST_MULTI_FILE_SINK_NEXT_MAX_SIZE</code></span></p></td>
<td>New file when the configured maximum file
size would be exceeded with the next buffer or buffer list (Since: 0.10.31)
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-multifilesink.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstMultiFileSink--location"></a><h3>The <code class="literal">"location"</code> property</h3>
<pre class="programlisting"> "location" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>Location of the file to write.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMultiFileSink--index"></a><h3>The <code class="literal">"index"</code> property</h3>
<pre class="programlisting"> "index" <a href="/usr/share/gtk-doc/html/glib/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 written.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMultiFileSink--next-file"></a><h3>The <code class="literal">"next-file"</code> property</h3>
<pre class="programlisting"> "next-file" <a class="link" href="gst-plugins-good-plugins-multifilesink.html#GstMultiFileSinkNext" title="enum GstMultiFileSinkNext"><span class="type">GstMultiFileSinkNext</span></a> : Read / Write</pre>
<p>
When to start a new file.
</p>
<p>Default value: New file for each buffer</p>
<p class="since">Since 0.10.17</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMultiFileSink--post-messages"></a><h3>The <code class="literal">"post-messages"</code> property</h3>
<pre class="programlisting"> "post-messages" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p>
Post a message on the GstBus for each file.
</p>
<p>Default value: FALSE</p>
<p class="since">Since 0.10.17</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMultiFileSink--max-files"></a><h3>The <code class="literal">"max-files"</code> property</h3>
<pre class="programlisting"> "max-files" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
<p>
Maximum number of files to keep on disk. Once the maximum is reached, old
files start to be deleted to make room for new ones.
</p>
<p>Default value: 0</p>
<p class="since">Since 0.10.31</p>
</div>
<hr>
<div class="refsect2">
<a name="GstMultiFileSink--max-file-size"></a><h3>The <code class="literal">"max-file-size"</code> property</h3>
<pre class="programlisting"> "max-file-size" <span class="type">guint64</span> : Read / Write</pre>
<p>
Maximum file size before starting a new file in max-size mode.
</p>
<p>Default value: 2147483648</p>
<p class="since">Since 0.10.31</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-multifilesink.see-also"></a><h2>See Also</h2>
<a href="/usr/share/gtk-doc/html/gstreamer-plugins-0.10/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>
|