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 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>TelepathyQt4: Tp::MediaStream Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="1"> </td>
<td class="postheader" valign="center">
<a href="index.html">
<font color="#004faf">Home</font></a> ·
<a href="classes.html">
<font color="#004faf">All Classes</font></a> ·
<a href="namespaces.html">
<font color="#004faf">All Namespaces</font></a> ·
<a href="modules.html">
<font color="#004faf">Modules</font></a> ·
<a href="functions.html">
<font color="#004faf">Functions</font></a> ·
<a href="files.html">
<font color="#004faf">Files</font></a>
</td>
</tr>
</table>
</body>
</html>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navpath"><a class="el" href="namespaceTp.html">Tp</a>::<a class="el" href="classTp_1_1MediaStream.html">MediaStream</a>
</div>
<div class="contents">
<h1>Tp::MediaStream Class Reference<br/>
<small>
[<a class="el" href="group__clientchannel.html">Channel proxies</a>]</small>
</h1><!-- doxytag: class="Tp::MediaStream" --><!-- doxytag: inherits="Tp::ReadyObject,Tp::RefCounted" -->
<p>The <a class="el" href="classTp_1_1MediaStream.html" title="The MediaStream class provides an object representing a Telepathy media stream.">MediaStream</a> class provides an object representing a Telepathy media stream.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="streamed-media-channel_8h_source.html">TelepathyQt4/StreamedMediaChannel</a>></code></p>
<p>Inherits <a class="el" href="classTp_1_1ReadyObject.html">Tp::ReadyObject</a>, and <a class="el" href="classTp_1_1RefCounted.html">Tp::RefCounted</a>.</p>
<p><a href="classTp_1_1MediaStream-members.html">List of all members.</a></p>
<h2>Public Types</h2>
<ul>
<li>enum <a class="el" href="classTp_1_1MediaStream.html#aca01117f94ace9d39f7fe64211bf83f2">SendingState</a> { <a class="el" href="classTp_1_1MediaStream.html#aca01117f94ace9d39f7fe64211bf83f2ad1769e5ae8c09f25727656cb94dfeb53">SendingStateNone</a>,
<a class="el" href="classTp_1_1MediaStream.html#aca01117f94ace9d39f7fe64211bf83f2a2cd5c56eb3075797bab9a73ea31de684">SendingStatePendingSend</a>,
<a class="el" href="classTp_1_1MediaStream.html#aca01117f94ace9d39f7fe64211bf83f2a48f27ebf18e704e351fbefbc0cac0838">SendingStateSending</a>
}
</ul>
<h2>Signals</h2>
<ul>
<li>void <a class="el" href="classTp_1_1MediaStream.html#a0f7c0a69d2d770902e32f300cd25fb46">localSendingStateChanged</a> (<a class="el" href="classTp_1_1MediaStream.html#aca01117f94ace9d39f7fe64211bf83f2">Tp::MediaStream::SendingState</a> localSendingState)
<li>void <a class="el" href="classTp_1_1MediaStream.html#a98f68790e9e72f72dff9a5c7d1555270">remoteSendingStateChanged</a> (const QHash< <a class="el" href="namespaceTp.html#a8851d7a4827022bfff3c1b15320a0289">Tp::ContactPtr</a>, <a class="el" href="classTp_1_1MediaStream.html#aca01117f94ace9d39f7fe64211bf83f2">Tp::MediaStream::SendingState</a> > &remoteSendingStates)
<li>void <a class="el" href="classTp_1_1MediaStream.html#a4cb62e05cf5a9722c85858aa7cb055ca">membersRemoved</a> (const <a class="el" href="namespaceTp.html#aebaea72cfe74d9d2a30ae88539f05c82">Tp::Contacts</a> &members)
</ul>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classTp_1_1MediaStream.html#aeafafde869634c88368fe749754ec3dd">~MediaStream</a> ()
<li><a class="el" href="classTp_1_1SharedPtr.html">MediaContentPtr</a> <a class="el" href="classTp_1_1MediaStream.html#a585ea0a695774fe3cb9dfbaaa23c6c6b">content</a> () const
<li><a class="el" href="classTp_1_1SharedPtr.html">StreamedMediaChannelPtr</a> <a class="el" href="classTp_1_1MediaStream.html#aa29ef8bd6ca888e464c237cd0cd52b24">channel</a> () const
<li>TELEPATHY_QT4_DEPRECATED uint <a class="el" href="classTp_1_1MediaStream.html#a5c73782e61a581aaed75b7876a8b31f9">id</a> () const
<li><a class="el" href="namespaceTp.html#aebaea72cfe74d9d2a30ae88539f05c82">Contacts</a> <a class="el" href="classTp_1_1MediaStream.html#a80ca860cccf6bbff3dcdbd0414bd5bc7">members</a> () const
<li>TELEPATHY_QT4_DEPRECATED <a class="el" href="namespaceTp.html#a8851d7a4827022bfff3c1b15320a0289">ContactPtr</a> <a class="el" href="classTp_1_1MediaStream.html#a79cf90c7cba26a4e08dfebe0c3a1200c">contact</a> () const
<li>TELEPATHY_QT4_DEPRECATED <br class="typebreak"/>
MediaStreamState <a class="el" href="classTp_1_1MediaStream.html#a4b22b472bfd527598d2ccab5760e62ba">state</a> () const
<li>TELEPATHY_QT4_DEPRECATED <br class="typebreak"/>
MediaStreamType <a class="el" href="classTp_1_1MediaStream.html#a8c4a68642acd04a59461aefa1cd13084">type</a> () const
<li><a class="el" href="classTp_1_1MediaStream.html#aca01117f94ace9d39f7fe64211bf83f2">SendingState</a> <a class="el" href="classTp_1_1MediaStream.html#a8d87297acdade7c19f72a9768e82e3b8">localSendingState</a> () const
<li><a class="el" href="classTp_1_1MediaStream.html#aca01117f94ace9d39f7fe64211bf83f2">SendingState</a> <a class="el" href="classTp_1_1MediaStream.html#ae88e32497c34407373c75c27dbc33d7a">remoteSendingState</a> (const <a class="el" href="namespaceTp.html#a8851d7a4827022bfff3c1b15320a0289">ContactPtr</a> &contact) const
<li>bool <a class="el" href="classTp_1_1MediaStream.html#a1bd3fff4685efa3792f0b9141a53fcad">sending</a> () const
<li>TELEPATHY_QT4_DEPRECATED bool <a class="el" href="classTp_1_1MediaStream.html#a94747182709a9288120509db68986367">receiving</a> () const
<li>bool <a class="el" href="classTp_1_1MediaStream.html#a420829104c22d6a480c511f7fc4c581d">localSendingRequested</a> () const
<li>TELEPATHY_QT4_DEPRECATED bool <a class="el" href="classTp_1_1MediaStream.html#aa26e5b54df5fad3c8b273ccc903c9431">remoteSendingRequested</a> () const
<li>TELEPATHY_QT4_DEPRECATED <br class="typebreak"/>
MediaStreamDirection <a class="el" href="classTp_1_1MediaStream.html#ad3427d97259bd5f71c2cdccc54587263">direction</a> () const
<li>TELEPATHY_QT4_DEPRECATED <br class="typebreak"/>
MediaStreamPendingSend <a class="el" href="classTp_1_1MediaStream.html#aa9e12da280737f7b6910a31d355cd58e">pendingSend</a> () const
<li><a class="el" href="classTp_1_1PendingOperation.html">PendingOperation</a> * <a class="el" href="classTp_1_1MediaStream.html#a5fa52737a10eef11c790df175573e1f0">requestSending</a> (bool send)
<li><a class="el" href="classTp_1_1PendingOperation.html">PendingOperation</a> * <a class="el" href="classTp_1_1MediaStream.html#a7b8b12cb8988562c0bfc4ae8206ca5b8">requestReceiving</a> (const <a class="el" href="namespaceTp.html#a8851d7a4827022bfff3c1b15320a0289">ContactPtr</a> &contact, bool receive)
<li>TELEPATHY_QT4_DEPRECATED <br class="typebreak"/>
<a class="el" href="classTp_1_1PendingOperation.html">PendingOperation</a> * <a class="el" href="classTp_1_1MediaStream.html#a82426be4c8ab6d3874c3c15db21b9fe4">requestDirection</a> (MediaStreamDirection direction)
<li>TELEPATHY_QT4_DEPRECATED <br class="typebreak"/>
<a class="el" href="classTp_1_1PendingOperation.html">PendingOperation</a> * <a class="el" href="classTp_1_1MediaStream.html#a6415d1548ce380a76066d1d8d5f7439e">requestDirection</a> (bool send, bool receive)
<li><a class="el" href="classTp_1_1PendingOperation.html">PendingOperation</a> * <a class="el" href="classTp_1_1MediaStream.html#ae636f8f43eeee8bc0fd5845259693097">startDTMFTone</a> (DTMFEvent event)
<li><a class="el" href="classTp_1_1PendingOperation.html">PendingOperation</a> * <a class="el" href="classTp_1_1MediaStream.html#a22de5f794ab99ee00ed552db4b7c8c07">stopDTMFTone</a> ()
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <a class="el" href="classTp_1_1MediaStream.html" title="The MediaStream class provides an object representing a Telepathy media stream.">MediaStream</a> class provides an object representing a Telepathy media stream. </p>
<p>Instances of this class cannot be constructed directly; the only way to get one is via <a class="el" href="classTp_1_1StreamedMediaChannel.html" title="The StreamedMediaChannel class provides an object representing a Telepathy channel...">StreamedMediaChannel</a>.</p>
<p>See <a class="el" href="async__model.html">Asynchronous Object Model</a> </p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="aca01117f94ace9d39f7fe64211bf83f2"></a><!-- doxytag: member="Tp::MediaStream::SendingState" ref="aca01117f94ace9d39f7fe64211bf83f2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classTp_1_1MediaStream.html#aca01117f94ace9d39f7fe64211bf83f2">Tp::MediaStream::SendingState</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="aca01117f94ace9d39f7fe64211bf83f2ad1769e5ae8c09f25727656cb94dfeb53"></a><!-- doxytag: member="SendingStateNone" ref="aca01117f94ace9d39f7fe64211bf83f2ad1769e5ae8c09f25727656cb94dfeb53" args="" -->SendingStateNone</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aca01117f94ace9d39f7fe64211bf83f2a2cd5c56eb3075797bab9a73ea31de684"></a><!-- doxytag: member="SendingStatePendingSend" ref="aca01117f94ace9d39f7fe64211bf83f2a2cd5c56eb3075797bab9a73ea31de684" args="" -->SendingStatePendingSend</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aca01117f94ace9d39f7fe64211bf83f2a48f27ebf18e704e351fbefbc0cac0838"></a><!-- doxytag: member="SendingStateSending" ref="aca01117f94ace9d39f7fe64211bf83f2a48f27ebf18e704e351fbefbc0cac0838" args="" -->SendingStateSending</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aeafafde869634c88368fe749754ec3dd"></a><!-- doxytag: member="Tp::MediaStream::~MediaStream" ref="aeafafde869634c88368fe749754ec3dd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tp::MediaStream::~MediaStream </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Class destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a585ea0a695774fe3cb9dfbaaa23c6c6b"></a><!-- doxytag: member="Tp::MediaStream::content" ref="a585ea0a695774fe3cb9dfbaaa23c6c6b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1SharedPtr.html">MediaContentPtr</a> Tp::MediaStream::content </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the content owning this media stream.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The content owning this media stream. </dd></dl>
</div>
</div>
<a class="anchor" id="aa29ef8bd6ca888e464c237cd0cd52b24"></a><!-- doxytag: member="Tp::MediaStream::channel" ref="aa29ef8bd6ca888e464c237cd0cd52b24" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1SharedPtr.html">StreamedMediaChannelPtr</a> Tp::MediaStream::channel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the channel owning this media stream.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The channel owning this media stream. </dd></dl>
</div>
</div>
<a class="anchor" id="a5c73782e61a581aaed75b7876a8b31f9"></a><!-- doxytag: member="Tp::MediaStream::id" ref="a5c73782e61a581aaed75b7876a8b31f9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint Tp::MediaStream::id </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the id of this media stream.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>An integer representing the media stream id. </dd></dl>
</div>
</div>
<a class="anchor" id="a80ca860cccf6bbff3dcdbd0414bd5bc7"></a><!-- doxytag: member="Tp::MediaStream::members" ref="a80ca860cccf6bbff3dcdbd0414bd5bc7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceTp.html#aebaea72cfe74d9d2a30ae88539f05c82">Contacts</a> Tp::MediaStream::members </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the contacts whose the media stream is with.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The contacts whose the media stream is with. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaStream.html#a4cb62e05cf5a9722c85858aa7cb055ca">membersRemoved()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a79cf90c7cba26a4e08dfebe0c3a1200c"></a><!-- doxytag: member="Tp::MediaStream::contact" ref="a79cf90c7cba26a4e08dfebe0c3a1200c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceTp.html#a8851d7a4827022bfff3c1b15320a0289">ContactPtr</a> Tp::MediaStream::contact </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the contact who this media stream is with.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The contact who this media stream is with. </dd></dl>
</div>
</div>
<a class="anchor" id="a4b22b472bfd527598d2ccab5760e62ba"></a><!-- doxytag: member="Tp::MediaStream::state" ref="a4b22b472bfd527598d2ccab5760e62ba" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MediaStreamState Tp::MediaStream::state </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the state of this media stream.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The state of this media stream. </dd></dl>
</div>
</div>
<a class="anchor" id="a8c4a68642acd04a59461aefa1cd13084"></a><!-- doxytag: member="Tp::MediaStream::type" ref="a8c4a68642acd04a59461aefa1cd13084" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MediaStreamType Tp::MediaStream::type </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the type of this media stream.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The type of this media stream. </dd></dl>
</div>
</div>
<a class="anchor" id="a8d87297acdade7c19f72a9768e82e3b8"></a><!-- doxytag: member="Tp::MediaStream::localSendingState" ref="a8d87297acdade7c19f72a9768e82e3b8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1MediaStream.html#aca01117f94ace9d39f7fe64211bf83f2">MediaStream::SendingState</a> Tp::MediaStream::localSendingState </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the media stream local sending state.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The media stream local sending state. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaStream.html#a0f7c0a69d2d770902e32f300cd25fb46">localSendingStateChanged()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ae88e32497c34407373c75c27dbc33d7a"></a><!-- doxytag: member="Tp::MediaStream::remoteSendingState" ref="ae88e32497c34407373c75c27dbc33d7a" args="(const ContactPtr &contact) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1MediaStream.html#aca01117f94ace9d39f7fe64211bf83f2">MediaStream::SendingState</a> Tp::MediaStream::remoteSendingState </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespaceTp.html#a8851d7a4827022bfff3c1b15320a0289">ContactPtr</a> & </td>
<td class="paramname"> <em>contact</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the media stream remote sending state for a given <em>contact</em>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The media stream remote sending state for a contact. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaStream.html#a98f68790e9e72f72dff9a5c7d1555270">remoteSendingStateChanged()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1bd3fff4685efa3792f0b9141a53fcad"></a><!-- doxytag: member="Tp::MediaStream::sending" ref="a1bd3fff4685efa3792f0b9141a53fcad" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::MediaStream::sending </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether media is being sent on this media stream.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if media being sent on this media stream, <code>false</code> otherwise. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaStream.html#a0f7c0a69d2d770902e32f300cd25fb46">localSendingStateChanged()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a94747182709a9288120509db68986367"></a><!-- doxytag: member="Tp::MediaStream::receiving" ref="a94747182709a9288120509db68986367" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::MediaStream::receiving </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether media is being received on this media stream.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if media is being received on this media stream, <code>false</code> otherwise. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaStream.html#a98f68790e9e72f72dff9a5c7d1555270">remoteSendingStateChanged()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a420829104c22d6a480c511f7fc4c581d"></a><!-- doxytag: member="Tp::MediaStream::localSendingRequested" ref="a420829104c22d6a480c511f7fc4c581d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::MediaStream::localSendingRequested </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether the local user has been asked to send media by the remote user on this media stream.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the local user has been asked to send media by the remote user on this media stream, <code>false</code> otherwise. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaStream.html#a0f7c0a69d2d770902e32f300cd25fb46">localSendingStateChanged()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aa26e5b54df5fad3c8b273ccc903c9431"></a><!-- doxytag: member="Tp::MediaStream::remoteSendingRequested" ref="aa26e5b54df5fad3c8b273ccc903c9431" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::MediaStream::remoteSendingRequested </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether the remote user has been asked to send media by the local user on this media stream.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the remote user has been asked to send media by the local user on this media stream, <code>false</code> otherwise. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaStream.html#a98f68790e9e72f72dff9a5c7d1555270">remoteSendingStateChanged()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ad3427d97259bd5f71c2cdccc54587263"></a><!-- doxytag: member="Tp::MediaStream::direction" ref="ad3427d97259bd5f71c2cdccc54587263" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MediaStreamDirection Tp::MediaStream::direction </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the direction of this media stream.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The direction of this media stream. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaStream.html#a0f7c0a69d2d770902e32f300cd25fb46">localSendingStateChanged()</a>, <a class="el" href="classTp_1_1MediaStream.html#a98f68790e9e72f72dff9a5c7d1555270">remoteSendingStateChanged()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aa9e12da280737f7b6910a31d355cd58e"></a><!-- doxytag: member="Tp::MediaStream::pendingSend" ref="aa9e12da280737f7b6910a31d355cd58e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MediaStreamPendingSend Tp::MediaStream::pendingSend </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the pending send flags of this media stream.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The pending send flags of this media stream. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaStream.html#a0f7c0a69d2d770902e32f300cd25fb46">localSendingStateChanged()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a5fa52737a10eef11c790df175573e1f0"></a><!-- doxytag: member="Tp::MediaStream::requestSending" ref="a5fa52737a10eef11c790df175573e1f0" args="(bool send)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1PendingOperation.html">PendingOperation</a> * Tp::MediaStream::requestSending </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>send</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request that media starts or stops being sent on this media stream.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> which will emit <a class="el" href="classTp_1_1PendingOperation.html#addbb8c4462019ffdf19095a31da0cc7a">PendingOperation::finished</a> when the call has finished. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaStream.html#a0f7c0a69d2d770902e32f300cd25fb46">localSendingStateChanged()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a7b8b12cb8988562c0bfc4ae8206ca5b8"></a><!-- doxytag: member="Tp::MediaStream::requestReceiving" ref="a7b8b12cb8988562c0bfc4ae8206ca5b8" args="(const ContactPtr &contact, bool receive)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1PendingOperation.html">PendingOperation</a> * Tp::MediaStream::requestReceiving </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespaceTp.html#a8851d7a4827022bfff3c1b15320a0289">ContactPtr</a> & </td>
<td class="paramname"> <em>contact</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>receive</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request that a remote <em>contact</em> stops or starts sending on this media stream.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> which will emit <a class="el" href="classTp_1_1PendingOperation.html#addbb8c4462019ffdf19095a31da0cc7a">PendingOperation::finished</a> when the call has finished. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaStream.html#a98f68790e9e72f72dff9a5c7d1555270">remoteSendingStateChanged()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a82426be4c8ab6d3874c3c15db21b9fe4"></a><!-- doxytag: member="Tp::MediaStream::requestDirection" ref="a82426be4c8ab6d3874c3c15db21b9fe4" args="(MediaStreamDirection direction)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1PendingOperation.html">PendingOperation</a> * Tp::MediaStream::requestDirection </td>
<td>(</td>
<td class="paramtype">MediaStreamDirection </td>
<td class="paramname"> <em>direction</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request a change in the direction of this media stream. In particular, this might be useful to stop sending media of a particular type, or inform the peer that you are no longer using media that is being sent to you.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>direction</em> </td><td>The new direction. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> which will emit <a class="el" href="classTp_1_1PendingOperation.html#addbb8c4462019ffdf19095a31da0cc7a">PendingOperation::finished</a> when the call has finished. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaStream.html#a0f7c0a69d2d770902e32f300cd25fb46">localSendingStateChanged()</a>, <a class="el" href="classTp_1_1MediaStream.html#a98f68790e9e72f72dff9a5c7d1555270">remoteSendingStateChanged()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a6415d1548ce380a76066d1d8d5f7439e"></a><!-- doxytag: member="Tp::MediaStream::requestDirection" ref="a6415d1548ce380a76066d1d8d5f7439e" args="(bool send, bool receive)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1PendingOperation.html">PendingOperation</a> * Tp::MediaStream::requestDirection </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>send</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>receive</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request a change in the direction of this media stream. In particular, this might be useful to stop sending media of a particular type, or inform the peer that you are no longer using media that is being sent to you.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> which will emit <a class="el" href="classTp_1_1PendingOperation.html#addbb8c4462019ffdf19095a31da0cc7a">PendingOperation::finished</a> when the call has finished. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>requestDirection(Tp::MediaStreamDirection direction) </dd>
<dd>
<a class="el" href="classTp_1_1MediaStream.html#a0f7c0a69d2d770902e32f300cd25fb46">localSendingStateChanged()</a>, <a class="el" href="classTp_1_1MediaStream.html#a98f68790e9e72f72dff9a5c7d1555270">remoteSendingStateChanged()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ae636f8f43eeee8bc0fd5845259693097"></a><!-- doxytag: member="Tp::MediaStream::startDTMFTone" ref="ae636f8f43eeee8bc0fd5845259693097" args="(DTMFEvent event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1PendingOperation.html">PendingOperation</a> * Tp::MediaStream::startDTMFTone </td>
<td>(</td>
<td class="paramtype">DTMFEvent </td>
<td class="paramname"> <em>event</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Start sending a DTMF tone on this media stream. Where possible, the tone will continue until <a class="el" href="classTp_1_1MediaStream.html#a22de5f794ab99ee00ed552db4b7c8c07">stopDTMFTone()</a> is called. On certain protocols, it may only be possible to send events with a predetermined length. In this case, the implementation may emit a fixed-length tone, and the <a class="el" href="classTp_1_1MediaStream.html#a22de5f794ab99ee00ed552db4b7c8c07">stopDTMFTone()</a> method call should return TELEPATHY_ERROR_NOT_AVAILABLE.</p>
<p>If the <a class="el" href="classTp_1_1MediaStream.html#aa29ef8bd6ca888e464c237cd0cd52b24">channel()</a> does not support the TELEPATHY_INTERFACE_CHANNEL_INTERFACE_DTMF interface, the resulting <a class="el" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> will fail with error code TELEPATHY_ERROR_NOT_IMPLEMENTED.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>A numeric event code from the DTMFEvent enum. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> which will emit <a class="el" href="classTp_1_1PendingOperation.html#addbb8c4462019ffdf19095a31da0cc7a">PendingOperation::finished</a> when the request finishes. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaStream.html#a22de5f794ab99ee00ed552db4b7c8c07">stopDTMFTone()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a22de5f794ab99ee00ed552db4b7c8c07"></a><!-- doxytag: member="Tp::MediaStream::stopDTMFTone" ref="a22de5f794ab99ee00ed552db4b7c8c07" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1PendingOperation.html">PendingOperation</a> * Tp::MediaStream::stopDTMFTone </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stop sending any DTMF tone which has been started using the <a class="el" href="classTp_1_1MediaStream.html#ae636f8f43eeee8bc0fd5845259693097">startDTMFTone()</a> method. If there is no current tone, the resulting <a class="el" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> will finish successfully.</p>
<p>If continuous tones are not supported by this media stream, the resulting <a class="el" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> will fail with error code TELEPATHY_ERROR_NOT_AVAILABLE.</p>
<p>If the <a class="el" href="classTp_1_1MediaStream.html#aa29ef8bd6ca888e464c237cd0cd52b24">channel()</a> does not support the TELEPATHY_INTERFACE_CHANNEL_INTERFACE_DTMF interface, the resulting <a class="el" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> will fail with error code TELEPATHY_ERROR_NOT_IMPLEMENTED.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> which will emit <a class="el" href="classTp_1_1PendingOperation.html#addbb8c4462019ffdf19095a31da0cc7a">PendingOperation::finished</a> when the request finishes. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaStream.html#ae636f8f43eeee8bc0fd5845259693097">startDTMFTone()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a0f7c0a69d2d770902e32f300cd25fb46"></a><!-- doxytag: member="Tp::MediaStream::localSendingStateChanged" ref="a0f7c0a69d2d770902e32f300cd25fb46" args="(Tp::MediaStream::SendingState localSendingState)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Tp::MediaStream::localSendingStateChanged </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTp_1_1MediaStream.html#aca01117f94ace9d39f7fe64211bf83f2">Tp::MediaStream::SendingState</a> </td>
<td class="paramname"> <em>localSendingState</em></td>
<td> ) </td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is emitted when the local sending state of this media stream changes.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>localSendingState</em> </td><td>The new local sending state of this media stream. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaStream.html#a8d87297acdade7c19f72a9768e82e3b8">localSendingState()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a98f68790e9e72f72dff9a5c7d1555270"></a><!-- doxytag: member="Tp::MediaStream::remoteSendingStateChanged" ref="a98f68790e9e72f72dff9a5c7d1555270" args="(const QHash< Tp::ContactPtr, Tp::MediaStream::SendingState > &remoteSendingStates)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Tp::MediaStream::remoteSendingStateChanged </td>
<td>(</td>
<td class="paramtype">const QHash< <a class="el" href="namespaceTp.html#a8851d7a4827022bfff3c1b15320a0289">Tp::ContactPtr</a>, <a class="el" href="classTp_1_1MediaStream.html#aca01117f94ace9d39f7fe64211bf83f2">Tp::MediaStream::SendingState</a> > & </td>
<td class="paramname"> <em>remoteSendingStates</em></td>
<td> ) </td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is emitted when any remote sending state of this media stream changes.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>remoteSendingStates</em> </td><td>The new remote sending states of this media stream. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaStream.html#ae88e32497c34407373c75c27dbc33d7a">remoteSendingState()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a4cb62e05cf5a9722c85858aa7cb055ca"></a><!-- doxytag: member="Tp::MediaStream::membersRemoved" ref="a4cb62e05cf5a9722c85858aa7cb055ca" args="(const Tp::Contacts &members)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Tp::MediaStream::membersRemoved </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespaceTp.html#aebaea72cfe74d9d2a30ae88539f05c82">Tp::Contacts</a> & </td>
<td class="paramname"> <em>members</em></td>
<td> ) </td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is emitted when one or more members of this stream are removed.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>members</em> </td><td>The members that were removed from this media stream. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaStream.html#a80ca860cccf6bbff3dcdbd0414bd5bc7">members()</a> </dd></dl>
</div>
</div>
</div>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%">Copyright © 2008-2010 Collabora Ltd. and Nokia Corporation</td>
<td width="30%" align="right"><div align="right">Telepathy-Qt4 0.3.6</div></td>
</tr></table></div></address>
</body>
</html>
|