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
|
<HTML>
<HEAD>
<TITLE>class SDPSession</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 SDPSession</h1>
</TD>
<TD valign="top" align="right" colspan="1">A holder for a SDP session. <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH colspan="2">Contains pure virtuals</TH></TR><TR><TH>Full name</TH><TD><code><A HREF="TelEngine.html">TelEngine</A>::SDPSession</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="libs___ysdp___yatesdp_h.html">libs/ysdp/yatesdp.h</A>></code></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__SDPSession.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"></A> { MediaMissing,
MediaStarted,
MediaMuted
}
</LI>
</ul><h4>Public Methods</h4><ul><LI> <b><A HREF="#ref2">SDPSession</A></b> (SDPParser* parser)
</LI>
<LI> <b><A HREF="#ref3">SDPSession</A></b> (SDPParser* parser, NamedList& params)
</LI>
<LI>virtual <b><A HREF="#ref4">~SDPSession</A></b> ()
</LI>
<LI>inline const String& <b><A HREF="#ref5">getHost</A></b> () const
</LI>
<LI>inline const String& <b><A HREF="#ref6">getRtpAddr</A></b> () const
</LI>
<LI>bool <b><A HREF="#ref7">setMedia</A></b> (ObjList* media)
</LI>
<LI>inline void <b><A HREF="#ref9">putMedia</A></b> (NamedList& msg, bool putPort = true)
</LI>
<LI>bool <b><A HREF="#ref10">dispatchRtp</A></b> (SDPMedia* media, const char* addr, bool start, bool pick, RefObject* context = 0)
</LI>
<LI>bool <b><A HREF="#ref11">dispatchRtp</A></b> (const char* addr, bool start, RefObject* context = 0)
</LI>
<LI>bool <b><A HREF="#ref12">startRtp</A></b> (RefObject* context = 0)
</LI>
<LI>bool <b><A HREF="#ref13">updateSDP</A></b> (const NamedList& params)
</LI>
<LI>bool <b><A HREF="#ref14">updateRtpSDP</A></b> (const NamedList& params)
</LI>
<LI>MimeSdpBody* <b><A HREF="#ref15">createSDP</A></b> (const char* addr, ObjList* mediaList = 0)
</LI>
<LI>MimeSdpBody* <b><A HREF="#ref16">createSDP</A></b> ()
</LI>
<LI>MimeSdpBody* <b><A HREF="#ref17">createPasstroughSDP</A></b> (NamedList& msg, bool update = true)
</LI>
<LI>inline MimeSdpBody* <b><A HREF="#ref18">createRtpSDP</A></b> (const char* addr, const NamedList& msg)
</LI>
<LI>inline MimeSdpBody* <b><A HREF="#ref19">createRtpSDP</A></b> (const char* addr, bool start)
</LI>
<LI>inline MimeSdpBody* <b><A HREF="#ref20">createRtpSDP</A></b> (bool start)
</LI>
<LI>void <b><A HREF="#ref21">updateFormats</A></b> (const NamedList& msg, bool changeMedia = false)
</LI>
<LI>bool <b><A HREF="#ref22">addSdpParams</A></b> (NamedList& msg, const MimeBody* body)
</LI>
<LI>bool <b><A HREF="#ref23">addSdpParams</A></b> (NamedList& msg, const String& rawSdp)
</LI>
<LI>bool <b><A HREF="#ref24">addRtpParams</A></b> (NamedList& msg, const String& natAddr = String::empty(),
const MimeBody* body = 0, bool force = false)
</LI>
<LI>virtual void <b><A HREF="#ref25">resetSdp</A></b> ()
</LI>
<LI>virtual Message* <b><A HREF="#ref26">buildChanRtp</A></b> (SDPMedia* media, const char* addr, bool start, RefObject* context)
</LI>
<LI>virtual Message* <b><i><A HREF="#ref27">buildChanRtp</A></i></b> (RefObject* context)
</LI>
<LI>bool <b><A HREF="#ref28">localRtpChanged</A></b> () const
</LI>
<LI>void <b><A HREF="#ref29">setLocalRtpChanged</A></b> (bool chg = false)
</LI>
</ul><h4>Public Static Methods</h4><ul><LI>static void <b><A HREF="#ref8">putMedia</A></b> (NamedList& msg, ObjList* media, bool putPort = true)
</LI>
<LI>static ObjList* <b><A HREF="#ref30">updateRtpSDP</A></b> (const NamedList& params, String& rtpAddr,
ObjList* oldList = 0)
</LI>
</ul><h4>Public Members</h4><ul><LI>SDPParser* <b><A HREF="#ref31">m_parser</A></b></LI>
<LI>int <b><A HREF="#ref32">m_mediaStatus</A></b></LI>
<LI>bool <b><A HREF="#ref33">m_rtpForward</A></b></LI>
<LI>bool <b><A HREF="#ref34">m_sdpForward</A></b></LI>
<LI>String <b><A HREF="#ref35">m_externalAddr</A></b></LI>
<LI>String <b><A HREF="#ref36">m_rtpAddr</A></b></LI>
<LI>String <b><A HREF="#ref37">m_rtpLocalAddr</A></b></LI>
<LI>ObjList* <b><A HREF="#ref38">m_rtpMedia</A></b></LI>
<LI>int <b><A HREF="#ref39">m_sdpSession</A></b></LI>
<LI>int <b><A HREF="#ref40">m_sdpVersion</A></b></LI>
<LI>String <b><A HREF="#ref41">m_host</A></b></LI>
<LI>bool <b><A HREF="#ref42">m_secure</A></b></LI>
<LI>bool <b><A HREF="#ref43">m_rfc2833</A></b></LI>
</ul><h4>Protected Methods</h4><ul><LI>virtual void <b><A HREF="#ref44">mediaChanged</A></b> (const SDPMedia& media)
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
This class holds RTP/SDP data for multiple media types
NOTE: The SDPParser pointer held by this class is assumed to be non NULL
</p>
<A NAME=""></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td>enum <strong></strong> { MediaMissing,
MediaStarted,
MediaMuted
}
</td><td align="right"><h3><strong></strong></h3></td></tr></table><p></p><p>
RTP media status enumeration
</p>
<A NAME="SDPSession"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>SDPSession</strong> (SDPParser* parser)
<br></td><td align="right"><h3><strong>SDPSession</strong></h3></td></tr></table><p></p><p>
Constructor
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>parser</i></TD><TD align="left" valign="top">The SDP parser whose data this object will use
</TD></TR>
</TABLE></P>
<A NAME="SDPSession"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>SDPSession</strong> (SDPParser* parser, NamedList& params)
<br></td><td align="right"><h3><strong>SDPSession</strong></h3></td></tr></table><p></p><p>
Constructor
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>parser</i></TD><TD align="left" valign="top">The SDP parser whose data this object will use
</TD></TR>
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">SDP session parameters
</TD></TR>
</TABLE></P>
<A NAME="~SDPSession"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~SDPSession</strong> ()
<br></td><td align="right"><h3><strong>~SDPSession</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destructor. Reset the object
</p>
<A NAME="getHost"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& <strong>getHost</strong> ()
<br></td><td align="right"><h3><strong>getHost</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get RTP local host
</p>
<p><b>Returns</b>: RTP local host
</p>
<A NAME="getRtpAddr"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& <strong>getRtpAddr</strong> ()
<br></td><td align="right"><h3><strong>getRtpAddr</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get local RTP address
</p>
<p><b>Returns</b>: Local RTP address (external or local)
</p>
<A NAME="setMedia"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>setMedia</strong> (ObjList* media)
<br></td><td align="right"><h3><strong>setMedia</strong></h3></td></tr></table><p></p><p>
Set a new media list
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>media</i></TD><TD align="left" valign="top">New media list
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if media changed
</p>
<A NAME="putMedia"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>putMedia</strong> (NamedList& msg, ObjList* media, bool putPort = true)
<br></td><td align="right"><h3><strong>putMedia</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Put specified media parameters into a list of parameters
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">Destination list
</TD></TR>
<TR><TD align="left" valign="top"><i>media</i></TD><TD align="left" valign="top">List of SDP media information
</TD></TR>
<TR><TD align="left" valign="top"><i>putPort</i></TD><TD align="left" valign="top">True to add the media port
</TD></TR>
</TABLE></P>
<A NAME="putMedia"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>putMedia</strong> (NamedList& msg, bool putPort = true)
<br></td><td align="right"><h3><strong>putMedia</strong></h3></td></tr></table><p></p><p>
Put session media parameters into a list of parameters
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">Destination list
</TD></TR>
<TR><TD align="left" valign="top"><i>putPort</i></TD><TD align="left" valign="top">True to add the media port
</TD></TR>
</TABLE></P>
<A NAME="dispatchRtp"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>dispatchRtp</strong> (SDPMedia* media, const char* addr, bool start, bool pick, RefObject* context = 0)
<br></td><td align="right"><h3><strong>dispatchRtp</strong></h3></td></tr></table><p></p><p>
Build and dispatch a chan.rtp message for a given media. Update media on success
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>media</i></TD><TD align="left" valign="top">The media to use
</TD></TR>
<TR><TD align="left" valign="top"><i>addr</i></TD><TD align="left" valign="top">Remote RTP address
</TD></TR>
<TR><TD align="left" valign="top"><i>start</i></TD><TD align="left" valign="top">True to request RTP start
</TD></TR>
<TR><TD align="left" valign="top"><i>pick</i></TD><TD align="left" valign="top">True to update local parameters (other then media) from returned message
</TD></TR>
<TR><TD align="left" valign="top"><i>context</i></TD><TD align="left" valign="top">Pointer to user provided context, optional
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the message was succesfully handled
</p>
<A NAME="dispatchRtp"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>dispatchRtp</strong> (const char* addr, bool start, RefObject* context = 0)
<br></td><td align="right"><h3><strong>dispatchRtp</strong></h3></td></tr></table><p></p><p>
Calls dispatchRtp() for each media in the list
Update it on success. Remove it on failure
</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">Remote RTP address
</TD></TR>
<TR><TD align="left" valign="top"><i>start</i></TD><TD align="left" valign="top">True to request RTP start
</TD></TR>
<TR><TD align="left" valign="top"><i>context</i></TD><TD align="left" valign="top">Pointer to user provided context, optional
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the message was succesfully handled for at least one media
</p>
<A NAME="startRtp"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>startRtp</strong> (RefObject* context = 0)
<br></td><td align="right"><h3><strong>startRtp</strong></h3></td></tr></table><p></p><p>
Try to start RTP (calls dispatchRtp()) for each media in the list
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>context</i></TD><TD align="left" valign="top">Pointer to user provided context, optional
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if at least one media was started
</p>
<A NAME="updateSDP"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>updateSDP</strong> (const NamedList& params)
<br></td><td align="right"><h3><strong>updateSDP</strong></h3></td></tr></table><p></p><p>
Update from parameters. Build a default SDP from parser formats if no media is found in params
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">List of parameters to update from
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if media changed
</p>
<A NAME="updateRtpSDP"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>updateRtpSDP</strong> (const NamedList& params)
<br></td><td align="right"><h3><strong>updateRtpSDP</strong></h3></td></tr></table><p></p><p>
Update RTP/SDP data from parameters
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">List of parameters to update from
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if media or local address changed
</p>
<A NAME="createSDP"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td>MimeSdpBody* <strong>createSDP</strong> (const char* addr, ObjList* mediaList = 0)
<br></td><td align="right"><h3><strong>createSDP</strong></h3></td></tr></table><p></p><p>
Creates a SDP body from transport address and list of media descriptors
</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">The address to set. Use own host if empty
</TD></TR>
<TR><TD align="left" valign="top"><i>mediaList</i></TD><TD align="left" valign="top">Optional media list. Use own list if the given one is 0
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: MimeSdpBody pointer or 0 if there is no media to set
</p>
<A NAME="createSDP"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td>MimeSdpBody* <strong>createSDP</strong> ()
<br></td><td align="right"><h3><strong>createSDP</strong></h3></td></tr></table><p></p><p>
Creates a SDP body for current media status
</p>
<p><b>Returns</b>: MimeSdpBody pointer or 0 if media is missing
</p>
<A NAME="createPasstroughSDP"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td>MimeSdpBody* <strong>createPasstroughSDP</strong> (NamedList& msg, bool update = true)
<br></td><td align="right"><h3><strong>createPasstroughSDP</strong></h3></td></tr></table><p></p><p>
Creates a SDP from RTP address data present in message.
Use the raw SDP if present.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">The list of parameters
</TD></TR>
<TR><TD align="left" valign="top"><i>update</i></TD><TD align="left" valign="top">True to update RTP/SDP data if raw SDP is not found in the list
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: MimeSdpBody pointer or 0
</p>
<A NAME="createRtpSDP"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline MimeSdpBody* <strong>createRtpSDP</strong> (const char* addr, const NamedList& msg)
<br></td><td align="right"><h3><strong>createRtpSDP</strong></h3></td></tr></table><p></p><p>
Creates a set of unstarted external RTP channels from remote addr and
builds SDP from them
</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">Remote RTP address used when dispatching the chan.rtp message
</TD></TR>
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">List of parameters used to update data
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: MimeSdpBody pointer or 0
</p>
<A NAME="createRtpSDP"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline MimeSdpBody* <strong>createRtpSDP</strong> (const char* addr, bool start)
<br></td><td align="right"><h3><strong>createRtpSDP</strong></h3></td></tr></table><p></p><p>
Creates a set of RTP channels from address and media info and builds SDP from them
</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">Remote RTP address used when dispatching the chan.rtp message
</TD></TR>
<TR><TD align="left" valign="top"><i>start</i></TD><TD align="left" valign="top">True to create a started RTP
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: MimeSdpBody pointer or 0
</p>
<A NAME="createRtpSDP"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline MimeSdpBody* <strong>createRtpSDP</strong> (bool start)
<br></td><td align="right"><h3><strong>createRtpSDP</strong></h3></td></tr></table><p></p><p>
Creates a set of started external RTP channels from remote addr and
builds SDP from them
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>start</i></TD><TD align="left" valign="top">True to create a started RTP
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: MimeSdpBody pointer or 0
</p>
<A NAME="updateFormats"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>updateFormats</strong> (const NamedList& msg, bool changeMedia = false)
<br></td><td align="right"><h3><strong>updateFormats</strong></h3></td></tr></table><p></p><p>
Update media format lists from parameters
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">Parameter list
</TD></TR>
<TR><TD align="left" valign="top"><i>changeMedia</i></TD><TD align="left" valign="top">True to update media list if required
</TD></TR>
</TABLE></P>
<A NAME="addSdpParams"></A><A NAME="ref22"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>addSdpParams</strong> (NamedList& msg, const MimeBody* body)
<br></td><td align="right"><h3><strong>addSdpParams</strong></h3></td></tr></table><p></p><p>
Add raw SDP forwarding parameter from body if SDP forward is enabled
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">Destination list
</TD></TR>
<TR><TD align="left" valign="top"><i>body</i></TD><TD align="left" valign="top">Mime body to process
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the parameter was added
</p>
<A NAME="addSdpParams"></A><A NAME="ref23"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>addSdpParams</strong> (NamedList& msg, const String& rawSdp)
<br></td><td align="right"><h3><strong>addSdpParams</strong></h3></td></tr></table><p></p><p>
Add raw SDP forwarding parameter if SDP forward is enabled
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">Destination list
</TD></TR>
<TR><TD align="left" valign="top"><i>rawSdp</i></TD><TD align="left" valign="top">The raw sdp content
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the parameter was added
</p>
<A NAME="addRtpParams"></A><A NAME="ref24"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>addRtpParams</strong> (NamedList& msg, const String& natAddr = String::empty(),
const MimeBody* body = 0, bool force = false)
<br></td><td align="right"><h3><strong>addRtpParams</strong></h3></td></tr></table><p></p><p>
Add RTP forwarding parameters to a message (media and address)
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">Destination list
</TD></TR>
<TR><TD align="left" valign="top"><i>natAddr</i></TD><TD align="left" valign="top">Optional NAT address if detected
</TD></TR>
<TR><TD align="left" valign="top"><i>body</i></TD><TD align="left" valign="top">Pointer to the body to extract raw SDP from
</TD></TR>
<TR><TD align="left" valign="top"><i>force</i></TD><TD align="left" valign="top">True to override RTP forward flag
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if RTP data was added. Media is always added if present and
remote address is not empty
</p>
<A NAME="resetSdp"></A><A NAME="ref25"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>resetSdp</strong> ()
<br></td><td align="right"><h3><strong>resetSdp</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Reset this object to default values
</p>
<A NAME="buildChanRtp"></A><A NAME="ref26"></A><table width="100%"><tr bgcolor="#eeeeee"><td> Message* <strong>buildChanRtp</strong> (SDPMedia* media, const char* addr, bool start, RefObject* context)
<br></td><td align="right"><h3><strong>buildChanRtp</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Build a chan.rtp message and populate with media information
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>media</i></TD><TD align="left" valign="top">The media list
</TD></TR>
<TR><TD align="left" valign="top"><i>addr</i></TD><TD align="left" valign="top">Remote RTP address
</TD></TR>
<TR><TD align="left" valign="top"><i>start</i></TD><TD align="left" valign="top">True to request RTP start
</TD></TR>
<TR><TD align="left" valign="top"><i>context</i></TD><TD align="left" valign="top">Pointer to reference counted user provided context
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: The message with media information, NULL if media or addr are missing
</p>
<A NAME="buildChanRtp"></A><A NAME="ref27"></A><table width="100%"><tr bgcolor="#eeeeee"><td> Message* <i><strong>buildChanRtp</strong></i> (RefObject* context)
<br></td><td align="right"><h3><i><strong>buildChanRtp</strong></i></h3></td></tr></table><p> <small>[pure virtual]</small></p><p>
Build a chan.rtp message without media information
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>context</i></TD><TD align="left" valign="top">Pointer to reference counted user provided context
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: The message with user data set but no media information
</p>
<A NAME="localRtpChanged"></A><A NAME="ref28"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>localRtpChanged</strong> ()
<br></td><td align="right"><h3><strong>localRtpChanged</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if local RTP data changed for at least one media
</p>
<p><b>Returns</b>: True if local RTP data changed for at least one media
</p>
<A NAME="setLocalRtpChanged"></A><A NAME="ref29"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setLocalRtpChanged</strong> (bool chg = false)
<br></td><td align="right"><h3><strong>setLocalRtpChanged</strong></h3></td></tr></table><p></p><p>
Set or reset the local RTP data changed flag for all media
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>chg</i></TD><TD align="left" valign="top">The new value for local RTP data changed flag of all media
</TD></TR>
</TABLE></P>
<A NAME="updateRtpSDP"></A><A NAME="ref30"></A><table width="100%"><tr bgcolor="#eeeeee"><td> ObjList* <strong>updateRtpSDP</strong> (const NamedList& params, String& rtpAddr,
ObjList* oldList = 0)
<br></td><td align="right"><h3><strong>updateRtpSDP</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Update RTP/SDP data from parameters
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">Parameter list
</TD></TR>
<TR><TD align="left" valign="top"><i>rtpAddr</i></TD><TD align="left" valign="top">String to be filled with rtp address from the list
</TD></TR>
<TR><TD align="left" valign="top"><i>oldList</i></TD><TD align="left" valign="top">Optional existing media list (found media will be removed
from it and added to the returned list
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: List of media or 0 if not found or rtpAddr is empty
</p>
<A NAME="m_parser"></A><A NAME="ref31"></A><table width="100%"><tr bgcolor="#eeeeee"><td>SDPParser* <strong>m_parser</strong>
</td><td align="right"><h3><strong>m_parser</strong></h3></td></tr></table><p></p><A NAME="m_mediaStatus"></A><A NAME="ref32"></A><table width="100%"><tr bgcolor="#eeeeee"><td>int <strong>m_mediaStatus</strong>
</td><td align="right"><h3><strong>m_mediaStatus</strong></h3></td></tr></table><p></p><A NAME="m_rtpForward"></A><A NAME="ref33"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>m_rtpForward</strong>
</td><td align="right"><h3><strong>m_rtpForward</strong></h3></td></tr></table><p></p><A NAME="m_sdpForward"></A><A NAME="ref34"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>m_sdpForward</strong>
</td><td align="right"><h3><strong>m_sdpForward</strong></h3></td></tr></table><p></p><A NAME="m_externalAddr"></A><A NAME="ref35"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>m_externalAddr</strong>
</td><td align="right"><h3><strong>m_externalAddr</strong></h3></td></tr></table><p></p><A NAME="m_rtpAddr"></A><A NAME="ref36"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>m_rtpAddr</strong>
</td><td align="right"><h3><strong>m_rtpAddr</strong></h3></td></tr></table><p></p><A NAME="m_rtpLocalAddr"></A><A NAME="ref37"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>m_rtpLocalAddr</strong>
</td><td align="right"><h3><strong>m_rtpLocalAddr</strong></h3></td></tr></table><p></p><A NAME="m_rtpMedia"></A><A NAME="ref38"></A><table width="100%"><tr bgcolor="#eeeeee"><td>ObjList* <strong>m_rtpMedia</strong>
</td><td align="right"><h3><strong>m_rtpMedia</strong></h3></td></tr></table><p></p><A NAME="m_sdpSession"></A><A NAME="ref39"></A><table width="100%"><tr bgcolor="#eeeeee"><td>int <strong>m_sdpSession</strong>
</td><td align="right"><h3><strong>m_sdpSession</strong></h3></td></tr></table><p></p><A NAME="m_sdpVersion"></A><A NAME="ref40"></A><table width="100%"><tr bgcolor="#eeeeee"><td>int <strong>m_sdpVersion</strong>
</td><td align="right"><h3><strong>m_sdpVersion</strong></h3></td></tr></table><p></p><A NAME="m_host"></A><A NAME="ref41"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>m_host</strong>
</td><td align="right"><h3><strong>m_host</strong></h3></td></tr></table><p></p><A NAME="m_secure"></A><A NAME="ref42"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>m_secure</strong>
</td><td align="right"><h3><strong>m_secure</strong></h3></td></tr></table><p></p><A NAME="m_rfc2833"></A><A NAME="ref43"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>m_rfc2833</strong>
</td><td align="right"><h3><strong>m_rfc2833</strong></h3></td></tr></table><p></p><A NAME="mediaChanged"></A><A NAME="ref44"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>mediaChanged</strong> (const SDPMedia& media)
<br></td><td align="right"><h3><strong>mediaChanged</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Media changed notification.
This method is called when setting new media and an old one changed
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>media</i></TD><TD align="left" valign="top">Old media that changed
</TD></TR>
</TABLE></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>
|
