Imported Upstream version 1.0.4
[ubuntu-omap:gst-plugins-bad1-0.git] / docs / plugins / html / gst-plugins-bad-plugins-pcapparse.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>pcapparse</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual">
8 <link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
9 <link rel="prev" href="gst-plugins-bad-plugins-mpg123audiodec.html" title="mpg123audiodec">
10 <link rel="next" href="gst-plugins-bad-plugins-pinch.html" title="pinch">
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="gst-plugins-bad-plugins-mpg123audiodec.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 Bad Plugins 1.0 Plugins Reference Manual</th>
21 <td><a accesskey="n" href="gst-plugins-bad-plugins-pinch.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-bad-plugins-pcapparse.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-bad-plugins-pcapparse.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-bad-plugins-pcapparse.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-bad-plugins-pcapparse.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry">
34 <a name="gst-plugins-bad-plugins-pcapparse"></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-bad-plugins-pcapparse.top_of_page"></a>pcapparse</span></h2>
38 <p>pcapparse — Parses a raw pcap stream</p>
39 </td>
40 <td valign="top" align="right"></td>
41 </tr></table></div>
42 <div class="refsynopsisdiv">
43 <a name="gst-plugins-bad-plugins-pcapparse.synopsis"></a><h2>Synopsis</h2>
44 <a name="GstPcapParse"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse-struct" title="struct GstPcapParse">GstPcapParse</a>;
45 </pre>
46 </div>
47 <div class="refsect1">
48 <a name="gst-plugins-bad-plugins-pcapparse.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://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
52          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
53                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
54                      +----GstPcapParse
55 </pre>
56 </div>
57 <div class="refsect1">
58 <a name="gst-plugins-bad-plugins-pcapparse.properties"></a><h2>Properties</h2>
59 <pre class="synopsis">
60   "<a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--dst-ip" title='The "dst-ip" property'>dst-ip</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
61   "<a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--dst-port" title='The "dst-port" property'>dst-port</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
62   "<a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--src-ip" title='The "src-ip" property'>src-ip</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
63   "<a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--src-port" title='The "src-port" property'>src-port</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
64   "<a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--caps" title='The "caps" property'>caps</a>"                     <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>*              : Read / Write
65   "<a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--ts-offset" title='The "ts-offset" property'>ts-offset</a>"                <span class="type">gint64</span>                : Read / Write
66 </pre>
67 </div>
68 <div class="refsect1">
69 <a name="gst-plugins-bad-plugins-pcapparse.description"></a><h2>Description</h2>
70 <p>
71 Extracts payloads from Ethernet-encapsulated IP packets.
72 Use <a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--src-ip" title='The "src-ip" property'><span class="type">"src-ip"</span></a>, <a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--dst-ip" title='The "dst-ip" property'><span class="type">"dst-ip"</span></a>,
73 <a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--src-port" title='The "src-port" property'><span class="type">"src-port"</span></a> and <a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--dst-port" title='The "dst-port" property'><span class="type">"dst-port"</span></a> to restrict which packets
74 should be included.
75 </p>
76 <p>
77 </p>
78 <div class="refsect2">
79 <a name="idp12768624"></a><h3>Example pipelines</h3>
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</pre></td>
86         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">0.10</span> filesrc location<span class="gtkdoc opt">=</span>h264crasher<span class="gtkdoc opt">.</span>pcap <span class="gtkdoc opt">!</span> pcapparse <span class="gtkdoc opt">!</span> rtph264depay
87 <span class="gtkdoc opt">!</span> ffdec_h264 <span class="gtkdoc opt">!</span> fakesink</pre></td>
88       </tr>
89     </tbody>
90   </table>
91 </div>
92  Read from a pcap dump file using filesrc, extract the raw UDP packets,
93 depayload and decode them.
94 </div>
95 <p>
96 </p>
97 <div class="refsynopsisdiv">
98 <h2>Synopsis</h2>
99 <div class="refsect2">
100 <a name="idp13461744"></a><h3>Element Information</h3>
101 <div class="variablelist"><table border="0">
102 <col align="left" valign="top">
103 <tbody>
104 <tr>
105 <td><p><span class="term">plugin</span></p></td>
106 <td>
107             <a class="link" href="gst-plugins-bad-plugins-plugin-pcapparse.html#plugin-pcapparse">pcapparse</a>
108           </td>
109 </tr>
110 <tr>
111 <td><p><span class="term">author</span></p></td>
112 <td>Ole André Vadla Ravnås &lt;ole.andre.ravnas@tandberg.com&gt;</td>
113 </tr>
114 <tr>
115 <td><p><span class="term">class</span></p></td>
116 <td>Raw/Parser</td>
117 </tr>
118 </tbody>
119 </table></div>
120 </div>
121 <hr>
122 <div class="refsect2">
123 <a name="idp13469152"></a><h3>Element Pads</h3>
124 <div class="variablelist"><table border="0">
125 <col align="left" valign="top">
126 <tbody>
127 <tr>
128 <td><p><span class="term">name</span></p></td>
129 <td>sink</td>
130 </tr>
131 <tr>
132 <td><p><span class="term">direction</span></p></td>
133 <td>sink</td>
134 </tr>
135 <tr>
136 <td><p><span class="term">presence</span></p></td>
137 <td>always</td>
138 </tr>
139 <tr>
140 <td><p><span class="term">details</span></p></td>
141 <td>raw/x-pcap</td>
142 </tr>
143 </tbody>
144 </table></div>
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="gst-plugins-bad-plugins-pcapparse.details"></a><h2>Details</h2>
173 <div class="refsect2">
174 <a name="GstPcapParse-struct"></a><h3>struct GstPcapParse</h3>
175 <pre class="programlisting">struct GstPcapParse;</pre>
176 <p>
177 GstPcapParse element.
178 </p>
179 </div>
180 </div>
181 <div class="refsect1">
182 <a name="gst-plugins-bad-plugins-pcapparse.property-details"></a><h2>Property Details</h2>
183 <div class="refsect2">
184 <a name="GstPcapParse--dst-ip"></a><h3>The <code class="literal">"dst-ip"</code> property</h3>
185 <pre class="programlisting">  "dst-ip"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
186 <p>Destination IP to restrict to.</p>
187 <p>Default value: ""</p>
188 </div>
189 <hr>
190 <div class="refsect2">
191 <a name="GstPcapParse--dst-port"></a><h3>The <code class="literal">"dst-port"</code> property</h3>
192 <pre class="programlisting">  "dst-port"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
193 <p>Destination port to restrict to.</p>
194 <p>Allowed values: [G_MAXULONG,65535]</p>
195 <p>Default value: -1</p>
196 </div>
197 <hr>
198 <div class="refsect2">
199 <a name="GstPcapParse--src-ip"></a><h3>The <code class="literal">"src-ip"</code> property</h3>
200 <pre class="programlisting">  "src-ip"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
201 <p>Source IP to restrict to.</p>
202 <p>Default value: ""</p>
203 </div>
204 <hr>
205 <div class="refsect2">
206 <a name="GstPcapParse--src-port"></a><h3>The <code class="literal">"src-port"</code> property</h3>
207 <pre class="programlisting">  "src-port"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
208 <p>Source port to restrict to.</p>
209 <p>Allowed values: [G_MAXULONG,65535]</p>
210 <p>Default value: -1</p>
211 </div>
212 <hr>
213 <div class="refsect2">
214 <a name="GstPcapParse--caps"></a><h3>The <code class="literal">"caps"</code> property</h3>
215 <pre class="programlisting">  "caps"                     <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>*              : Read / Write</pre>
216 <p>The caps of the source pad.</p>
217 </div>
218 <hr>
219 <div class="refsect2">
220 <a name="GstPcapParse--ts-offset"></a><h3>The <code class="literal">"ts-offset"</code> property</h3>
221 <pre class="programlisting">  "ts-offset"                <span class="type">gint64</span>                : Read / Write</pre>
222 <p>Relative timestamp offset (ns) to apply (-1 = use absolute packet time).</p>
223 <p>Allowed values: &gt;= G_MAXULONG</p>
224 <p>Default value: -1</p>
225 </div>
226 </div>
227 </div>
228 <div class="footer">
229 <hr>
230           Generated by GTK-Doc V1.18</div>
231 </body>
232 </html>