/usr/include/telepathy-qt4/TelepathyQt/_gen/cli-media-stream-handler.h is in libtelepathy-qt4-dev 0.9.3-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 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 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 | /*
* This file contains D-Bus client proxy classes generated by qt-client-gen.py.
*
* This file can be distributed under the same terms as the specification from
* which it was generated.
*/
#ifndef IN_TP_QT_HEADER
#error IN_TP_QT_HEADER
#endif
#include <TelepathyQt/Types>
#include <QtGlobal>
#include <QString>
#include <QObject>
#include <QVariant>
#include <QDBusPendingReply>
#include <TelepathyQt/AbstractInterface>
#include <TelepathyQt/DBusProxy>
#include <TelepathyQt/Global>
namespace Tp
{
class PendingVariant;
class PendingOperation;
}
namespace Tp
{
namespace Client
{
/**
* \class MediaStreamHandlerInterface
* \headerfile TelepathyQt/media-stream-handler.h <TelepathyQt/MediaStreamHandler>
* \ingroup clientmstrh
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Media.StreamHandler".
*/
class TP_QT_EXPORT MediaStreamHandlerInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Media.StreamHandler", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Media.StreamHandler");
}
/**
* Creates a MediaStreamHandlerInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
MediaStreamHandlerInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a MediaStreamHandlerInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
MediaStreamHandlerInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a MediaStreamHandlerInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
MediaStreamHandlerInterface(Tp::DBusProxy *proxy);
/**
* Asynchronous getter for the remote object property \c STUNServers of type \c Tp::SocketAddressIPList.
*
*
* The IP addresses of possible STUN servers to use for NAT traversal, as
* dotted-quad IPv4 address literals or RFC2373 IPv6 address literals.
* This property cannot change once the stream has been created, so there
* is no change notification. The IP addresses MUST NOT be given as DNS
* hostnames. High-quality connection managers already need an
* asynchronous DNS resolver, so they might as well resolve this name to
* an IP to make life easier for streaming implementations.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertySTUNServers() const
{
return internalRequestProperty(QLatin1String("STUNServers"));
}
/**
* Asynchronous getter for the remote object property \c CreatedLocally of type \c bool.
*
*
* True if we were the creator of this stream, false otherwise. This
* information is needed for some nat traversal mechanisms, such as
* ICE-UDP, where the creator gets the role of the controlling agent.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCreatedLocally() const
{
return internalRequestProperty(QLatin1String("CreatedLocally"));
}
/**
* Asynchronous getter for the remote object property \c NATTraversal of type \c QString.
*
*
* \htmlonly
* <p>The transport (NAT traversal technique) to be used for this
* stream. Well-known values include:</p>
*
* <dl>
* <dt>none</dt>
* <dd>Raw UDP, with or without STUN, should be used. If the
* \endhtmlonly \link requestPropertySTUNServers() STUNServers \endlink \htmlonly property is non-empty,
* STUN SHOULD be used.</dd>
*
* <dt>stun</dt>
* <dd>A deprecated synonym for 'none'.</dd>
*
* <dt>gtalk-p2p</dt>
* <dd>Google Talk peer-to-peer connectivity establishment should be
* used, as implemented in libjingle 0.3.</dd>
*
* <dt>ice-udp</dt>
* <dd>Interactive Connectivity Establishment should be used,
* as defined by the IETF MMUSIC working group.</dd>
*
* <dt>wlm-8.5</dt>
* <dd>The transport used by Windows Live Messenger 8.5 or later,
* which resembles ICE draft 6, should be used.</dd>
*
* <dt>wlm-2009</dt>
* <dd>The transport used by Windows Live Messenger 2009 or later,
* which resembles ICE draft 19, should be used.</dd>
* </dl>
*
* <p>This property cannot change once the stream has been created, so
* there is no change notification.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyNATTraversal() const
{
return internalRequestProperty(QLatin1String("NATTraversal"));
}
/**
* Asynchronous getter for the remote object property \c RelayInfo of type \c Tp::StringVariantMapList.
*
*
* \htmlonly
* <p>A list of mappings describing TURN or Google relay servers
* available for the client to use in its candidate gathering, as
* determined from the protocol. Map keys are:</p>
*
* <dl>
* <dt><code>ip</code> - s</dt>
* <dd>The IP address of the relay server as a dotted-quad IPv4
* address literal or an RFC2373 IPv6 address literal. This MUST NOT
* be a DNS hostname.
*
* <div class="rationale">
* High-quality connection managers already need an asynchronous
* DNS resolver, so they might as well resolve this name to an IP
* and make life easier for streaming implementations.
* </div>
* </dd>
*
* <dt><code>type</code> - s</dt>
* <dd>
* <p>Either <code>udp</code> for UDP (UDP MUST be assumed if this
* key is omitted), <code>tcp</code> for TCP, or
* <code>tls</code>.</p>
*
* <p>The precise meaning of this key depends on the
* \endhtmlonly \link requestPropertyNATTraversal() NATTraversal \endlink \htmlonly property: if
* NATTraversal is <code>ice-udp</code>, <code>tls</code> means
* TLS over TCP as referenced by ICE draft 19, and if
* NATTraversal is <code>gtalk-p2p</code>, <code>tls</code> means
* a fake SSL session over TCP as implemented by libjingle.</p>
* </dd>
*
* <dt><code>port</code> - q</dt>
* <dd>The UDP or TCP port of the relay server as an ASCII unsigned
* integer</dd>
*
* <dt><code>username</code> - s</dt>
* <dd>The username to use</dd>
*
* <dt><code>password</code> - s</dt>
* <dd>The password to use</dd>
*
* <dt><code>component</code> - u</dt>
* <dd>The component number to use this relay server for, as an
* ASCII unsigned integer; if not included, this relay server
* may be used for any or all components.
*
* <div class="rationale">
* In ICE draft 6, as used by Google Talk, credentials are only
* valid once, so each component needs relaying separately.
* </div>
* </dd>
* </dl>
*
* <div class="rationale">
* <p>An equivalent of the gtalk-p2p-relay-token property on
* MediaSignalling channels is not included here. The connection
* manager should be responsible for making the necessary HTTP
* requests to turn the token into a username and password.</p>
* </div>
*
* <p>The type of relay server that this represents depends on
* the value of the \endhtmlonly \link requestPropertyNATTraversal() NATTraversal \endlink \htmlonly
* property. If NATTraversal is ice-udp, this is a TURN server;
* if NATTraversal is gtalk-p2p, this is a Google relay server;
* otherwise, the meaning of RelayInfo is undefined.</p>
*
* <p>If relaying is not possible for this stream, the list is empty.</p>
*
* <p>This property cannot change once the stream has been created, so
* there is no change notification.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyRelayInfo() const
{
return internalRequestProperty(QLatin1String("RelayInfo"));
}
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c CodecChoice on the remote object.
*
* Inform the connection manager of codec used to receive data.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> CodecChoice(uint codecID, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("CodecChoice"));
callMessage << QVariant::fromValue(codecID);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c Error on the remote object.
*
* Inform the connection manager that an error occured in this stream. The
* connection manager should emit the StreamError signal for the stream on
* the relevant channel, and remove the stream from the session.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param errorCode
*
* ID of error, from the MediaStreamError enumeration
*
* \param message
*
* String describing the error
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> Error(uint errorCode, const QString& message, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Error"));
callMessage << QVariant::fromValue(errorCode) << QVariant::fromValue(message);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c NativeCandidatesPrepared on the remote object.
*
* Informs the connection manager that all possible native candisates have
* been discovered for the moment.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> NativeCandidatesPrepared(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("NativeCandidatesPrepared"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c NewActiveCandidatePair on the remote object.
*
* Informs the connection manager that a valid candidate pair has been
* discovered and streaming is in progress.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> NewActiveCandidatePair(const QString& nativeCandidateID, const QString& remoteCandidateID, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("NewActiveCandidatePair"));
callMessage << QVariant::fromValue(nativeCandidateID) << QVariant::fromValue(remoteCandidateID);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c NewActiveTransportPair on the remote object.
*
* Informs the connection manager that a valid transport pair has been
* discovered and streaming is in progress. Component id MUST be the same
* for both transports and the pair is only valid for that component. The
* connection manager might need to send the details of the active
* transport pair (e.g. c and o parameters of SDP body need to contain
* address of selected native RTP transport as stipulated by RFC 5245).
* However, the candidate ID might not be enough to determine these info
* if the transport was found after NativeCandidatesPrepared has been
* called (e.g. peer reflexive ICE candidate). This method must be called
* before NewActiveCandidatePair. This way, connection managers supporting
* this method can safely ignore subsequent NewActiveCandidatePair call.
* Connection managers SHOULD NOT implement this method unless they need
* to inform the peer about selected transports. As a result, streaming
* implementations MUST NOT treat errors raised by this method as fatal.
* Usually, connection managers only need to do one answer/offer
* round-trip. However, some protocols give the possibility to to send an
* updated offer (e.g. ICE defines such mechanism to avoid some race
* conditions and to properly set the state of gateway devices).
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> NewActiveTransportPair(const QString& nativeCandidateID, const Tp::MediaStreamHandlerTransport& nativeTransport, const QString& remoteCandidateID, const Tp::MediaStreamHandlerTransport& remoteTransport, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("NewActiveTransportPair"));
callMessage << QVariant::fromValue(nativeCandidateID) << QVariant::fromValue(nativeTransport) << QVariant::fromValue(remoteCandidateID) << QVariant::fromValue(remoteTransport);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c NewNativeCandidate on the remote object.
*
* Inform this MediaStreamHandler that a new native transport candidate
* has been ascertained.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param candidateID
*
* String identifier for this candidate
*
* \param transports
*
* \htmlonly
* Array of transports for this candidate, with fields:
* <ul>
* <li>component number</li>
* <li>IP address (as a string)</li>
* <li>port</li>
* <li>base network protocol (one of the values of MediaStreamBaseProto)</li>
* <li>proto subtype (e.g. RTP)</li>
* <li>proto profile (e.g. AVP)</li>
* <li>our preference value of this transport (double in range 0.0-1.0
* inclusive); 1 signals the most preferred transport</li>
* <li>transport type, one of the values of MediaStreamTransportType</li>
* <li>username if authentication is required</li>
* <li>password if authentication is required</li>
* </ul>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> NewNativeCandidate(const QString& candidateID, const Tp::MediaStreamHandlerTransportList& transports, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("NewNativeCandidate"));
callMessage << QVariant::fromValue(candidateID) << QVariant::fromValue(transports);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c Ready on the remote object.
*
* Inform the connection manager that a client is ready to handle this
* StreamHandler. Also provide it with info about all supported codecs.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param codecs
*
* Locally-supported codecs.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> Ready(const Tp::MediaStreamHandlerCodecList& codecs, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Ready"));
callMessage << QVariant::fromValue(codecs);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c SetLocalCodecs on the remote object.
*
* \htmlonly
* <p>Used to provide codecs after Ready(), so the media client can go
* ready for an incoming call and exchange candidates/codecs before
* knowing what local codecs are available.</p>
*
* <p>This is useful for gatewaying calls between two connection managers.
* Given an incoming call, you need to call
* \endhtmlonly Ready() \htmlonly to get the remote codecs before
* you can use them as the "local" codecs to place the outgoing call,
* and hence receive the outgoing call's remote codecs to use as the
* incoming call's "local" codecs.</p>
*
* <p>In this situation, you would pass an empty list of codecs to the
* incoming call's Ready method, then later call SetLocalCodecs on the
* incoming call in order to respond to the offer.</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param codecs
*
* Locally-supported codecs
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> SetLocalCodecs(const Tp::MediaStreamHandlerCodecList& codecs, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SetLocalCodecs"));
callMessage << QVariant::fromValue(codecs);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c StreamState on the remote object.
*
* Informs the connection manager of the stream's current state, as
* as specified in Channel.Type.StreamedMedia::ListStreams.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> StreamState(uint state, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("StreamState"));
callMessage << QVariant::fromValue(state);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c SupportedCodecs on the remote object.
*
* Inform the connection manager of the supported codecs for this session.
* This is called after the connection manager has emitted SetRemoteCodecs
* to notify what codecs are supported by the peer, and will thus be an
* intersection of all locally supported codecs (passed to Ready) and
* those supported by the peer.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param codecs
*
* Locally supported codecs.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> SupportedCodecs(const Tp::MediaStreamHandlerCodecList& codecs, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SupportedCodecs"));
callMessage << QVariant::fromValue(codecs);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c CodecsUpdated on the remote object.
*
* Inform the connection manager that the parameters of the supported
* codecs for this session have changed. The connection manager should
* send the new parameters to the remote contact. This is required for
* H.264 and Theora, for example.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param codecs
*
* Locally supported codecs, which SHOULD be the same as were
* previously in effect, but possibly with different parameters.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> CodecsUpdated(const Tp::MediaStreamHandlerCodecList& codecs, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("CodecsUpdated"));
callMessage << QVariant::fromValue(codecs);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c HoldState on the remote object.
*
* Notify the connection manager that the stream's hold state has
* been changed successfully in response to SetStreamHeld.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param held
*
* If true, the stream is now on hold.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> HoldState(bool held, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("HoldState"));
callMessage << QVariant::fromValue(held);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c UnholdFailure on the remote object.
*
* Notify the connection manager that an attempt to reacquire the
* necessary hardware or software resources to unhold the stream, in
* response to SetStreamHeld, has failed.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> UnholdFailure(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("UnholdFailure"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c SupportedFeedbackMessages on the remote object.
*
* Inform the connection manager of the supported feedback messages for
* this session. This is called a before calling SupportedCodecs, Ready or
* CodecsUpdated to indicate the local, or negotiated feedback messages.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param messages
*
* Locally supported feedback messages.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> SupportedFeedbackMessages(const Tp::RTCPFeedbackMessageMap& messages, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SupportedFeedbackMessages"));
callMessage << QVariant::fromValue(messages);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c SupportedHeaderExtensions on the remote object.
*
* Inform the connection manager of the supported RTP header extensions
* for this session. This is called before calling SupportedCodecs, Ready
* or CodecsUpdated to indicate the local or negotiated RTP header
* extensions.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param headerExtensions
*
* Locally supported RTP header extensions.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> SupportedHeaderExtensions(const Tp::RTPHeaderExtensionsList& headerExtensions, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SupportedHeaderExtensions"));
callMessage << QVariant::fromValue(headerExtensions);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c AddRemoteCandidate on the remote object.
*
* Signal emitted when the connection manager wishes to inform the client
* of a new remote candidate.
*
* \param candidateID
*
* String identifier for this candidate
*
* \param transports
*
* Array of transports for this candidate with fields, as defined in
* NewNativeCandidate
*/
void AddRemoteCandidate(const QString& candidateID, const Tp::MediaStreamHandlerTransportList& transports);
/**
* Represents the signal \c Close on the remote object.
*
* Signal emitted when the connection manager wishes the stream to be
* closed.
*/
void Close();
/**
* Represents the signal \c RemoveRemoteCandidate on the remote object.
*
* Signal emitted when the connection manager wishes to inform the client
* that the remote end has removed a previously usable candidate. It
* seemed like a good idea at the time, but wasn't.
*
* \param candidateID
*
* String identifier for remote candidate to drop
*/
void RemoveRemoteCandidate(const QString& candidateID);
/**
* Represents the signal \c SetActiveCandidatePair on the remote object.
*
* Emitted by the connection manager to inform the client that a valid
* candidate pair has been discovered by the remote end and streaming is
* in progress.
*/
void SetActiveCandidatePair(const QString& nativeCandidateID, const QString& remoteCandidateID);
/**
* Represents the signal \c SetRemoteCandidateList on the remote object.
*
* Signal emitted when the connection manager wishes to inform the client
* of all the available remote candidates at once.
*
* \param remoteCandidates
*
* A list of candidate id and a list of transports as defined in
* NewNativeCandidate
*/
void SetRemoteCandidateList(const Tp::MediaStreamHandlerCandidateList& remoteCandidates);
/**
* Represents the signal \c SetRemoteCodecs on the remote object.
*
* Signal emitted when the connection manager wishes to inform the client
* of the codecs supported by the remote end. If these codecs are
* compatible with the remote codecs, then the client must call
* SupportedCodecs, otherwise call Error.
*
* \param codecs
*
* Codecs supported by the remote peer.
*/
void SetRemoteCodecs(const Tp::MediaStreamHandlerCodecList& codecs);
/**
* Represents the signal \c SetStreamPlaying on the remote object.
*
* If emitted with argument TRUE, this means that the connection manager
* wishes to set the stream playing; this means that the streaming
* implementation should expect to receive data. If emitted with argument
* FALSE this signal is basically meaningless and should be ignored.
* We're very sorry.
*/
void SetStreamPlaying(bool playing);
/**
* Represents the signal \c SetStreamSending on the remote object.
*
* Signal emitted when the connection manager wishes to set whether or not
* the stream sends to the remote end.
*/
void SetStreamSending(bool sending);
/**
* Represents the signal \c StartTelephonyEvent on the remote object.
*
* Request that a telephony event (as defined by RFC 4733) is transmitted
* over this stream until StopTelephonyEvent is called.
*
* \param event
*
* A telephony event code.
*/
void StartTelephonyEvent(uchar event);
/**
* Represents the signal \c StartNamedTelephonyEvent on the remote object.
*
* Request that a telephony event (as defined by RFC 4733) is transmitted
* over this stream until StopTelephonyEvent is called. This differs from
* StartTelephonyEvent in that you force the event to be transmitted as a
* RFC 4733 named event, not as sound. You can also force a specific Codec
* ID.
*
* \param event
*
* A telephony event code as defined by RFC 4733.
*
* \param codecID
*
* The payload type to use when sending events. The value 0xFFFFFFFF
* means to send with the already configured event type instead of
* using the specified one.
*/
void StartNamedTelephonyEvent(uchar event, uint codecID);
/**
* Represents the signal \c StartSoundTelephonyEvent on the remote object.
*
* Request that a telephony event (as defined by RFC 4733) is transmitted
* over this stream until StopTelephonyEvent is called. This differs from
* StartTelephonyEvent in that you force the event to be transmitted as
* sound instead of as a named event.
*
* \param event
*
* A telephony event code as defined by RFC 4733.
*/
void StartSoundTelephonyEvent(uchar event);
/**
* Represents the signal \c StopTelephonyEvent on the remote object.
*
* Request that any ongoing telephony events (as defined by RFC 4733)
* being transmitted over this stream are stopped.
*/
void StopTelephonyEvent();
/**
* Represents the signal \c SetStreamHeld on the remote object.
*
* \htmlonly
* <p>Emitted when the connection manager wishes to place the stream on
* hold (so the streaming client should free hardware or software
* resources) or take the stream off hold (so the streaming client
* should reacquire the necessary resources).</p>
*
* <p>When placing a channel's streams on hold, the connection manager
* SHOULD notify the remote contact that this will be done (if
* appropriate in the protocol) before it emits this signal.</p>
*
* <div class="rationale">
* <p>It is assumed that relinquishing a resource will not fail.
* If it does, the call is probably doomed anyway.</p>
* </div>
*
* <p>When unholding a channel's streams, the connection manager
* SHOULD emit this signal and wait for success to be indicated
* via HoldState before it notifies the remote contact that the
* channel has been taken off hold.</p>
*
* <div class="rationale">
* <p>This means that if a resource is unavailable, the remote
* contact will never even be told that we tried to acquire it.</p>
* </div>
* \endhtmlonly
*
* \param held
*
* If true, the stream is to be placed on hold.
*/
void SetStreamHeld(bool held);
/**
* Represents the signal \c SetRemoteFeedbackMessages on the remote object.
*
* Signal emitted when the connection manager wishes to inform the client
* of the feedback messages supported by the remote end. This signal is
* emitted before SetRemoteCodecs. If the client supports any of these
* messages, it must call SupportedFeedbackMessages before calling
* SupportedCodecs.
*
* \param messages
*
* Remote Feedback messages desired by the remote side
*/
void SetRemoteFeedbackMessages(const Tp::RTCPFeedbackMessageMap& messages);
/**
* Represents the signal \c SetRemoteHeaderExtensions on the remote object.
*
* Signal emitted when the connection manager wishes to inform the client
* of the RTP header extensions supported by the remote end. This signal
* is emitted before SetRemoteCodecs. If the client supports any of these
* messages, it must call SupportedHeaderExtensions before calling
* SupportedCodecs.
*
* \param headerExtensions
*
* Header extensions desired by the remote side
*/
void SetRemoteHeaderExtensions(const Tp::RTPHeaderExtensionsList& headerExtensions);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
}
}
Q_DECLARE_METATYPE(Tp::Client::MediaStreamHandlerInterface*)
|