• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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>rtpredenc: GStreamer Good Plugins 1.0 Plugins Reference Manual</title>
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="index.html" title="GStreamer Good Plugins 1.0 Plugins Reference Manual">
8<link rel="up" href="ch01.html" title="gst-plugins-good Elements">
9<link rel="prev" href="gst-plugins-good-plugins-rtpreddec.html" title="rtpreddec">
10<link rel="next" href="gst-plugins-good-plugins-rtprtxqueue.html" title="rtprtxqueue">
11<meta name="generator" content="GTK-Doc V1.28 (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="5"><tr valign="middle">
16<td width="100%" align="left" class="shortcuts">
17<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span18                  <a href="#gst-plugins-good-plugins-rtpredenc.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span19                  <a href="#gst-plugins-good-plugins-rtpredenc.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span20                  <a href="#gst-plugins-good-plugins-rtpredenc.properties" class="shortcut">Properties</a></span>
21</td>
22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24<td><a accesskey="p" href="gst-plugins-good-plugins-rtpreddec.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25<td><a accesskey="n" href="gst-plugins-good-plugins-rtprtxqueue.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26</tr></table>
27<div class="refentry">
28<a name="gst-plugins-good-plugins-rtpredenc"></a><div class="titlepage"></div>
29<div class="refnamediv"><table width="100%"><tr>
30<td valign="top">
31<h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-rtpredenc.top_of_page"></a>rtpredenc</span></h2>
32<p>rtpredenc — RTP Redundant Audio Data (RED) encoder</p>
33</td>
34<td class="gallery_image" valign="top" align="right"></td>
35</tr></table></div>
36<div class="refsect1">
37<a name="gst-plugins-good-plugins-rtpredenc.properties"></a><h2>Properties</h2>
38<div class="informaltable"><table class="informaltable" border="0">
39<colgroup>
40<col width="150px" class="properties_type">
41<col width="300px" class="properties_name">
42<col width="200px" class="properties_flags">
43</colgroup>
44<tbody>
45<tr>
46<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
47<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtpredenc.html#GstRtpRedEnc--allow-no-red-blocks" title="The “allow-no-red-blocks” property">allow-no-red-blocks</a></td>
48<td class="property_flags">Read / Write</td>
49</tr>
50<tr>
51<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
52<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtpredenc.html#GstRtpRedEnc--distance" title="The “distance” property">distance</a></td>
53<td class="property_flags">Read / Write</td>
54</tr>
55<tr>
56<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
57<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtpredenc.html#GstRtpRedEnc--pt" title="The “pt” property">pt</a></td>
58<td class="property_flags">Read / Write</td>
59</tr>
60<tr>
61<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
62<td class="property_name"><a class="link" href="gst-plugins-good-plugins-rtpredenc.html#GstRtpRedEnc--sent" title="The “sent” property">sent</a></td>
63<td class="property_flags">Read</td>
64</tr>
65</tbody>
66</table></div>
67</div>
68<a name="GstRtpRedEnc"></a><div class="refsect1">
69<a name="gst-plugins-good-plugins-rtpredenc.other"></a><h2>Types and Values</h2>
70<div class="informaltable"><table class="informaltable" width="100%" border="0">
71<colgroup>
72<col width="150px" class="name">
73<col class="description">
74</colgroup>
75<tbody><tr>
76<td class="datatype_keyword">struct</td>
77<td class="function_name"><a class="link" href="gst-plugins-good-plugins-rtpredenc.html#GstRtpRedEnc-struct" title="struct GstRtpRedEnc">GstRtpRedEnc</a></td>
78</tr></tbody>
79</table></div>
80</div>
81<div class="refsect1">
82<a name="gst-plugins-good-plugins-rtpredenc.object-hierarchy"></a><h2>Object Hierarchy</h2>
83<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
84    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
85        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
86            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
87                <span class="lineart">╰──</span> GstRtpRedEnc
88</pre>
89</div>
90<div class="refsect1">
91<a name="gst-plugins-good-plugins-rtpredenc.description"></a><h2>Description</h2>
92<p>Encode Redundant Audio Data (RED) as per RFC 2198.</p>
93<p>This element is mostly provided for chrome webrtc compatibility:
94chrome expects protection packets generated by <a class="link" href="gst-plugins-good-plugins-rtpulpfecenc.html#GstRtpUlpFecEnc"><span class="type">GstRtpUlpFecEnc</span></a>
95to be wrapped in RED packets for backward compatibility purposes,
96but does not actually make use of the redundant packets that could
97be encoded with this element.</p>
98<p>As such, when used for that purpose, only the <a class="link" href="gst-plugins-good-plugins-rtpredenc.html#GstRtpRedEnc--pt" title="The “pt” property"><span class="type">“pt”</span></a> property
99should be set to a payload type different from both the protected and
100protection packets' payload types.</p>
101<p>When using <a class="link" href="gst-plugins-good-plugins-rtpbin.html#GstRtpBin"><span class="type">GstRtpBin</span></a>, this element should be inserted through the
102<a class="link" href="gst-plugins-good-plugins-rtpbin.html#GstRtpBin-request-fec-encoder" title="The “request-fec-encoder” signal"><span class="type">“request-fec-encoder”</span></a> signal.</p>
103<div class="refsect2">
104<a name="id-1.2.209.7.6"></a><h3>Example pipeline</h3>
105<div class="informalexample">
106  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
107    <tbody>
108      <tr>
109        <td class="listing_lines" align="right"><pre>1</pre></td>
110        <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> videotestsrc <span class="gtkdoc opt">!</span> x264enc <span class="gtkdoc opt">!</span> video<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>h264<span class="gtkdoc opt">,</span> profile<span class="gtkdoc opt">=</span>baseline <span class="gtkdoc opt">!</span> rtph264pay pt<span class="gtkdoc opt">=</span><span class="number">96</span> <span class="gtkdoc opt">!</span> rtpulpfecenc percentage<span class="gtkdoc opt">=</span><span class="number">100</span> pt<span class="gtkdoc opt">=</span><span class="number">122</span> <span class="gtkdoc opt">!</span> rtpredenc pt<span class="gtkdoc opt">=</span><span class="number">122</span> distance<span class="gtkdoc opt">=</span><span class="number">2</span> <span class="gtkdoc opt">!</span> identity drop<span class="gtkdoc opt">-</span>probability<span class="gtkdoc opt">=</span><span class="number">0.05</span> <span class="gtkdoc opt">!</span> udpsink port<span class="gtkdoc opt">=</span><span class="number">8888</span></pre></td>
111      </tr>
112    </tbody>
113  </table>
114</div>
115 This example will send a stream with RED and ULP FEC.
116</div>
117<p>See also: <a class="link" href="gst-plugins-good-plugins-rtpreddec.html#GstRtpRedDec"><span class="type">GstRtpRedDec</span></a>, <span class="type">GstWebRTCBin</span>, <a class="link" href="gst-plugins-good-plugins-rtpbin.html#GstRtpBin"><span class="type">GstRtpBin</span></a></p>
118<div class="refsynopsisdiv">
119<h2>Synopsis</h2>
120<div class="refsect2">
121<a name="id-1.2.209.7.8.1"></a><h3>Element Information</h3>
122<div class="variablelist"><table border="0" class="variablelist">
123<colgroup>
124<col align="left" valign="top">
125<col>
126</colgroup>
127<tbody>
128<tr>
129<td><p><span class="term">plugin</span></p></td>
130<td>
131            <a class="link" href="gst-plugins-good-plugins-plugin-rtp.html#plugin-rtp">rtp</a>
132          </td>
133</tr>
134<tr>
135<td><p><span class="term">author</span></p></td>
136<td>Hani Mustafa &lt;hani@pexip.com&gt;, Mikhail Fludkov &lt;misha@pexip.com&gt;</td>
137</tr>
138<tr>
139<td><p><span class="term">class</span></p></td>
140<td>Codec/Payloader/Network/RTP</td>
141</tr>
142</tbody>
143</table></div>
144</div>
145<hr>
146<div class="refsect2">
147<a name="id-1.2.209.7.8.2"></a><h3>Element Pads</h3>
148<div class="variablelist"><table border="0" class="variablelist">
149<colgroup>
150<col align="left" valign="top">
151<col>
152</colgroup>
153<tbody>
154<tr>
155<td><p><span class="term">name</span></p></td>
156<td>sink</td>
157</tr>
158<tr>
159<td><p><span class="term">direction</span></p></td>
160<td>sink</td>
161</tr>
162<tr>
163<td><p><span class="term">presence</span></p></td>
164<td>always</td>
165</tr>
166<tr>
167<td><p><span class="term">details</span></p></td>
168<td>application/x-rtp</td>
169</tr>
170</tbody>
171</table></div>
172<div class="variablelist"><table border="0" class="variablelist">
173<colgroup>
174<col align="left" valign="top">
175<col>
176</colgroup>
177<tbody>
178<tr>
179<td><p><span class="term">name</span></p></td>
180<td>src</td>
181</tr>
182<tr>
183<td><p><span class="term">direction</span></p></td>
184<td>source</td>
185</tr>
186<tr>
187<td><p><span class="term">presence</span></p></td>
188<td>always</td>
189</tr>
190<tr>
191<td><p><span class="term">details</span></p></td>
192<td>application/x-rtp</td>
193</tr>
194</tbody>
195</table></div>
196</div>
197</div>
198</div>
199<div class="refsect1">
200<a name="gst-plugins-good-plugins-rtpredenc.functions_details"></a><h2>Functions</h2>
201<p></p>
202</div>
203<div class="refsect1">
204<a name="gst-plugins-good-plugins-rtpredenc.other_details"></a><h2>Types and Values</h2>
205<div class="refsect2">
206<a name="GstRtpRedEnc-struct"></a><h3>struct GstRtpRedEnc</h3>
207<pre class="programlisting">struct GstRtpRedEnc;</pre>
208</div>
209</div>
210<div class="refsect1">
211<a name="gst-plugins-good-plugins-rtpredenc.property-details"></a><h2>Property Details</h2>
212<div class="refsect2">
213<a name="GstRtpRedEnc--allow-no-red-blocks"></a><h3>The <code class="literal">“allow-no-red-blocks”</code> property</h3>
214<pre class="programlisting">  “allow-no-red-blocks”      <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
215<p>true - can produce RED packets even without redundant blocks (distance==0) false - RED packets will be produced only if distance&gt;0.</p>
216<p>Flags: Read / Write</p>
217<p>Default value: TRUE</p>
218</div>
219<hr>
220<div class="refsect2">
221<a name="GstRtpRedEnc--distance"></a><h3>The <code class="literal">“distance”</code> property</h3>
222<pre class="programlisting">  “distance”                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
223<p>Tells which media packet to use as a redundant block (0 - no redundant blocks, 1 to use previous packet, 2 to use the packet before previous, etc.).</p>
224<p>Flags: Read / Write</p>
225<p>Default value: 0</p>
226</div>
227<hr>
228<div class="refsect2">
229<a name="GstRtpRedEnc--pt"></a><h3>The <code class="literal">“pt”</code> property</h3>
230<pre class="programlisting">  “pt”                       <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
231<p>Payload type FEC packets (-1 disable).</p>
232<p>Flags: Read / Write</p>
233<p>Allowed values: [0,127]</p>
234<p>Default value: 0</p>
235</div>
236<hr>
237<div class="refsect2">
238<a name="GstRtpRedEnc--sent"></a><h3>The <code class="literal">“sent”</code> property</h3>
239<pre class="programlisting">  “sent”                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
240<p>Count of sent packets.</p>
241<p>Flags: Read</p>
242<p>Default value: 0</p>
243</div>
244</div>
245</div>
246<div class="footer">
247<hr>Generated by GTK-Doc V1.28</div>
248</body>
249</html>