diff options
Diffstat (limited to 'docs/plugins/html/gst-plugins-good-plugins-rtprtxsend.html')
| -rwxr-xr-x | docs/plugins/html/gst-plugins-good-plugins-rtprtxsend.html | 274 |
1 files changed, 274 insertions, 0 deletions
diff --git a/docs/plugins/html/gst-plugins-good-plugins-rtprtxsend.html b/docs/plugins/html/gst-plugins-good-plugins-rtprtxsend.html new file mode 100755 index 0000000..9b3f55e --- /dev/null +++ b/docs/plugins/html/gst-plugins-good-plugins-rtprtxsend.html @@ -0,0 +1,274 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GStreamer Good Plugins 1.0 Plugins Reference Manual: rtprtxsend</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.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-rtprtxreceive.html" title="rtprtxreceive"> +<meta name="generator" content="GTK-Doc V1.21 (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-rtprtxsend.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#gst-plugins-good-plugins-rtprtxsend.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#gst-plugins-good-plugins-rtprtxsend.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-rtprtxreceive.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-rtprtxsend"></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-rtprtxsend.top_of_page"></a>rtprtxsend</span></h2> +<p>rtprtxsend — Retransmit RTP packets when needed, according to RFC4588</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="gst-plugins-good-plugins-rtprtxsend.properties"></a><h2>Properties</h2> +<div class="informaltable"><table 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="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtprtxsend.html#GstRtpRtxSend--rtx-payload-type" title="The “rtx-payload-type” property">rtx-payload-type</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtprtxsend.html#GstRtpRtxSend--max-size-time" title="The “max-size-time” property">max-size-time</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtprtxsend.html#GstRtpRtxSend--max-size-packets" title="The “max-size-packets” property">max-size-packets</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtprtxsend.html#GstRtpRtxSend--num-rtx-requests" title="The “num-rtx-requests” property">num-rtx-requests</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtprtxsend.html#GstRtpRtxSend--num-rtx-packets" title="The “num-rtx-packets” property">num-rtx-packets</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> +<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstStructure.html"><span class="type">GstStructure</span></a> *</td> +<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtprtxsend.html#GstRtpRtxSend--payload-type-map" title="The “payload-type-map” property">payload-type-map</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"> +<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstStructure.html"><span class="type">GstStructure</span></a> *</td> +<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtprtxsend.html#GstRtpRtxSend--ssrc-map" title="The “ssrc-map” property">ssrc-map</a></td> +<td class="property_flags">Write</td> +</tr> +</tbody> +</table></div> +</div> +<a name="GstRtpRtxSend"></a><div class="refsect1"> +<a name="gst-plugins-good-plugins-rtprtxsend.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table 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-rtprtxsend.html#GstRtpRtxSend-struct" title="struct GstRtpRtxSend">GstRtpRtxSend</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="gst-plugins-good-plugins-rtprtxsend.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> + <span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a> + <span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a> + <span class="lineart">╰──</span> GstRtpRtxSend +</pre> +</div> +<div class="refsect1"> +<a name="gst-plugins-good-plugins-rtprtxsend.description"></a><h2>Description</h2> +<p>See <a class="link" href="gst-plugins-good-plugins-rtprtxreceive.html#GstRtpRtxReceive"><span class="type">GstRtpRtxReceive</span></a> for examples</p> +<p>The purpose of the sender RTX object is to keep a history of RTP packets up +to a configurable limit (max-size-time or max-size-packets). It will listen +for upstream custom retransmission events (GstRTPRetransmissionRequest) that +comes from downstream (<a class="link" href="gst-plugins-good-plugins-rtpsession.html#GstRtpSession"><span class="type">GstRtpSession</span></a>). When receiving a request it will +look up the requested seqnum in its list of stored packets. If the packet +is available, it will create a RTX packet according to RFC 4588 and send +this as an auxiliary stream. RTX is SSRC-multiplexed</p> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="refsect2"> +<a name="id-1.2.132.7.3.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-good-plugins-plugin-rtpmanager.html#plugin-rtpmanager">rtpmanager</a> + </td> +</tr> +<tr> +<td><p><span class="term">author</span></p></td> +<td>Julien Isorce <julien.isorce@collabora.co.uk></td> +</tr> +<tr> +<td><p><span class="term">class</span></p></td> +<td>Codec</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="id-1.2.132.7.3.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>application/x-rtp, clock-rate=(int)[ 1, 2147483647 ]</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> +<p> +</p> +</div> +<div class="refsect1"> +<a name="gst-plugins-good-plugins-rtprtxsend.functions_details"></a><h2>Functions</h2> +</div> +<div class="refsect1"> +<a name="gst-plugins-good-plugins-rtprtxsend.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GstRtpRtxSend-struct"></a><h3>struct GstRtpRtxSend</h3> +<pre class="programlisting">struct GstRtpRtxSend;</pre> +<p> +</p> +</div> +</div> +<div class="refsect1"> +<a name="gst-plugins-good-plugins-rtprtxsend.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GstRtpRtxSend--rtx-payload-type"></a><h3>The <code class="literal">“rtx-payload-type”</code> property</h3> +<pre class="programlisting"> “rtx-payload-type” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>Payload type of the retransmission stream (fmtp in SDP).</p> +<p>Flags: Read / Write</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2"> +<a name="GstRtpRtxSend--max-size-time"></a><h3>The <code class="literal">“max-size-time”</code> property</h3> +<pre class="programlisting"> “max-size-time” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>Amount of ms to queue (0 = unlimited).</p> +<p>Flags: Read / Write</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2"> +<a name="GstRtpRtxSend--max-size-packets"></a><h3>The <code class="literal">“max-size-packets”</code> property</h3> +<pre class="programlisting"> “max-size-packets” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>Amount of packets to queue (0 = unlimited).</p> +<p>Flags: Read / Write</p> +<p>Allowed values: <= 32767</p> +<p>Default value: 100</p> +</div> +<hr> +<div class="refsect2"> +<a name="GstRtpRtxSend--num-rtx-requests"></a><h3>The <code class="literal">“num-rtx-requests”</code> property</h3> +<pre class="programlisting"> “num-rtx-requests” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>Number of retransmission events received.</p> +<p>Flags: Read</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2"> +<a name="GstRtpRtxSend--num-rtx-packets"></a><h3>The <code class="literal">“num-rtx-packets”</code> property</h3> +<pre class="programlisting"> “num-rtx-packets” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p> Number of retransmission packets sent.</p> +<p>Flags: Read</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2"> +<a name="GstRtpRtxSend--payload-type-map"></a><h3>The <code class="literal">“payload-type-map”</code> property</h3> +<pre class="programlisting"> “payload-type-map” <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstStructure.html"><span class="type">GstStructure</span></a> *</pre> +<p>Map of original payload types to their retransmission payload types.</p> +<p>Flags: Read / Write</p> +</div> +<hr> +<div class="refsect2"> +<a name="GstRtpRtxSend--ssrc-map"></a><h3>The <code class="literal">“ssrc-map”</code> property</h3> +<pre class="programlisting"> “ssrc-map” <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstStructure.html"><span class="type">GstStructure</span></a> *</pre> +<p>Map of SSRCs to their retransmission SSRCs for SSRC-multiplexed mode (default = random).</p> +<p>Flags: Write</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.21</div> +</body> +</html>
\ No newline at end of file |