plugins/html/gst-plugins-bad-plugins-netsim.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>netsim: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
<link rel="prev" href="gst-plugins-bad-plugins-neonhttpsrc.html" title="neonhttpsrc">
<link rel="next" href="gst-plugins-bad-plugins-ofa.html" title="ofa">
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span>
                  <a href="#gst-plugins-bad-plugins-netsim.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
                  <a href="#gst-plugins-bad-plugins-netsim.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span>
                  <a href="#gst-plugins-bad-plugins-netsim.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gst-plugins-bad-plugins-neonhttpsrc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gst-plugins-bad-plugins-ofa.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gst-plugins-bad-plugins-netsim"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-netsim.top_of_page"></a>netsim</span></h2>
<p>netsim</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-netsim.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-netsim.html#GstNetSim--delay-probability" title="The “delay-probability” property">delay-probability</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-netsim.html#GstNetSim--drop-packets" title="The “drop-packets” property">drop-packets</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-netsim.html#GstNetSim--drop-probability" title="The “drop-probability” property">drop-probability</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-netsim.html#GstNetSim--duplicate-probability" title="The “duplicate-probability” property">duplicate-probability</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-netsim.html#GstNetSim--max-delay" title="The “max-delay” property">max-delay</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-netsim.html#GstNetSim--min-delay" title="The “min-delay” property">min-delay</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-netsim.html#GstNetSim--allow-reordering" title="The “allow-reordering” property">allow-reordering</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="gst-plugins-bad-plugins-netsim.html#GstNetSimDistribution" title="enum GstNetSimDistribution"><span class="type">GstNetSimDistribution</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-netsim.html#GstNetSim--delay-distribution" title="The “delay-distribution” property">delay-distribution</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-netsim.html#GstNetSim--max-bucket-size" title="The “max-bucket-size” property">max-bucket-size</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-netsim.html#GstNetSim--max-kbps" title="The “max-kbps” property">max-kbps</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
</tbody>
</table></div>
</div>
<a name="GstNetSim"></a><div class="refsect1">
<a name="gst-plugins-bad-plugins-netsim.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-netsim.html#GstNetSim-struct" title="struct GstNetSim">GstNetSim</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-netsim.html#GstNetSimDistribution" title="enum GstNetSimDistribution">GstNetSimDistribution</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-netsim.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
                <span class="lineart">╰──</span> GstNetSim
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-netsim.description"></a><h2>Description</h2>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="refsect2">
<a name="id-1.2.154.7.2.1"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">plugin</span></p></td>
<td>
            <a class="link" href="gst-plugins-bad-plugins-plugin-netsim.html#plugin-netsim">netsim</a>
          </td>
</tr>
<tr>
<td><p><span class="term">author</span></p></td>
<td>Philippe Kalaf &lt;philippe.kalaf@collabora.co.uk&gt;, Havard Graff &lt;havard@pexip.com&gt;</td>
</tr>
<tr>
<td><p><span class="term">class</span></p></td>
<td>Filter/Network</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="id-1.2.154.7.2.2"></a><h3>Element Pads</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>ANY</td>
</tr>
</tbody>
</table></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>src</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>source</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>ANY</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-netsim.functions_details"></a><h2>Functions</h2>
<p></p>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-netsim.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstNetSim-struct"></a><h3>struct GstNetSim</h3>
<pre class="programlisting">struct GstNetSim;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GstNetSimDistribution"></a><h3>enum GstNetSimDistribution</h3>
<div class="refsect3">
<a name="GstNetSimDistribution.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="DISTRIBUTION-UNIFORM:CAPS"></a>DISTRIBUTION_UNIFORM</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="DISTRIBUTION-NORMAL:CAPS"></a>DISTRIBUTION_NORMAL</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="DISTRIBUTION-GAMMA:CAPS"></a>DISTRIBUTION_GAMMA</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-netsim.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstNetSim--delay-probability"></a><h3>The <code class="literal">“delay-probability”</code> property</h3>
<pre class="programlisting">  “delay-probability”        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre>
<p>The Probability a buffer is delayed.</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstNetSim--drop-packets"></a><h3>The <code class="literal">“drop-packets”</code> property</h3>
<pre class="programlisting">  “drop-packets”             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
<p>Drop the next n packets.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstNetSim--drop-probability"></a><h3>The <code class="literal">“drop-probability”</code> property</h3>
<pre class="programlisting">  “drop-probability”         <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre>
<p>The Probability a buffer is dropped.</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstNetSim--duplicate-probability"></a><h3>The <code class="literal">“duplicate-probability”</code> property</h3>
<pre class="programlisting">  “duplicate-probability”    <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre>
<p>The Probability a buffer is duplicated.</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstNetSim--max-delay"></a><h3>The <code class="literal">“max-delay”</code> property</h3>
<pre class="programlisting">  “max-delay”                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The maximum delay (inclusive) in ms to apply to buffers.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: 400</p>
</div>
<hr>
<div class="refsect2">
<a name="GstNetSim--min-delay"></a><h3>The <code class="literal">“min-delay”</code> property</h3>
<pre class="programlisting">  “min-delay”                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The minimum delay in ms to apply to buffers.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: 200</p>
</div>
<hr>
<div class="refsect2">
<a name="GstNetSim--allow-reordering"></a><h3>The <code class="literal">“allow-reordering”</code> property</h3>
<pre class="programlisting">  “allow-reordering”         <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>When delaying packets, are they allowed to be reordered or not. By
default this is enabled, but in the real world packet reordering is
fairly uncommon, yet the delay functions will always introduce reordering
if delay &gt; packet-spacing, This property allows switching that off.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: TRUE</p>
<p class="since">Since: 1.14</p>
</div>
<hr>
<div class="refsect2">
<a name="GstNetSim--delay-distribution"></a><h3>The <code class="literal">“delay-distribution”</code> property</h3>
<pre class="programlisting">  “delay-distribution”       <a class="link" href="gst-plugins-bad-plugins-netsim.html#GstNetSimDistribution" title="enum GstNetSimDistribution"><span class="type">GstNetSimDistribution</span></a></pre>
<p>Distribution for the amount of delay.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: uniform</p>
<p class="since">Since: 1.14</p>
</div>
<hr>
<div class="refsect2">
<a name="GstNetSim--max-bucket-size"></a><h3>The <code class="literal">“max-bucket-size”</code> property</h3>
<pre class="programlisting">  “max-bucket-size”          <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The size of the token bucket, related to burstiness resilience.</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: &gt;= G_MAXULONG</p>
<p>Default value: -1</p>
<p class="since">Since: 1.14</p>
</div>
<hr>
<div class="refsect2">
<a name="GstNetSim--max-kbps"></a><h3>The <code class="literal">“max-kbps”</code> property</h3>
<pre class="programlisting">  “max-kbps”                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The maximum number of kilobits to let through per second. Setting this
property to a positive value enables network congestion simulation using
a token bucket algorithm. Also see the "max-bucket-size" property,</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: &gt;= G_MAXULONG</p>
<p>Default value: -1</p>
<p class="since">Since: 1.14</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>