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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
|
<HTML>
<HEAD>
<TITLE>class RTPSession</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>class RTPSession</h1>
</TD>
<TD valign="top" align="right" colspan="1">Full RTP session. <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH>Full name</TH><TD><code><A HREF="TelEngine.html">TelEngine</A>::RTPSession</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="libs___yrtp___yatertp_h.html">libs/yrtp/yatertp.h</A>></code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="TelEngine__UDPSession.html">TelEngine::UDPSession</A> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__RTPSession.html">List of all Methods</A></TH></TR>
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Types</h4><ul><LI>enum <A HREF="#ref1">Direction</A> { FullStop = 0,
RecvOnly = 1,
SendOnly = 2,
SendRecv = 3
}
</LI>
</ul><h4>Public Methods</h4><ul><LI> <b><A HREF="#ref2">RTPSession</A></b> ()
</LI>
<LI>virtual <b><A HREF="#ref3">~RTPSession</A></b> ()
</LI>
<LI>virtual void <b><A HREF="#ref4">getStats</A></b> (String& stats) const
</LI>
<LI>virtual void <b><A HREF="#ref5">rtpData</A></b> (const void* data, int len)
</LI>
<LI>virtual void <b><A HREF="#ref6">rtcpData</A></b> (const void* data, int len)
</LI>
<LI>virtual bool <b><A HREF="#ref7">rtpRecvData</A></b> (bool marker, unsigned int timestamp,
const void* data, int len)
</LI>
<LI>virtual bool <b><A HREF="#ref8">rtpRecvEvent</A></b> (int event, char key, int duration,
int volume, unsigned int timestamp)
</LI>
<LI>virtual void <b><A HREF="#ref9">rtpNewPayload</A></b> (int payload, unsigned int timestamp)
</LI>
<LI>virtual void <b><A HREF="#ref10">rtpNewSSRC</A></b> (<A HREF="#u_int32_t">u_int32_t</A> newSsrc, bool marker)
</LI>
<LI>virtual RTPSender* <b><A HREF="#ref11">createSender</A></b> ()
</LI>
<LI>virtual RTPReceiver* <b><A HREF="#ref12">createReceiver</A></b> ()
</LI>
<LI>virtual Cipher* <b><A HREF="#ref13">createCipher</A></b> (const String& name, Cipher::Direction dir)
</LI>
<LI>virtual bool <b><A HREF="#ref14">checkCipher</A></b> (const String& name)
</LI>
<LI>inline bool <b><A HREF="#ref15">rtpSend</A></b> (bool marker, int payload, unsigned int timestamp,
const void* data, int len)
</LI>
<LI>inline bool <b><A HREF="#ref16">rtpSendData</A></b> (bool marker, unsigned int timestamp,
const void* data, int len)
</LI>
<LI>inline bool <b><A HREF="#ref17">rtpSendEvent</A></b> (int event, int duration, int volume = 0, unsigned int timestamp = 0)
</LI>
<LI>inline bool <b><A HREF="#ref18">rtpSendKey</A></b> (char key, int duration, int volume = 0, unsigned int timestamp = 0)
</LI>
<LI>inline int <b><A HREF="#ref19">padding</A></b> () const
</LI>
<LI>inline bool <b><A HREF="#ref20">padding</A></b> (int chunk)
</LI>
<LI>inline void <b><A HREF="#ref21">setDejitter</A></b> (unsigned int mindelay = 20, unsigned int maxdelay = 50)
</LI>
<LI>virtual void <b><A HREF="#ref22">transport</A></b> (RTPTransport* trans)
</LI>
<LI>inline RTPSender* <b><A HREF="#ref23">sender</A></b> () const
</LI>
<LI>void <b><A HREF="#ref24">sender</A></b> (RTPSender* send)
</LI>
<LI>inline RTPReceiver* <b><A HREF="#ref25">receiver</A></b> () const
</LI>
<LI>void <b><A HREF="#ref26">receiver</A></b> (RTPReceiver* recv)
</LI>
<LI>inline Direction <b><A HREF="#ref27">direction</A></b> () const
</LI>
<LI>bool <b><A HREF="#ref28">direction</A></b> (Direction dir)
</LI>
<LI>inline bool <b><A HREF="#ref29">addDirection</A></b> (Direction dir)
</LI>
<LI>inline bool <b><A HREF="#ref30">delDirection</A></b> (Direction dir)
</LI>
<LI>bool <b><A HREF="#ref31">dataPayload</A></b> (int type)
</LI>
<LI>bool <b><A HREF="#ref32">eventPayload</A></b> (int type)
</LI>
<LI>bool <b><A HREF="#ref33">silencePayload</A></b> (int type)
</LI>
<LI>inline bool <b><A HREF="#ref34">localAddr</A></b> (SocketAddr& addr, bool rtcp = true)
</LI>
<LI>inline RTPSecure* <b><A HREF="#ref35">security</A></b> () const
</LI>
<LI>void <b><A HREF="#ref36">security</A></b> (RTPSecure* secure)
</LI>
</ul><h4>Protected Methods</h4><ul><LI>virtual void <b><A HREF="#ref37">timerTick</A></b> (const Time& when)
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
An unidirectional or bidirectional RTP session
</p>
<A NAME="Direction"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td>enum <strong>Direction</strong> { FullStop = 0,
RecvOnly = 1,
SendOnly = 2,
SendRecv = 3
}
</td><td align="right"><h3><strong>Direction</strong></h3></td></tr></table><p></p><p>
Direction of the session
</p>
<A NAME="RTPSession"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>RTPSession</strong> ()
<br></td><td align="right"><h3><strong>RTPSession</strong></h3></td></tr></table><p></p><p>
Default constructor, creates a detached session
</p>
<A NAME="~RTPSession"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~RTPSession</strong> ()
<br></td><td align="right"><h3><strong>~RTPSession</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destructor - shuts down the session and destroys the transport
</p>
<A NAME="getStats"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>getStats</strong> (String& stats)
<br></td><td align="right"><h3><strong>getStats</strong></h3></td></tr></table><p> <small>[const virtual]</small></p><p>
Retrieve MGCP P: style comma separated session parameters
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>stats</i></TD><TD align="left" valign="top">String to append parameters to
</TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__RTPProcessor.html#getStats">RTPProcessor</A>.</p>
<A NAME="rtpData"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>rtpData</strong> (const void* data, int len)
<br></td><td align="right"><h3><strong>rtpData</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
This method is called to process a RTP packet.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Pointer to raw RTP data
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">Length of the data packet
</TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__RTPProcessor.html#rtpData">RTPProcessor</A>.</p>
<A NAME="rtcpData"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>rtcpData</strong> (const void* data, int len)
<br></td><td align="right"><h3><strong>rtcpData</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
This method is called to process a RTCP packet.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Pointer to raw RTCP data
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">Length of the data packet
</TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__RTPProcessor.html#rtcpData">RTPProcessor</A>.</p>
<A NAME="rtpRecvData"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>rtpRecvData</strong> (bool marker, unsigned int timestamp,
const void* data, int len)
<br></td><td align="right"><h3><strong>rtpRecvData</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Process one RTP data packet
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>marker</i></TD><TD align="left" valign="top">Set to true if the marker bit is set
</TD></TR>
<TR><TD align="left" valign="top"><i>timestamp</i></TD><TD align="left" valign="top">Sampling instant of the packet data
</TD></TR>
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Pointer to data block to process
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">Length of the data block in bytes
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if data was handled
</p>
<A NAME="rtpRecvEvent"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>rtpRecvEvent</strong> (int event, char key, int duration,
int volume, unsigned int timestamp)
<br></td><td align="right"><h3><strong>rtpRecvEvent</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Process one RTP event
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>event</i></TD><TD align="left" valign="top">Received event code
</TD></TR>
<TR><TD align="left" valign="top"><i>key</i></TD><TD align="left" valign="top">Received key (for events 0-16) or zero
</TD></TR>
<TR><TD align="left" valign="top"><i>duration</i></TD><TD align="left" valign="top">Duration of the event as number of samples
</TD></TR>
<TR><TD align="left" valign="top"><i>volume</i></TD><TD align="left" valign="top">Attenuation of the tone, zero for don't care
</TD></TR>
<TR><TD align="left" valign="top"><i>timestamp</i></TD><TD align="left" valign="top">Sampling instant of the initial packet data
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if data was handled
</p>
<A NAME="rtpNewPayload"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>rtpNewPayload</strong> (int payload, unsigned int timestamp)
<br></td><td align="right"><h3><strong>rtpNewPayload</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Method called for unknown payload types just before attempting
to call rtpRecvData(). This is a good opportunity to change the
payload type and continue.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>payload</i></TD><TD align="left" valign="top">Payload number
</TD></TR>
<TR><TD align="left" valign="top"><i>timestamp</i></TD><TD align="left" valign="top">Sampling instant of the unexpected packet data
</TD></TR>
</TABLE></P>
<A NAME="rtpNewSSRC"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>rtpNewSSRC</strong> (<A HREF="#u_int32_t">u_int32_t</A> newSsrc, bool marker)
<br></td><td align="right"><h3><strong>rtpNewSSRC</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Method called when a packet with an unexpected SSRC is received
just before processing further. This is a good opportunity to
change the SSRC and continue
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>newSsrc</i></TD><TD align="left" valign="top">SSRC received in packet
</TD></TR>
<TR><TD align="left" valign="top"><i>marker</i></TD><TD align="left" valign="top">True if marker bit is set in the RTP packet
</TD></TR>
</TABLE></P>
<A NAME="createSender"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td> RTPSender* <strong>createSender</strong> ()
<br></td><td align="right"><h3><strong>createSender</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Create a new RTP sender for this session.
Override this method to create objects derived from RTPSender.
</p>
<p><b>Returns</b>: Pointer to the new sender or NULL on failure
</p>
<A NAME="createReceiver"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td> RTPReceiver* <strong>createReceiver</strong> ()
<br></td><td align="right"><h3><strong>createReceiver</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Create a new RTP receiver for this session.
Override this method to create objects derived from RTPReceiver.
</p>
<p><b>Returns</b>: Pointer to the new receiver or NULL on failure
</p>
<A NAME="createCipher"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td> Cipher* <strong>createCipher</strong> (const String& name, Cipher::Direction dir)
<br></td><td align="right"><h3><strong>createCipher</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Create a cipher when required for SRTP
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">Name of the cipher to create
</TD></TR>
<TR><TD align="left" valign="top"><i>dir</i></TD><TD align="left" valign="top">Direction the cipher must be able to handle
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Pointer to newly allocated Cipher or NULL
</p>
<A NAME="checkCipher"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>checkCipher</strong> (const String& name)
<br></td><td align="right"><h3><strong>checkCipher</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Check if a cipher is supported for SRTP
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">Name of the cipher to check
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the specified cipher is supported
</p>
<A NAME="rtpSend"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>rtpSend</strong> (bool marker, int payload, unsigned int timestamp,
const void* data, int len)
<br></td><td align="right"><h3><strong>rtpSend</strong></h3></td></tr></table><p></p><p>
Send one RTP payload packet
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>marker</i></TD><TD align="left" valign="top">Set to true if the marker bit must be set
</TD></TR>
<TR><TD align="left" valign="top"><i>payload</i></TD><TD align="left" valign="top">Payload number
</TD></TR>
<TR><TD align="left" valign="top"><i>timestamp</i></TD><TD align="left" valign="top">Sampling instant of the packet data
</TD></TR>
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Pointer to data block to send
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">Length of the data block
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if data sending was attempted
</p>
<A NAME="rtpSendData"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>rtpSendData</strong> (bool marker, unsigned int timestamp,
const void* data, int len)
<br></td><td align="right"><h3><strong>rtpSendData</strong></h3></td></tr></table><p></p><p>
Send one RTP data packet
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>marker</i></TD><TD align="left" valign="top">Set to true if the marker bit must be set
</TD></TR>
<TR><TD align="left" valign="top"><i>timestamp</i></TD><TD align="left" valign="top">Sampling instant of the packet data
</TD></TR>
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Pointer to data block to send
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">Length of the data block
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if data sending was attempted
</p>
<A NAME="rtpSendEvent"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>rtpSendEvent</strong> (int event, int duration, int volume = 0, unsigned int timestamp = 0)
<br></td><td align="right"><h3><strong>rtpSendEvent</strong></h3></td></tr></table><p></p><p>
Send one RTP event
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>event</i></TD><TD align="left" valign="top">Event code to send
</TD></TR>
<TR><TD align="left" valign="top"><i>duration</i></TD><TD align="left" valign="top">Duration of the event as number of samples
</TD></TR>
<TR><TD align="left" valign="top"><i>volume</i></TD><TD align="left" valign="top">Attenuation of the tone, zero for don't care
</TD></TR>
<TR><TD align="left" valign="top"><i>timestamp</i></TD><TD align="left" valign="top">Sampling instant of the packet data, zero to use current
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if data sending was attempted
</p>
<A NAME="rtpSendKey"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>rtpSendKey</strong> (char key, int duration, int volume = 0, unsigned int timestamp = 0)
<br></td><td align="right"><h3><strong>rtpSendKey</strong></h3></td></tr></table><p></p><p>
Send one RTP key event
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>key</i></TD><TD align="left" valign="top">Key to send
</TD></TR>
<TR><TD align="left" valign="top"><i>duration</i></TD><TD align="left" valign="top">Duration of the event as number of samples
</TD></TR>
<TR><TD align="left" valign="top"><i>volume</i></TD><TD align="left" valign="top">Attenuation of the tone, zero for don't care
</TD></TR>
<TR><TD align="left" valign="top"><i>timestamp</i></TD><TD align="left" valign="top">Sampling instant of the packet data, zero to use current
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if data sending was attempted
</p>
<A NAME="padding"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline int <strong>padding</strong> ()
<br></td><td align="right"><h3><strong>padding</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the payload padding size
</p>
<p><b>Returns</b>: Chunk size to pad the payload to a multiple of
</p>
<A NAME="padding"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>padding</strong> (int chunk)
<br></td><td align="right"><h3><strong>padding</strong></h3></td></tr></table><p></p><p>
Set the padding to a multiple of a data chunk
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>chunk</i></TD><TD align="left" valign="top">Size to pad the payload to a multiple of
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the new chunk size is valid
</p>
<A NAME="setDejitter"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>setDejitter</strong> (unsigned int mindelay = 20, unsigned int maxdelay = 50)
<br></td><td align="right"><h3><strong>setDejitter</strong></h3></td></tr></table><p></p><p>
Allocate and set a new dejitter buffer for the receiver in the session
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>mindelay</i></TD><TD align="left" valign="top">Minimum length of the dejitter buffer in microseconds
</TD></TR>
<TR><TD align="left" valign="top"><i>maxdelay</i></TD><TD align="left" valign="top">Maximum length of the dejitter buffer in microseconds
</TD></TR>
</TABLE></P>
<A NAME="transport"></A><A NAME="ref22"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>transport</strong> (RTPTransport* trans)
<br></td><td align="right"><h3><strong>transport</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Set the RTP/RTCP transport of data handled by this session
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>trans</i></TD><TD align="left" valign="top">A pointer to the new RTPTransport for this session
</TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__UDPSession.html#transport">UDPSession</A>.</p>
<A NAME="sender"></A><A NAME="ref23"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline RTPSender* <strong>sender</strong> ()
<br></td><td align="right"><h3><strong>sender</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the RTP/RTCP sender of this session
</p>
<p><b>Returns</b>: A pointer to the RTPSender of this session
</p>
<A NAME="sender"></A><A NAME="ref24"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>sender</strong> (RTPSender* send)
<br></td><td align="right"><h3><strong>sender</strong></h3></td></tr></table><p></p><p>
Set the RTP/RTCP sender of this session
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>send</i></TD><TD align="left" valign="top">A pointer to the new RTPSender of this session or NULL
</TD></TR>
</TABLE></P>
<A NAME="receiver"></A><A NAME="ref25"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline RTPReceiver* <strong>receiver</strong> ()
<br></td><td align="right"><h3><strong>receiver</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the RTP/RTCP receiver of this session
</p>
<p><b>Returns</b>: A pointer to the RTPReceiver of this session
</p>
<A NAME="receiver"></A><A NAME="ref26"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>receiver</strong> (RTPReceiver* recv)
<br></td><td align="right"><h3><strong>receiver</strong></h3></td></tr></table><p></p><p>
Set the RTP/RTCP receiver of this session
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>recv</i></TD><TD align="left" valign="top">A pointer to the new RTPReceiver of this session or NULL
</TD></TR>
</TABLE></P>
<A NAME="direction"></A><A NAME="ref27"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline Direction <strong>direction</strong> ()
<br></td><td align="right"><h3><strong>direction</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the direction of this session
</p>
<p><b>Returns</b>: Session's direction as a Direction enum
</p>
<A NAME="direction"></A><A NAME="ref28"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>direction</strong> (Direction dir)
<br></td><td align="right"><h3><strong>direction</strong></h3></td></tr></table><p></p><p>
Set the direction of this session. A transport must exist for this
method to succeed.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>dir</i></TD><TD align="left" valign="top">New Direction for this session
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if direction was set, false if a failure occured
</p>
<A NAME="addDirection"></A><A NAME="ref29"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>addDirection</strong> (Direction dir)
<br></td><td align="right"><h3><strong>addDirection</strong></h3></td></tr></table><p></p><p>
Add a direction of this session. A transport must exist for this
method to succeed.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>dir</i></TD><TD align="left" valign="top">New Direction to add for this session
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if direction was set, false if a failure occured
</p>
<A NAME="delDirection"></A><A NAME="ref30"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>delDirection</strong> (Direction dir)
<br></td><td align="right"><h3><strong>delDirection</strong></h3></td></tr></table><p></p><p>
Delete a direction of this session. A transport must exist for this
method to succeed.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>dir</i></TD><TD align="left" valign="top">Direction to remove for this session
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if direction was set, false if a failure occured
</p>
<A NAME="dataPayload"></A><A NAME="ref31"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>dataPayload</strong> (int type)
<br></td><td align="right"><h3><strong>dataPayload</strong></h3></td></tr></table><p></p><p>
Set the data payload type for both receiver and sender.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">Payload type, -1 to disable
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if changed, false if invalid payload type
</p>
<A NAME="eventPayload"></A><A NAME="ref32"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>eventPayload</strong> (int type)
<br></td><td align="right"><h3><strong>eventPayload</strong></h3></td></tr></table><p></p><p>
Set the event payload type for both receiver and sender.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">Payload type, -1 to disable
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if changed, false if invalid payload type
</p>
<A NAME="silencePayload"></A><A NAME="ref33"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>silencePayload</strong> (int type)
<br></td><td align="right"><h3><strong>silencePayload</strong></h3></td></tr></table><p></p><p>
Set the silence payload type for both receiver and sender.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">Payload type, -1 to disable
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if changed, false if invalid payload type
</p>
<A NAME="localAddr"></A><A NAME="ref34"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>localAddr</strong> (SocketAddr& addr, bool rtcp = true)
<br></td><td align="right"><h3><strong>localAddr</strong></h3></td></tr></table><p></p><p>
Set the local network address of the RTP transport of this session
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>addr</i></TD><TD align="left" valign="top">New local RTP transport address
</TD></TR>
<TR><TD align="left" valign="top"><i>rtcp</i></TD><TD align="left" valign="top">Enable RTCP in this session
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if address set, false if a failure occured
</p>
<A NAME="security"></A><A NAME="ref35"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline RTPSecure* <strong>security</strong> ()
<br></td><td align="right"><h3><strong>security</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the stored security provider or of the sender
</p>
<p><b>Returns</b>: A pointer to the RTPSecure or NULL
</p>
<A NAME="security"></A><A NAME="ref36"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>security</strong> (RTPSecure* secure)
<br></td><td align="right"><h3><strong>security</strong></h3></td></tr></table><p></p><p>
Store a security provider for the sender
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>secure</i></TD><TD align="left" valign="top">Pointer to the new RTPSecure or NULL
</TD></TR>
</TABLE></P>
<A NAME="timerTick"></A><A NAME="ref37"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>timerTick</strong> (const Time& when)
<br></td><td align="right"><h3><strong>timerTick</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Method called periodically to push any asynchronous data or statistics
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>when</i></TD><TD align="left" valign="top">Time to use as base in all computing
</TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__RTPProcessor.html#timerTick">RTPProcessor</A>.</p>
<HR>
<table>
<tr><td><small>Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.</small></td></tr>
</table>
</BODY>
</HTML>
|
