libortp-dev 3.3.2-4.1ubuntu1 / usr / share / doc / libortp8-dev / html / ortp_8h.html

This file is indexed.

/usr/share/doc/libortp8-dev/html/ortp_8h.html is in libortp-dev 3.3.2-4.1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>oRTP: include/ortp/ortp.h File Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />



</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">oRTP
   &#160;<span id="projectnumber">0.16.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#define-members">Defines</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">include/ortp/ortp.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>General purpose library functions.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="rtpsession_8h_source.html">ortp/rtpsession.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="sessionset_8h_source.html">ortp/sessionset.h</a>&quot;</code><br/>
</div>
<p><a href="ortp_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1a233a1f9c4efa4476b25d6829551e5e"></a><!-- doxytag: member="ortp.h::ortp_log_level_enabled" ref="a1a233a1f9c4efa4476b25d6829551e5e" args="(level)" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><b>ortp_log_level_enabled</b>(level)&#160;&#160;&#160;(__ortp_log_mask &amp; (level))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><b>ortp_logv</b>(level, fmt, args)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38c6b17390bcc5c146b0b33d9326875d"></a><!-- doxytag: member="ortp.h::ortp_debug" ref="a38c6b17390bcc5c146b0b33d9326875d" args="(...)" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><b>ortp_debug</b>(...)</td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6fadafbc3fc1ee34f2fa50286e911a65"></a><!-- doxytag: member="ortp.h::OrtpLogFunc" ref="a6fadafbc3fc1ee34f2fa50286e911a65" args=")(OrtpLogLevel lev, const char *fmt, va_list args)" -->
typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><b>OrtpLogFunc</b> )(OrtpLogLevel lev, const char *fmt, va_list args)</td></tr>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><b>OrtpLogLevel</b> { <br/>
&#160;&#160;<b>ORTP_DEBUG</b> = 1, 
<b>ORTP_MESSAGE</b> = 1&lt;&lt;1, 
<b>ORTP_WARNING</b> = 1&lt;&lt;2, 
<b>ORTP_ERROR</b> = 1&lt;&lt;3, 
<br/>
&#160;&#160;<b>ORTP_FATAL</b> = 1&lt;&lt;4, 
<b>ORTP_LOGLEV_END</b> = 1&lt;&lt;5
<br/>
 }</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ortp_8h.html#aa04f26740f760e228c4443fbfdd4f5ea">ortp_min_version_required</a> (int major, int minor, int micro)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ortp_8h.html#ab415c0a8f20298e82e76dcea13a745b5">ortp_init</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ortp_8h.html#a5e141585e75d0b7fca43797088f2b04e">ortp_scheduler_init</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ortp_8h.html#abb4e3cb949ec64f2ff4a50c093d86852">ortp_exit</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ortp_8h.html#a66ad4c89d7ec7b9416b11185681afd40">ortp_set_log_file</a> (FILE *file)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ortp_8h.html#a7301354f577d0e414cb7bdc2cfa96dc8">ortp_set_log_handler</a> (OrtpLogFunc func)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ortp_8h.html#a5ae5adf0581a5cea83a7f72979f8c99d">ortp_set_log_level_mask</a> (int levelmask)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65efb3c4d9efc26f0b8e76723814e52f"></a><!-- doxytag: member="ortp.h::ortp_global_stats_reset" ref="a65efb3c4d9efc26f0b8e76723814e52f" args="(void)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>ortp_global_stats_reset</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad85430e4ac2d58bed0161c8085e16ee3"></a><!-- doxytag: member="ortp.h::ortp_get_global_stats" ref="ad85430e4ac2d58bed0161c8085e16ee3" args="(void)" -->
<a class="el" href="structrtp__stats.html">rtp_stats_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>ortp_get_global_stats</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ortp_8h.html#ad2233a20047fbd0912caad6dc2e1291e">ortp_global_stats_display</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ortp_8h.html#ad4b2b584a56ce6251ba3b6cf9df02c3e">rtp_stats_display</a> (const <a class="el" href="structrtp__stats.html">rtp_stats_t</a> *stats, const char *header)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9840903a5632f77514f0e12af04f3abf"></a><!-- doxytag: member="ortp.h::rtp_stats_reset" ref="a9840903a5632f77514f0e12af04f3abf" args="(rtp_stats_t *stats)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>rtp_stats_reset</b> (<a class="el" href="structrtp__stats.html">rtp_stats_t</a> *stats)</td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a338ee7edf9d081ac370c39d7c7db4077"></a><!-- doxytag: member="ortp.h::ortp_logv_out" ref="a338ee7edf9d081ac370c39d7c7db4077" args="" -->
VAR_DECLSPEC OrtpLogFunc&#160;</td><td class="memItemRight" valign="bottom"><b>ortp_logv_out</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add47ca30e43c5f87ba60901104281d76"></a><!-- doxytag: member="ortp.h::__ortp_log_mask" ref="add47ca30e43c5f87ba60901104281d76" args="" -->
unsigned int&#160;</td><td class="memItemRight" valign="bottom"><b>__ortp_log_mask</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af34bbd80494df1ad8c62d2a79fcf8190"></a><!-- doxytag: member="ortp.h::ortp_global_stats" ref="af34bbd80494df1ad8c62d2a79fcf8190" args="" -->
<a class="el" href="structrtp__stats.html">rtp_stats_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>ortp_global_stats</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>General purpose library functions. </p>
</div><hr/><h2>Define Documentation</h2>
<a class="anchor" id="a504f7e404e099905bca5498b88ee5f5c"></a><!-- doxytag: member="ortp.h::ortp_logv" ref="a504f7e404e099905bca5498b88ee5f5c" args="(level, fmt, args)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define ortp_logv</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">level, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">fmt, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">args&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">{\
        if (ortp_logv_out!=NULL &amp;&amp; ortp_log_level_enabled(level)) \
                ortp_logv_out(level,fmt,args);\
        if ((level)==ORTP_FATAL) abort();\
}while(0)
</pre></div>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="abb4e3cb949ec64f2ff4a50c093d86852"></a><!-- doxytag: member="ortp.h::ortp_exit" ref="abb4e3cb949ec64f2ff4a50c093d86852" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="ortp_8h.html#abb4e3cb949ec64f2ff4a50c093d86852">ortp_exit</a> </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Gracefully uninitialize the library, including shutdowning the scheduler if it was started. </p>

</div>
</div>
<a class="anchor" id="ad2233a20047fbd0912caad6dc2e1291e"></a><!-- doxytag: member="ortp.h::ortp_global_stats_display" ref="ad2233a20047fbd0912caad6dc2e1291e" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="ortp_8h.html#ad2233a20047fbd0912caad6dc2e1291e">ortp_global_stats_display</a> </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Display global statistics (cumulative for all RtpSession) </p>

</div>
</div>
<a class="anchor" id="ab415c0a8f20298e82e76dcea13a745b5"></a><!-- doxytag: member="ortp.h::ortp_init" ref="ab415c0a8f20298e82e76dcea13a745b5" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="ortp_8h.html#ab415c0a8f20298e82e76dcea13a745b5">ortp_init</a> </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Initialize the oRTP library. You should call this function first before using oRTP API. </p>

</div>
</div>
<a class="anchor" id="aa04f26740f760e228c4443fbfdd4f5ea"></a><!-- doxytag: member="ortp.h::ortp_min_version_required" ref="aa04f26740f760e228c4443fbfdd4f5ea" args="(int major, int minor, int micro)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool_t <a class="el" href="ortp_8h.html#aa04f26740f760e228c4443fbfdd4f5ea">ortp_min_version_required</a> </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>major</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>minor</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>micro</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>This function give the opportunity to programs to check if the libortp they link to has the minimum version number they need.</p>
<p>Returns: true if ortp has a version number greater or equal than the required one. </p>

</div>
</div>
<a class="anchor" id="a5e141585e75d0b7fca43797088f2b04e"></a><!-- doxytag: member="ortp.h::ortp_scheduler_init" ref="a5e141585e75d0b7fca43797088f2b04e" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="ortp_8h.html#a5e141585e75d0b7fca43797088f2b04e">ortp_scheduler_init</a> </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Initialize the oRTP scheduler. You only have to do that if you intend to use the scheduled mode of the #RtpSession in your application. </p>

</div>
</div>
<a class="anchor" id="a66ad4c89d7ec7b9416b11185681afd40"></a><!-- doxytag: member="ortp.h::ortp_set_log_file" ref="a66ad4c89d7ec7b9416b11185681afd40" args="(FILE *file)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="ortp_8h.html#a66ad4c89d7ec7b9416b11185681afd40">ortp_set_log_file</a> </td>
          <td>(</td>
          <td class="paramtype">FILE *&#160;</td>
          <td class="paramname"><em>file</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">file</td><td>a FILE pointer where to output the ortp logs. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a7301354f577d0e414cb7bdc2cfa96dc8"></a><!-- doxytag: member="ortp.h::ortp_set_log_handler" ref="a7301354f577d0e414cb7bdc2cfa96dc8" args="(OrtpLogFunc func)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="ortp_8h.html#a7301354f577d0e414cb7bdc2cfa96dc8">ortp_set_log_handler</a> </td>
          <td>(</td>
          <td class="paramtype">OrtpLogFunc&#160;</td>
          <td class="paramname"><em>func</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">func,:</td><td>your logging function, compatible with the OrtpLogFunc prototype. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a5ae5adf0581a5cea83a7f72979f8c99d"></a><!-- doxytag: member="ortp.h::ortp_set_log_level_mask" ref="a5ae5adf0581a5cea83a7f72979f8c99d" args="(int levelmask)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="ortp_8h.html#a5ae5adf0581a5cea83a7f72979f8c99d">ortp_set_log_level_mask</a> </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>levelmask</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>@ param levelmask a mask of ORTP_DEBUG, ORTP_MESSAGE, ORTP_WARNING, ORTP_ERROR ORTP_FATAL . </p>

</div>
</div>
<a class="anchor" id="ad4b2b584a56ce6251ba3b6cf9df02c3e"></a><!-- doxytag: member="ortp.h::rtp_stats_display" ref="ad4b2b584a56ce6251ba3b6cf9df02c3e" args="(const rtp_stats_t *stats, const char *header)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="ortp_8h.html#ad4b2b584a56ce6251ba3b6cf9df02c3e">rtp_stats_display</a> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structrtp__stats.html">rtp_stats_t</a> *&#160;</td>
          <td class="paramname"><em>stats</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>header</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Print RTP statistics. </p>

</div>
</div>
</div><!-- contents -->


<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 9 2012 18:31:57 for oRTP by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>

APT Browse - Built by Thomas Orozco.