docs/plugins/html/gst-plugins-base-plugins-giostreamsink.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>giostreamsink</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-base Elements">
   9 <link rel="prev" href="gst-plugins-base-plugins-giosrc.html" title="giosrc">
  10 <link rel="next" href="gst-plugins-base-plugins-giostreamsrc.html" title="giostreamsrc">
  11 <meta name="generator" content="GTK-Doc V1.17 (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-base-plugins-giosrc.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 Base Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-plugins-giostreamsrc.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-base-plugins-giostreamsink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-plugins-giostreamsink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-plugins-giostreamsink.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-plugins-giostreamsink.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-base-plugins-giostreamsink"></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-base-plugins-giostreamsink.top_of_page"></a>giostreamsink</span></h2>
  38 <p>giostreamsink — Write to any GIO stream</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="gst-plugins-base-plugins-giostreamsink.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstGioStreamSink"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-giostreamsink.html#GstGioStreamSink-struct" title="struct GstGioStreamSink">GstGioStreamSink</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-base-plugins-giostreamsink.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/GstBaseSink.html">GstBaseSink</a>
  54                      +----GstGioBaseSink
  55                            +----GstGioStreamSink
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="gst-plugins-base-plugins-giostreamsink.properties"></a><h2>Properties</h2>
  60 <pre class="synopsis">
  61   "<a class="link" href="gst-plugins-base-plugins-giostreamsink.html#GstGioStreamSink--stream" title='The "stream" property'>stream</a>"                   <a href="http://library.gnome.org/devel/gio/unstable/GOutputStream.html"><span class="type">GOutputStream</span></a>*        : Read / Write
  62 </pre>
  63 </div>
  64 <div class="refsect1">
  65 <a name="gst-plugins-base-plugins-giostreamsink.description"></a><h2>Description</h2>
  66 <p>
  67 This plugin writes incoming data to a custom GIO <a href="http://library.gnome.org/devel/gio/unstable/GOutputStream.html"><span class="type">GOutputStream</span></a>.
  68 </p>
  69 <p>
  70 It can, for example, be used to write a stream to memory with a
  71 <span class="type">GMemoryOuputStream</span> or to write to a file with a <span class="type">GFileOuputStream</span>.
  72 </p>
  73 <p>
  74 </p>
  75 <div class="refsect2">
  76 <a name="idp11498976"></a><h3>Example code</h3>
  77 <p>
  78 The following example writes the received data to a <a href="http://library.gnome.org/devel/gio/unstable/GMemoryOutputStream.html"><span class="type">GMemoryOutputStream</span></a>.
  79 </p>
  80 <div class="informalexample">
  81   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  82     <tbody>
  83       <tr>
  84         <td class="listing_lines" align="right"><pre>1
  85 2
  86 3
  87 4
  88 5
  89 6
  90 7
  91 8
  92 9
  93 10
  94 11
  95 12
  96 13
  97 14
  98 15
  99 16
 100 17
 101 18
 102 19
 103 20
 104 21
 105 22
 106 23</pre></td>
 107         <td class="listing_code"><pre class="programlisting"><span class="gtkdoc ppc">#include &lt;gst/gst.h&gt;</span>
 108 <span class="gtkdoc ppc">#include &lt;gio/gio.h&gt;</span>
 109
 110 <span class="gtkdoc opt">...</span>
 111
 112 GstElement <span class="gtkdoc opt">*</span>sink<span class="gtkdoc opt">;</span>
 113 GMemoryOuputStream <span class="gtkdoc opt">*</span>stream<span class="gtkdoc opt">;</span>
 114 <span class="gtkdoc slc">// out_data will contain the received data</span>
 115 guint8 <span class="gtkdoc opt">*</span>out_data<span class="gtkdoc opt">;</span>
 116
 117 <span class="gtkdoc opt">...</span>
 118
 119 stream <span class="gtkdoc opt">=</span> <span class="function">G_MEMORY_OUTPUT_STREAM</span> <span class="gtkdoc opt">(</span><span class="function"><a href="http://library.gnome.org/devel/gio/unstable/GMemoryOutputStream.html#g-memory-output-stream-new">g_memory_output_stream_new</a></span> <span class="gtkdoc opt">(</span>NULL<span class="gtkdoc opt">,</span> <span class="number">0</span><span class="gtkdoc opt">,</span>
 120           <span class="gtkdoc opt">(</span>GReallocFunc<span class="gtkdoc opt">)</span> g_realloc<span class="gtkdoc opt">, (</span>GDestroyNotify<span class="gtkdoc opt">)</span> g_free<span class="gtkdoc opt">));</span>
 121 sink <span class="gtkdoc opt">=</span> <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElementFactory.html#gst-element-factory-make">gst_element_factory_make</a></span> <span class="gtkdoc opt">(</span><span class="string">&quot;giostreamsink&quot;</span><span class="gtkdoc opt">,</span> <span class="string">&quot;sink&quot;</span><span class="gtkdoc opt">);</span>
 122 <span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-set">g_object_set</a></span> <span class="gtkdoc opt">(</span><span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#G-OBJECT:CAPS">G_OBJECT</a></span> <span class="gtkdoc opt">(</span>sink<span class="gtkdoc opt">),</span> <span class="string">&quot;stream&quot;</span><span class="gtkdoc opt">,</span> stream<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">);</span>
 123
 124 <span class="gtkdoc opt">...</span>
 125
 126 <span class="gtkdoc slc">// after processing get the written data</span>
 127 out_data <span class="gtkdoc opt">=</span> <span class="function">g_memory_ouput_stream_get_data</span> <span class="gtkdoc opt">(</span><span class="function">G_MEMORY_OUTPUT_STREAM</span> <span class="gtkdoc opt">(</span>stream<span class="gtkdoc opt">));</span>
 128
 129 <span class="gtkdoc opt">...</span></pre></td>
 130       </tr>
 131     </tbody>
 132   </table>
 133 </div>
 134
 135 <p>
 136 </p>
 137 </div>
 138 <p>
 139 </p>
 140 <div class="refsynopsisdiv">
 141 <h2>Synopsis</h2>
 142 <div class="refsect2">
 143 <a name="idp11503440"></a><h3>Element Information</h3>
 144 <div class="variablelist"><table border="0">
 145 <col align="left" valign="top">
 146 <tbody>
 147 <tr>
 148 <td><p><span class="term">plugin</span></p></td>
 149 <td>
 150             <a class="link" href="gst-plugins-base-plugins-plugin-gio.html#plugin-gio">gio</a>
 151           </td>
 152 </tr>
 153 <tr>
 154 <td><p><span class="term">author</span></p></td>
 155 <td>Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</td>
 156 </tr>
 157 <tr>
 158 <td><p><span class="term">class</span></p></td>
 159 <td>Sink</td>
 160 </tr>
 161 </tbody>
 162 </table></div>
 163 </div>
 164 <hr>
 165 <div class="refsect2">
 166 <a name="idp11510848"></a><h3>Element Pads</h3>
 167 <div class="variablelist"><table border="0">
 168 <col align="left" valign="top">
 169 <tbody>
 170 <tr>
 171 <td><p><span class="term">name</span></p></td>
 172 <td>sink</td>
 173 </tr>
 174 <tr>
 175 <td><p><span class="term">direction</span></p></td>
 176 <td>sink</td>
 177 </tr>
 178 <tr>
 179 <td><p><span class="term">presence</span></p></td>
 180 <td>always</td>
 181 </tr>
 182 <tr>
 183 <td><p><span class="term">details</span></p></td>
 184 <td>ANY</td>
 185 </tr>
 186 </tbody>
 187 </table></div>
 188 </div>
 189 </div>
 190 <p>
 191 </p>
 192 </div>
 193 <div class="refsect1">
 194 <a name="gst-plugins-base-plugins-giostreamsink.details"></a><h2>Details</h2>
 195 <div class="refsect2">
 196 <a name="GstGioStreamSink-struct"></a><h3>struct GstGioStreamSink</h3>
 197 <pre class="programlisting">struct GstGioStreamSink;</pre>
 198 <p>
 199 Opaque data structure.
 200 </p>
 201 </div>
 202 </div>
 203 <div class="refsect1">
 204 <a name="gst-plugins-base-plugins-giostreamsink.property-details"></a><h2>Property Details</h2>
 205 <div class="refsect2">
 206 <a name="GstGioStreamSink--stream"></a><h3>The <code class="literal">"stream"</code> property</h3>
 207 <pre class="programlisting">  "stream"                   <a href="http://library.gnome.org/devel/gio/unstable/GOutputStream.html"><span class="type">GOutputStream</span></a>*        : Read / Write</pre>
 208 <p>Stream to write to.</p>
 209 </div>
 210 </div>
 211 </div>
 212 <div class="footer">
 213 <hr>
 214           Generated by GTK-Doc V1.17</div>
 215 </body>
 216 </html>