plugins/html/gst-plugins-good-plugins-rtpstorage.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>rtpstorage: GStreamer Good 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 Good Plugins 1.0 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-good Elements">
<link rel="prev" href="gst-plugins-good-plugins-rtpssrcdemux.html" title="rtpssrcdemux">
<link rel="next" href="gst-plugins-good-plugins-rtpstreamdepay.html" title="rtpstreamdepay">
<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-good-plugins-rtpstorage.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
                  <a href="#gst-plugins-good-plugins-rtpstorage.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span>
                  <a href="#gst-plugins-good-plugins-rtpstorage.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-good-plugins-rtpssrcdemux.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gst-plugins-good-plugins-rtpstreamdepay.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gst-plugins-good-plugins-rtpstorage"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-rtpstorage.top_of_page"></a>rtpstorage</span></h2>
<p>rtpstorage — RTP storage for forward error correction (FEC) in rtpbin</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-rtpstorage.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/gobject/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> *</td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtpstorage.html#GstRtpStorage--internal-storage" title="The “internal-storage” property">internal-storage</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtpstorage.html#GstRtpStorage--size-time" title="The “size-time” property">size-time</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
</tbody>
</table></div>
</div>
<a name="GstRtpSsrcDemux"></a><a name="GstRtpStorage"></a><div class="refsect1">
<a name="gst-plugins-good-plugins-rtpstorage.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-good-plugins-rtpstorage.html#GstRtpStorage-struct" title="struct GstRtpStorage">GstRtpStorage</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-rtpstorage.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> GstRtpStorage
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-rtpstorage.description"></a><h2>Description</h2>
<p>Helper element for storing packets to aid later packet recovery from packet
loss using RED/FEC (Forward Error Correction).</p>
<p>The purpose of this element is to store a moving window of packets which
downstream elements such as <a class="link" href="gst-plugins-good-plugins-rtpulpfecdec.html#GstRtpUlpFecDec"><span class="type">GstRtpUlpFecDec</span></a> can request in order to perform
recovery of lost packets upon receiving custom GstRtpPacketLost events,
usually from <a class="link" href="gst-plugins-good-plugins-rtpjitterbuffer.html#GstRtpJitterBuffer"><span class="type">GstRtpJitterBuffer</span></a>.</p>
<p>As such, when building a pipeline manually, it should have the form:</p>
<p><code class="literal">
rtpstorage ! rtpjitterbuffer ! rtpulpfecdec
</code></p>
<p>where rtpulpfecdec get passed a reference to the object pointed to by
the <a class="link" href="gst-plugins-good-plugins-rtpstorage.html#GstRtpStorage--internal-storage" title="The “internal-storage” property"><span class="type">“internal-storage”</span></a> property.</p>
<p>The <a class="link" href="gst-plugins-good-plugins-rtpstorage.html#GstRtpStorage--size-time" title="The “size-time” property"><span class="type">“size-time”</span></a> property should be configured with a value
equal to the <a class="link" href="gst-plugins-good-plugins-rtpjitterbuffer.html#GstRtpJitterBuffer"><span class="type">GstRtpJitterBuffer</span></a> latency, plus some tolerance, in the order
of milliseconds, for example in the example found at
<a class="ulink" href="https://github.com/sdroege/gstreamer-rs/blob/master/examples/src/bin/rtpfecclient.rs" target="_top">https://github.com/sdroege/gstreamer-rs/blob/master/examples/src/bin/rtpfecclient.rs</a>,
<code class="literal">size-time</code> is configured as 200 + 50 milliseconds (latency + tolerance).</p>
<p>When using <a class="link" href="gst-plugins-good-plugins-rtpbin.html#GstRtpBin"><span class="type">GstRtpBin</span></a>, a storage element is created automatically, and
can be configured upon receiving the <a class="link" href="gst-plugins-good-plugins-rtpbin.html#GstRtpBin-new-storage" title="The “new-storage” signal"><span class="type">“new-storage”</span></a> signal.</p>
<p>See also: <a class="link" href="gst-plugins-good-plugins-rtpbin.html#GstRtpBin"><span class="type">GstRtpBin</span></a>, <a class="link" href="gst-plugins-good-plugins-rtpulpfecdec.html#GstRtpUlpFecDec"><span class="type">GstRtpUlpFecDec</span></a></p>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="refsect2">
<a name="id-1.2.221.8.10.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-good-plugins-plugin-rtp.html#plugin-rtp">rtp</a>
          </td>
</tr>
<tr>
<td><p><span class="term">author</span></p></td>
<td>Mikhail Fludkov &lt;misha@pexip.com&gt;</td>
</tr>
<tr>
<td><p><span class="term">class</span></p></td>
<td>Analyzer/RTP</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="id-1.2.221.8.10.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>application/x-rtp</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>application/x-rtp</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-rtpstorage.functions_details"></a><h2>Functions</h2>
<p></p>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-rtpstorage.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstRtpStorage-struct"></a><h3>struct GstRtpStorage</h3>
<pre class="programlisting">struct GstRtpStorage;</pre>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-rtpstorage.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstRtpStorage--internal-storage"></a><h3>The <code class="literal">“internal-storage”</code> property</h3>
<pre class="programlisting">  “internal-storage”         <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> *</pre>
<p>Internal RtpStorage object.</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="GstRtpStorage--size-time"></a><h3>The <code class="literal">“size-time”</code> property</h3>
<pre class="programlisting">  “size-time”                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre>
<p>The amount of data to keep in the storage (in ns, 0-disable).</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>