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>filesink: GStreamer Core Plugins 1.0 Plugins Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Core Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gstreamer Elements"> 9<link rel="prev" href="gstreamer-plugins-fdsrc.html" title="fdsrc"> 10<link rel="next" href="gstreamer-plugins-filesrc.html" title="filesrc"> 11<meta name="generator" content="GTK-Doc V1.28 (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="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#gstreamer-plugins-filesink.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gstreamer-plugins-filesink.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 20 <a href="#gstreamer-plugins-filesink.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 21 <a href="#gstreamer-plugins-filesink.properties" class="shortcut">Properties</a></span> 22</td> 23<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 24<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 25<td><a accesskey="p" href="gstreamer-plugins-fdsrc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 26<td><a accesskey="n" href="gstreamer-plugins-filesrc.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 27</tr></table> 28<div class="refentry"> 29<a name="gstreamer-plugins-filesink"></a><div class="titlepage"></div> 30<div class="refnamediv"><table width="100%"><tr> 31<td valign="top"> 32<h2><span class="refentrytitle"><a name="gstreamer-plugins-filesink.top_of_page"></a>filesink</span></h2> 33<p>filesink</p> 34</td> 35<td class="gallery_image" valign="top" align="right"></td> 36</tr></table></div> 37<div class="refsect1"> 38<a name="gstreamer-plugins-filesink.properties"></a><h2>Properties</h2> 39<div class="informaltable"><table class="informaltable" border="0"> 40<colgroup> 41<col width="150px" class="properties_type"> 42<col width="300px" class="properties_name"> 43<col width="200px" class="properties_flags"> 44</colgroup> 45<tbody> 46<tr> 47<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 48<td class="property_name"><a class="link" href="gstreamer-plugins-filesink.html#GstFileSink--append" title="The “append” property">append</a></td> 49<td class="property_flags">Read / Write</td> 50</tr> 51<tr> 52<td class="property_type"><a class="link" href="gstreamer-plugins-filesink.html#GstFileSinkBufferMode" title="enum GstFileSinkBufferMode"><span class="type">GstFileSinkBufferMode</span></a></td> 53<td class="property_name"><a class="link" href="gstreamer-plugins-filesink.html#GstFileSink--buffer-mode" title="The “buffer-mode” property">buffer-mode</a></td> 54<td class="property_flags">Read / Write</td> 55</tr> 56<tr> 57<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 58<td class="property_name"><a class="link" href="gstreamer-plugins-filesink.html#GstFileSink--buffer-size" title="The “buffer-size” property">buffer-size</a></td> 59<td class="property_flags">Read / Write</td> 60</tr> 61<tr> 62<td class="property_type"> 63<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 64<td class="property_name"><a class="link" href="gstreamer-plugins-filesink.html#GstFileSink--location" title="The “location” property">location</a></td> 65<td class="property_flags">Read / Write</td> 66</tr> 67</tbody> 68</table></div> 69</div> 70<a name="GstFileSink"></a><div class="refsect1"> 71<a name="gstreamer-plugins-filesink.other"></a><h2>Types and Values</h2> 72<div class="informaltable"><table class="informaltable" width="100%" border="0"> 73<colgroup> 74<col width="150px" class="name"> 75<col class="description"> 76</colgroup> 77<tbody> 78<tr> 79<td class="datatype_keyword">struct</td> 80<td class="function_name"><a class="link" href="gstreamer-plugins-filesink.html#GstFileSink-struct" title="struct GstFileSink">GstFileSink</a></td> 81</tr> 82<tr> 83<td class="datatype_keyword">enum</td> 84<td class="function_name"><a class="link" href="gstreamer-plugins-filesink.html#GstFileSinkBufferMode" title="enum GstFileSinkBufferMode">GstFileSinkBufferMode</a></td> 85</tr> 86</tbody> 87</table></div> 88</div> 89<div class="refsect1"> 90<a name="gstreamer-plugins-filesink.object-hierarchy"></a><h2>Object Hierarchy</h2> 91<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 92 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 93 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 94 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 95 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseSink.html#GstBaseSink-struct">GstBaseSink</a> 96 <span class="lineart">╰──</span> GstFileSink 97</pre> 98</div> 99<div class="refsect1"> 100<a name="gstreamer-plugins-filesink.implemented-interfaces"></a><h2>Implemented Interfaces</h2> 101<p> 102GstFileSink implements 103 <a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstUriHandler.html#GstURIHandler-struct">GstURIHandler</a>.</p> 104</div> 105<div class="refsect1"> 106<a name="gstreamer-plugins-filesink.description"></a><h2>Description</h2> 107<p>Write incoming data to a file in the local file system.</p> 108<div class="refsect3"> 109<a name="id-1.2.10.8.3"></a><h4>Example launch line</h4> 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><span class="number">1.0</span> v4l2src num<span class="gtkdoc opt">-</span>buffers<span class="gtkdoc opt">=</span><span class="number">1</span> <span class="gtkdoc opt">!</span> jpegenc <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>capture1<span class="gtkdoc opt">.</span>jpeg</pre></td> 116 </tr> 117 </tbody> 118 </table> 119</div> 120 121<p> Capture one frame from a v4l2 camera and save as jpeg image.</p> 122</div> 123<div class="refsynopsisdiv"> 124<h2>Synopsis</h2> 125<div class="refsect2"> 126<a name="id-1.2.10.8.4.1"></a><h3>Element Information</h3> 127<div class="variablelist"><table border="0" class="variablelist"> 128<colgroup> 129<col align="left" valign="top"> 130<col> 131</colgroup> 132<tbody> 133<tr> 134<td><p><span class="term">plugin</span></p></td> 135<td> 136 <a class="link" href="gstreamer-plugins-plugin-coreelements.html#plugin-coreelements">coreelements</a> 137 </td> 138</tr> 139<tr> 140<td><p><span class="term">author</span></p></td> 141<td>Thomas Vander Stichele <thomas at apestaart dot org></td> 142</tr> 143<tr> 144<td><p><span class="term">class</span></p></td> 145<td>Sink/File</td> 146</tr> 147</tbody> 148</table></div> 149</div> 150<hr> 151<div class="refsect2"> 152<a name="id-1.2.10.8.4.2"></a><h3>Element Pads</h3> 153<div class="variablelist"><table border="0" class="variablelist"> 154<colgroup> 155<col align="left" valign="top"> 156<col> 157</colgroup> 158<tbody> 159<tr> 160<td><p><span class="term">name</span></p></td> 161<td>sink</td> 162</tr> 163<tr> 164<td><p><span class="term">direction</span></p></td> 165<td>sink</td> 166</tr> 167<tr> 168<td><p><span class="term">presence</span></p></td> 169<td>always</td> 170</tr> 171<tr> 172<td><p><span class="term">details</span></p></td> 173<td>ANY</td> 174</tr> 175</tbody> 176</table></div> 177</div> 178</div> 179</div> 180<div class="refsect1"> 181<a name="gstreamer-plugins-filesink.functions_details"></a><h2>Functions</h2> 182<p></p> 183</div> 184<div class="refsect1"> 185<a name="gstreamer-plugins-filesink.other_details"></a><h2>Types and Values</h2> 186<div class="refsect2"> 187<a name="GstFileSink-struct"></a><h3>struct GstFileSink</h3> 188<pre class="programlisting">struct GstFileSink;</pre> 189<p>Opaque <a class="link" href="gstreamer-plugins-filesink.html#GstFileSink"><span class="type">GstFileSink</span></a> structure.</p> 190</div> 191<hr> 192<div class="refsect2"> 193<a name="GstFileSinkBufferMode"></a><h3>enum GstFileSinkBufferMode</h3> 194<p>File read buffering mode.</p> 195<div class="refsect3"> 196<a name="GstFileSinkBufferMode.members"></a><h4>Members</h4> 197<div class="informaltable"><table class="informaltable" width="100%" border="0"> 198<colgroup> 199<col width="300px" class="enum_members_name"> 200<col class="enum_members_description"> 201<col width="200px" class="enum_members_annotations"> 202</colgroup> 203<tbody> 204<tr> 205<td class="enum_member_name"><p><a name="GST-FILE-SINK-BUFFER-MODE-DEFAULT:CAPS"></a>GST_FILE_SINK_BUFFER_MODE_DEFAULT</p></td> 206<td class="enum_member_description"> 207<p>Default buffering</p> 208</td> 209<td class="enum_member_annotations"> </td> 210</tr> 211<tr> 212<td class="enum_member_name"><p><a name="GST-FILE-SINK-BUFFER-MODE-FULL:CAPS"></a>GST_FILE_SINK_BUFFER_MODE_FULL</p></td> 213<td class="enum_member_description"> 214<p>Fully buffered</p> 215</td> 216<td class="enum_member_annotations"> </td> 217</tr> 218<tr> 219<td class="enum_member_name"><p><a name="GST-FILE-SINK-BUFFER-MODE-LINE:CAPS"></a>GST_FILE_SINK_BUFFER_MODE_LINE</p></td> 220<td class="enum_member_description"> 221<p>Line buffered</p> 222</td> 223<td class="enum_member_annotations"> </td> 224</tr> 225<tr> 226<td class="enum_member_name"><p><a name="GST-FILE-SINK-BUFFER-MODE-UNBUFFERED:CAPS"></a>GST_FILE_SINK_BUFFER_MODE_UNBUFFERED</p></td> 227<td class="enum_member_description"> 228<p>Unbuffered</p> 229</td> 230<td class="enum_member_annotations"> </td> 231</tr> 232</tbody> 233</table></div> 234</div> 235</div> 236</div> 237<div class="refsect1"> 238<a name="gstreamer-plugins-filesink.property-details"></a><h2>Property Details</h2> 239<div class="refsect2"> 240<a name="GstFileSink--append"></a><h3>The <code class="literal">“append”</code> property</h3> 241<pre class="programlisting"> “append” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 242<p>Append to an already existing file.</p> 243<p>Flags: Read / Write</p> 244<p>Default value: FALSE</p> 245</div> 246<hr> 247<div class="refsect2"> 248<a name="GstFileSink--buffer-mode"></a><h3>The <code class="literal">“buffer-mode”</code> property</h3> 249<pre class="programlisting"> “buffer-mode” <a class="link" href="gstreamer-plugins-filesink.html#GstFileSinkBufferMode" title="enum GstFileSinkBufferMode"><span class="type">GstFileSinkBufferMode</span></a></pre> 250<p>The buffering mode to use.</p> 251<p>Flags: Read / Write</p> 252<p>Default value: Default buffering</p> 253</div> 254<hr> 255<div class="refsect2"> 256<a name="GstFileSink--buffer-size"></a><h3>The <code class="literal">“buffer-size”</code> property</h3> 257<pre class="programlisting"> “buffer-size” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 258<p>Size of buffer in number of bytes for line or full buffer-mode.</p> 259<p>Flags: Read / Write</p> 260<p>Default value: 65536</p> 261</div> 262<hr> 263<div class="refsect2"> 264<a name="GstFileSink--location"></a><h3>The <code class="literal">“location”</code> property</h3> 265<pre class="programlisting"> “location” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 266<p>Location of the file to write.</p> 267<p>Flags: Read / Write</p> 268<p>Default value: NULL</p> 269</div> 270</div> 271<div class="refsect1"> 272<a name="gstreamer-plugins-filesink.see-also"></a><h2>See Also</h2> 273<p><a class="link" href="gstreamer-plugins-filesrc.html#GstFileSrc"><span class="type">GstFileSrc</span></a></p> 274</div> 275</div> 276<div class="footer"> 277<hr>Generated by GTK-Doc V1.28</div> 278</body> 279</html>
