1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>filesink</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GStreamer Core Plugins 0.10 Plugins Reference Manual">
8 <link rel="up" href="ch01.html" title="gstreamer Elements">
9 <link rel="prev" href="gstreamer-plugins-filesrc.html" title="filesrc">
10 <link rel="next" href="gstreamer-plugins-funnel.html" title="funnel">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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">
17 <td><a accesskey="p" href="gstreamer-plugins-filesrc.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 Core Plugins 0.10 Plugins Reference Manual</th>
21 <td><a accesskey="n" href="gstreamer-plugins-funnel.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gstreamer-plugins-filesink.synopsis" class="shortcut">Top</a>
26 <a href="#gstreamer-plugins-filesink.description" class="shortcut">Description</a>
28 <a href="#gstreamer-plugins-filesink.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#gstreamer-plugins-filesink.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32 <a href="#gstreamer-plugins-filesink.properties" class="shortcut">Properties</a>
35 <div class="refentry">
36 <a name="gstreamer-plugins-filesink"></a><div class="titlepage"></div>
37 <div class="refnamediv"><table width="100%"><tr>
39 <h2><span class="refentrytitle"><a name="gstreamer-plugins-filesink.top_of_page"></a>filesink</span></h2>
40 <p>filesink — Write stream to a file</p>
42 <td valign="top" align="right"></td>
44 <div class="refsynopsisdiv">
45 <a name="gstreamer-plugins-filesink.synopsis"></a><h2>Synopsis</h2>
46 <a name="GstFileSink"></a><pre class="synopsis">struct <a class="link" href="gstreamer-plugins-filesink.html#GstFileSink-struct" title="struct GstFileSink">GstFileSink</a>;
49 <div class="refsect1">
50 <a name="gstreamer-plugins-filesink.object-hierarchy"></a><h2>Object Hierarchy</h2>
51 <pre class="synopsis">
52 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
53 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
54 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
55 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSink.html">GstBaseSink</a>
59 <div class="refsect1">
60 <a name="gstreamer-plugins-filesink.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
62 GstFileSink implements
63 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstUriHandler.html#GstURIHandler">GstURIHandler</a>.</p>
65 <div class="refsect1">
66 <a name="gstreamer-plugins-filesink.properties"></a><h2>Properties</h2>
67 <pre class="synopsis">
68 "<a class="link" href="gstreamer-plugins-filesink.html#GstFileSink--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
69 "<a class="link" href="gstreamer-plugins-filesink.html#GstFileSink--buffer-mode" title='The "buffer-mode" property'>buffer-mode</a>" <span class="type">GstFileSinkBufferMode</span> : Read / Write
70 "<a class="link" href="gstreamer-plugins-filesink.html#GstFileSink--buffer-size" title='The "buffer-size" property'>buffer-size</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
71 "<a class="link" href="gstreamer-plugins-filesink.html#GstFileSink--append" title='The "append" property'>append</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
74 <div class="refsect1">
75 <a name="gstreamer-plugins-filesink.description"></a><h2>Description</h2>
77 Write incoming data to a file in the local file system.
81 <div class="refsect2">
82 <a name="idp5711280"></a><h3>Example launch line</h3>
83 <div class="informalexample">
84 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
87 <td class="listing_lines" align="right"><pre>1</pre></td>
88 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch 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>
93 Capture one frame from a v4l2 camera and save as jpeg image.
97 <div class="refsynopsisdiv">
99 <div class="refsect2">
100 <a name="idp5713840"></a><h3>Element Information</h3>
101 <div class="variablelist"><table border="0">
102 <col align="left" valign="top">
105 <td><p><span class="term">plugin</span></p></td>
107 <a class="link" href="gstreamer-plugins-plugin-coreelements.html#plugin-coreelements">coreelements</a>
111 <td><p><span class="term">author</span></p></td>
112 <td>Thomas Vander Stichele <thomas at apestaart dot org></td>
115 <td><p><span class="term">class</span></p></td>
122 <div class="refsect2">
123 <a name="idp9831536"></a><h3>Element Pads</h3>
124 <div class="variablelist"><table border="0">
125 <col align="left" valign="top">
128 <td><p><span class="term">name</span></p></td>
132 <td><p><span class="term">direction</span></p></td>
136 <td><p><span class="term">presence</span></p></td>
140 <td><p><span class="term">details</span></p></td>
150 <div class="refsect1">
151 <a name="gstreamer-plugins-filesink.details"></a><h2>Details</h2>
152 <div class="refsect2">
153 <a name="GstFileSink-struct"></a><h3>struct GstFileSink</h3>
154 <pre class="programlisting">struct GstFileSink;</pre>
156 Opaque <a class="link" href="gstreamer-plugins-filesink.html#GstFileSink"><span class="type">GstFileSink</span></a> structure.
160 <div class="refsect1">
161 <a name="gstreamer-plugins-filesink.property-details"></a><h2>Property Details</h2>
162 <div class="refsect2">
163 <a name="GstFileSink--location"></a><h3>The <code class="literal">"location"</code> property</h3>
164 <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>
165 <p>Location of the file to write.</p>
166 <p>Default value: NULL</p>
169 <div class="refsect2">
170 <a name="GstFileSink--buffer-mode"></a><h3>The <code class="literal">"buffer-mode"</code> property</h3>
171 <pre class="programlisting"> "buffer-mode" <span class="type">GstFileSinkBufferMode</span> : Read / Write</pre>
172 <p>The buffering mode to use.</p>
173 <p>Default value: Default buffering</p>
176 <div class="refsect2">
177 <a name="GstFileSink--buffer-size"></a><h3>The <code class="literal">"buffer-size"</code> property</h3>
178 <pre class="programlisting"> "buffer-size" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
179 <p>Size of buffer in number of bytes for line or full buffer-mode.</p>
180 <p>Default value: 65536</p>
183 <div class="refsect2">
184 <a name="GstFileSink--append"></a><h3>The <code class="literal">"append"</code> property</h3>
185 <pre class="programlisting"> "append" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
187 Append to an already existing file.
189 <p>Default value: FALSE</p>
190 <p class="since">Since 0.10.25</p>
193 <div class="refsect1">
194 <a name="gstreamer-plugins-filesink.see-also"></a><h2>See Also</h2>
195 <a class="link" href="gstreamer-plugins-filesrc.html#GstFileSrc"><span class="type">GstFileSrc</span></a>
200 Generated by GTK-Doc V1.18</div>