wearable/docs/plugins/html/gstreamer-plugins-fdsrc.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>fdsrc</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-fdsink.html" title="fdsink">
  10 <link rel="next" href="gstreamer-plugins-filesrc.html" title="filesrc">
  11 <meta name="generator" content="GTK-Doc V1.18 (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="gstreamer-plugins-fdsink.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-filesrc.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="#gstreamer-plugins-fdsrc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gstreamer-plugins-fdsrc.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gstreamer-plugins-fdsrc.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gstreamer-plugins-fdsrc.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gstreamer-plugins-fdsrc.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gstreamer-plugins-fdsrc"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="gstreamer-plugins-fdsrc.top_of_page"></a>fdsrc</span></h2>
  40 <p>fdsrc — Read from a file descriptor</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="gstreamer-plugins-fdsrc.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstFdSrc"></a><pre class="synopsis">struct              <a class="link" href="gstreamer-plugins-fdsrc.html#GstFdSrc-struct" title="struct GstFdSrc">GstFdSrc</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gstreamer-plugins-fdsrc.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/GstBaseSrc.html">GstBaseSrc</a>
  56                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstPushSrc.html">GstPushSrc</a>
  57                            +----GstFdSrc
  58 </pre>
  59 </div>
  60 <div class="refsect1">
  61 <a name="gstreamer-plugins-fdsrc.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  62 <p>
  63 GstFdSrc implements
  64  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstUriHandler.html#GstURIHandler">GstURIHandler</a>.</p>
  65 </div>
  66 <div class="refsect1">
  67 <a name="gstreamer-plugins-fdsrc.properties"></a><h2>Properties</h2>
  68 <pre class="synopsis">
  69   "<a class="link" href="gstreamer-plugins-fdsrc.html#GstFdSrc--fd" title='The "fd" property'>fd</a>"                       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  70   "<a class="link" href="gstreamer-plugins-fdsrc.html#GstFdSrc--timeout" title='The "timeout" property'>timeout</a>"                  <span class="type">guint64</span>               : Read / Write
  71 </pre>
  72 </div>
  73 <div class="refsect1">
  74 <a name="gstreamer-plugins-fdsrc.description"></a><h2>Description</h2>
  75 <p>
  76 Read data from a unix file descriptor.
  77 </p>
  78 <p>
  79 To generate data, enter some data on the console folowed by enter.
  80 The above mentioned pipeline should dump data packets to the console.
  81 </p>
  82 <p>
  83 If the <a class="link" href="gstreamer-plugins-fdsrc.html#GstFdSrc--timeout" title='The "timeout" property'><span class="type">"timeout"</span></a> property is set to a value bigger than 0, fdsrc will
  84 generate an element message named
  85 <code class="classname">"GstFdSrcTimeout"</code>
  86 if no data was recieved in the given timeout.
  87 The message's structure contains one field:
  88 </p>
  89 <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
  90   <span class="type">guint64</span>
  91   <code class="classname">"timeout"</code>: the timeout in microseconds that
  92   expired when waiting for data.
  93   </p></li></ul></div>
  94 <p>
  95 </p>
  96 <p>
  97 </p>
  98 <div class="refsect2">
  99 <a name="idp4924080"></a><h3>Example launch line</h3>
 100 <div class="informalexample">
 101   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 102     <tbody>
 103       <tr>
 104         <td class="listing_lines" align="right"><pre>1</pre></td>
 105         <td class="listing_code"><pre class="programlisting">echo <span class="string">&quot;Hello GStreamer&quot;</span> <span class="gtkdoc opt">|</span> gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v fdsrc <span class="gtkdoc opt">!</span> fakesink dump<span class="gtkdoc opt">=</span><span class="keyword">true</span></pre></td>
 106       </tr>
 107     </tbody>
 108   </table>
 109 </div>
 110  A simple pipeline to read from the standard input and dump the data
 111 with a fakesink as hex ascii block.
 112 </div>
 113 <p>
 114 </p>
 115 <p>
 116 Last reviewed on 2008-06-20 (0.10.21)
 117 </p>
 118 <div class="refsynopsisdiv">
 119 <h2>Synopsis</h2>
 120 <div class="refsect2">
 121 <a name="idp9736896"></a><h3>Element Information</h3>
 122 <div class="variablelist"><table border="0">
 123 <col align="left" valign="top">
 124 <tbody>
 125 <tr>
 126 <td><p><span class="term">plugin</span></p></td>
 127 <td>
 128             <a class="link" href="gstreamer-plugins-plugin-coreelements.html#plugin-coreelements">coreelements</a>
 129           </td>
 130 </tr>
 131 <tr>
 132 <td><p><span class="term">author</span></p></td>
 133 <td>Erik Walthinsen &lt;omega@cse.ogi.edu&gt;</td>
 134 </tr>
 135 <tr>
 136 <td><p><span class="term">class</span></p></td>
 137 <td>Source/File</td>
 138 </tr>
 139 </tbody>
 140 </table></div>
 141 </div>
 142 <hr>
 143 <div class="refsect2">
 144 <a name="idp9744304"></a><h3>Element Pads</h3>
 145 <div class="variablelist"><table border="0">
 146 <col align="left" valign="top">
 147 <tbody>
 148 <tr>
 149 <td><p><span class="term">name</span></p></td>
 150 <td>src</td>
 151 </tr>
 152 <tr>
 153 <td><p><span class="term">direction</span></p></td>
 154 <td>source</td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term">presence</span></p></td>
 158 <td>always</td>
 159 </tr>
 160 <tr>
 161 <td><p><span class="term">details</span></p></td>
 162 <td>ANY</td>
 163 </tr>
 164 </tbody>
 165 </table></div>
 166 </div>
 167 </div>
 168 <p>
 169 </p>
 170 </div>
 171 <div class="refsect1">
 172 <a name="gstreamer-plugins-fdsrc.details"></a><h2>Details</h2>
 173 <div class="refsect2">
 174 <a name="GstFdSrc-struct"></a><h3>struct GstFdSrc</h3>
 175 <pre class="programlisting">struct GstFdSrc;</pre>
 176 <p>
 177 Opaque <a class="link" href="gstreamer-plugins-fdsrc.html#GstFdSrc"><span class="type">GstFdSrc</span></a> data structure.
 178 </p>
 179 </div>
 180 </div>
 181 <div class="refsect1">
 182 <a name="gstreamer-plugins-fdsrc.property-details"></a><h2>Property Details</h2>
 183 <div class="refsect2">
 184 <a name="GstFdSrc--fd"></a><h3>The <code class="literal">"fd"</code> property</h3>
 185 <pre class="programlisting">  "fd"                       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 186 <p>An open file descriptor to read from.</p>
 187 <p>Allowed values: &gt;= 0</p>
 188 <p>Default value: 0</p>
 189 </div>
 190 <hr>
 191 <div class="refsect2">
 192 <a name="GstFdSrc--timeout"></a><h3>The <code class="literal">"timeout"</code> property</h3>
 193 <pre class="programlisting">  "timeout"                  <span class="type">guint64</span>               : Read / Write</pre>
 194 <p>
 195 Post a message after timeout microseconds
 196 </p>
 197 <p>Default value: 0</p>
 198 <p class="since">Since 0.10.21</p>
 199 </div>
 200 </div>
 201 <div class="refsect1">
 202 <a name="gstreamer-plugins-fdsrc.see-also"></a><h2>See Also</h2>
 203 <a class="link" href="gstreamer-plugins-fdsink.html#GstFdSink"><span class="type">GstFdSink</span></a>
 204 </div>
 205 </div>
 206 <div class="footer">
 207 <hr>
 208           Generated by GTK-Doc V1.18</div>
 209 </body>
 210 </html>