docs/plugins/html/gst-plugins-base-plugins-giostreamsrc.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>giostreamsrc</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-giostreamsink.html" title="giostreamsink">
  10 <link rel="next" href="gst-plugins-base-plugins-gnomevfssink.html" title="gnomevfssink">
  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-giostreamsink.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-gnomevfssink.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-giostreamsrc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-plugins-giostreamsrc.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-plugins-giostreamsrc.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-plugins-giostreamsrc.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-base-plugins-giostreamsrc"></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-giostreamsrc.top_of_page"></a>giostreamsrc</span></h2>
  38 <p>giostreamsrc — Read from 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-giostreamsrc.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstGioStreamSrc"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-giostreamsrc.html#GstGioStreamSrc-struct" title="struct GstGioStreamSrc">GstGioStreamSrc</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-base-plugins-giostreamsrc.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/GstBaseSrc.html">GstBaseSrc</a>
  54                      +----GstGioBaseSrc
  55                            +----GstGioStreamSrc
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="gst-plugins-base-plugins-giostreamsrc.properties"></a><h2>Properties</h2>
  60 <pre class="synopsis">
  61   "<a class="link" href="gst-plugins-base-plugins-giostreamsrc.html#GstGioStreamSrc--stream" title='The "stream" property'>stream</a>"                   <a href="http://library.gnome.org/devel/gio/unstable/GInputStream.html"><span class="type">GInputStream</span></a>*         : Read / Write
  62 </pre>
  63 </div>
  64 <div class="refsect1">
  65 <a name="gst-plugins-base-plugins-giostreamsrc.description"></a><h2>Description</h2>
  66 <p>
  67 This plugin reads data from a custom GIO <a href="http://library.gnome.org/devel/gio/unstable/GInputStream.html"><span class="type">GInputStream</span></a>.
  68 </p>
  69 <p>
  70 It can, for example, be used to read data from memory with a
  71 <a href="http://library.gnome.org/devel/gio/unstable/GMemoryInputStream.html"><span class="type">GMemoryInputStream</span></a> or to read from a file with a
  72 <a href="http://library.gnome.org/devel/gio/unstable/GFileInputStream.html"><span class="type">GFileInputStream</span></a>.
  73 </p>
  74 <p>
  75 </p>
  76 <div class="refsect2">
  77 <a name="idp11630736"></a><h3>Example code</h3>
  78 <p>
  79 The following example reads data from a <a href="http://library.gnome.org/devel/gio/unstable/GMemoryInputStream.html"><span class="type">GMemoryInputStream</span></a>.
  80 </p>
  81 <div class="informalexample">
  82   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  83     <tbody>
  84       <tr>
  85         <td class="listing_lines" align="right"><pre>1
  86 2
  87 3
  88 4
  89 5
  90 6
  91 7
  92 8
  93 9
  94 10
  95 11
  96 12
  97 13
  98 14
  99 15
 100 16
 101 17
 102 18
 103 19
 104 20
 105 21
 106 22</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>src<span class="gtkdoc opt">;</span>
 113 GMemoryInputStream <span class="gtkdoc opt">*</span>stream<span class="gtkdoc opt">;</span>
 114 <span class="gtkdoc slc">// in_data will contain the data to send</span>
 115 guint8 <span class="gtkdoc opt">*</span>in_data<span class="gtkdoc opt">;</span>
 116 gint i<span class="gtkdoc opt">;</span>
 117
 118 <span class="gtkdoc opt">...</span>
 119 in_data <span class="gtkdoc opt">=</span> <span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-new">g_new</a></span> <span class="gtkdoc opt">(</span>guint8<span class="gtkdoc opt">,</span> <span class="number">512</span><span class="gtkdoc opt">);</span>
 120 <span class="keyword">for</span> <span class="gtkdoc opt">(</span>i <span class="gtkdoc opt">=</span> <span class="number">0</span><span class="gtkdoc opt">;</span> i <span class="gtkdoc opt">&lt;</span> <span class="number">512</span><span class="gtkdoc opt">;</span> i<span class="gtkdoc opt">++)</span>
 121   in_data<span class="gtkdoc opt">[</span>i<span class="gtkdoc opt">] =</span> i <span class="gtkdoc opt">%</span> <span class="number">256</span><span class="gtkdoc opt">;</span>
 122
 123 stream <span class="gtkdoc opt">=</span> <span class="function">G_MEMORY_INPUT_STREAM</span> <span class="gtkdoc opt">(</span><span class="function"><a href="http://library.gnome.org/devel/gio/unstable/GMemoryInputStream.html#g-memory-input-stream-new-from-data">g_memory_input_stream_new_from_data</a></span> <span class="gtkdoc opt">(</span>in_data<span class="gtkdoc opt">,</span> <span class="number">512</span><span class="gtkdoc opt">,</span>
 124           <span class="gtkdoc opt">(</span>GDestroyNotify<span class="gtkdoc opt">)</span> g_free<span class="gtkdoc opt">));</span>
 125 src <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;giostreamsrc&quot;</span><span class="gtkdoc opt">,</span> <span class="string">&quot;src&quot;</span><span class="gtkdoc opt">);</span>
 126 <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>src<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>
 127
 128 <span class="gtkdoc opt">...</span></pre></td>
 129       </tr>
 130     </tbody>
 131   </table>
 132 </div>
 133
 134 <p>
 135 </p>
 136 </div>
 137 <p>
 138 </p>
 139 <div class="refsynopsisdiv">
 140 <h2>Synopsis</h2>
 141 <div class="refsect2">
 142 <a name="idp11635136"></a><h3>Element Information</h3>
 143 <div class="variablelist"><table border="0">
 144 <col align="left" valign="top">
 145 <tbody>
 146 <tr>
 147 <td><p><span class="term">plugin</span></p></td>
 148 <td>
 149             <a class="link" href="gst-plugins-base-plugins-plugin-gio.html#plugin-gio">gio</a>
 150           </td>
 151 </tr>
 152 <tr>
 153 <td><p><span class="term">author</span></p></td>
 154 <td>Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term">class</span></p></td>
 158 <td>Source</td>
 159 </tr>
 160 </tbody>
 161 </table></div>
 162 </div>
 163 <hr>
 164 <div class="refsect2">
 165 <a name="idp11537408"></a><h3>Element Pads</h3>
 166 <div class="variablelist"><table border="0">
 167 <col align="left" valign="top">
 168 <tbody>
 169 <tr>
 170 <td><p><span class="term">name</span></p></td>
 171 <td>src</td>
 172 </tr>
 173 <tr>
 174 <td><p><span class="term">direction</span></p></td>
 175 <td>source</td>
 176 </tr>
 177 <tr>
 178 <td><p><span class="term">presence</span></p></td>
 179 <td>always</td>
 180 </tr>
 181 <tr>
 182 <td><p><span class="term">details</span></p></td>
 183 <td>ANY</td>
 184 </tr>
 185 </tbody>
 186 </table></div>
 187 </div>
 188 </div>
 189 <p>
 190 </p>
 191 </div>
 192 <div class="refsect1">
 193 <a name="gst-plugins-base-plugins-giostreamsrc.details"></a><h2>Details</h2>
 194 <div class="refsect2">
 195 <a name="GstGioStreamSrc-struct"></a><h3>struct GstGioStreamSrc</h3>
 196 <pre class="programlisting">struct GstGioStreamSrc;</pre>
 197 <p>
 198 Opaque data structure.
 199 </p>
 200 </div>
 201 </div>
 202 <div class="refsect1">
 203 <a name="gst-plugins-base-plugins-giostreamsrc.property-details"></a><h2>Property Details</h2>
 204 <div class="refsect2">
 205 <a name="GstGioStreamSrc--stream"></a><h3>The <code class="literal">"stream"</code> property</h3>
 206 <pre class="programlisting">  "stream"                   <a href="http://library.gnome.org/devel/gio/unstable/GInputStream.html"><span class="type">GInputStream</span></a>*         : Read / Write</pre>
 207 <p>Stream to read from.</p>
 208 </div>
 209 </div>
 210 </div>
 211 <div class="footer">
 212 <hr>
 213           Generated by GTK-Doc V1.17</div>
 214 </body>
 215 </html>