Home · All Classes · All Namespaces · Modules · Functions · Files
Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions
Tp::Client::CallStreamEndpointInterface Class Reference

#include <TelepathyQt/CallStreamEndpoint>

Inherits Tp::AbstractInterface.

List of all members.

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions


Detailed Description

Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Call1.Stream.Endpoint".


Constructor & Destructor Documentation

Tp::Client::CallStreamEndpointInterface::CallStreamEndpointInterface ( const QString &  busName,
const QString &  objectPath,
QObject *  parent = 0 
)

Creates a CallStreamEndpointInterface associated with the given object on the session bus.

Parameters:
busNameName of the service the object is on.
objectPathPath to the object on the service.
parentPassed to the parent class constructor.
Tp::Client::CallStreamEndpointInterface::CallStreamEndpointInterface ( const QDBusConnection &  connection,
const QString &  busName,
const QString &  objectPath,
QObject *  parent = 0 
)

Creates a CallStreamEndpointInterface associated with the given object on the given bus.

Parameters:
connectionThe bus via which the object can be reached.
busNameName of the service the object is on.
objectPathPath to the object on the service.
parentPassed to the parent class constructor.

Creates a CallStreamEndpointInterface associated with the same object as the given proxy.

Parameters:
proxyThe proxy to use. It will also be the QObject::parent() for this object.

Member Function Documentation

static QLatin1String Tp::Client::CallStreamEndpointInterface::staticInterfaceName ( ) [inline, static]

Returns the name of the interface "org.freedesktop.Telepathy.Call1.Stream.Endpoint", which this class represents.

Returns:
The D-Bus interface name.

Asynchronous getter for the remote object property RemoteCredentials of type Tp::StreamCredentials.

The ICE credentials used for all candidates. If each candidate has different credentials, then this property SHOULD be ("", ""). Per-candidate credentials are set in the Candidate's Candidate_Info a{sv}.

Returns:
A pending variant which will emit finished when the property has been retrieved.

Asynchronous getter for the remote object property RemoteCandidates of type Tp::CandidateList.

A list of candidates for this endpoint.

Returns:
A pending variant which will emit finished when the property has been retrieved.

Asynchronous getter for the remote object property SelectedCandidatePairs of type Tp::CandidatePairList.

The candidates that have been selected for use to stream packets to the remote contact for each component of the stream. Change notification is given via the the CandidatePairSelected() signal.

Note to client implementors (from RFC 5245 section 9.2.2.3):

If at least one of the pairs is In-Progress, the agent SHOULD wait for those checks to complete, and as each completes, redo the processing in this section until there are no losing pairs.

Also note that some or all of the local candidates in this list may represent a peer-reflexive candidate that do not appear in CallStreamInterfaceMediaInterface::LocalCandidates .

See RFC 5245 Appendix B.6. for more details about why this is.

Returns:
A pending variant which will emit finished when the property has been retrieved.

Asynchronous getter for the remote object property EndpointState of type Tp::ComponentStateMap.

The state of ICE negotiation with this Endpoint for each component of the stream.

Returns:
A pending variant which will emit finished when the property has been retrieved.

Asynchronous getter for the remote object property Transport of type uint.

The transport type for the stream endpoint. This can be different from the transport of the Stream in the case where of falling back from ICE to Raw_UDP.

Returns:
A pending variant which will emit finished when the property has been retrieved.

Asynchronous getter for the remote object property Controlling of type bool.

The local side is taking the controlling role (as defined by ICE RFC 5245). Change notification is given via the ControllingChanged() signal.

In ICE, the Caller is normally in controlling mode (and the Callee in controlled-mode), except if the Caller is doing ICE-Lite, in which case it's reversed. The Controlling side is responsible for selecting nominated pairs, and generating updated offers upon conclusion of ICE.
Returns:
A pending variant which will emit finished when the property has been retrieved.

Asynchronous getter for the remote object property IsICELite of type bool.

The Remote side is an ICE Lite endpoint. (The local side is assumed to always be an ICE Full implementation.)

Returns:
A pending variant which will emit finished when the property has been retrieved.

Request all of the DBus properties on the interface.

Returns:
A pending variant map which will emit finished when the properties have been retrieved.
QDBusPendingReply Tp::Client::CallStreamEndpointInterface::SetSelectedCandidatePair ( const Tp::Candidate localCandidate,
const Tp::Candidate remoteCandidate,
int  timeout = -1 
) [inline, slot]

Begins a call to the D-Bus method SetSelectedCandidatePair on the remote object.

Update the entry in SelectedCandidatePairs for a particular component, and signal it to the remote side.

This method should only be called by the controlling side of an ICE session. See CandidatePairSelected() for details.

In the SDP offer/answer model, this signalling will take place as generating an updated offer. Note that updates may be queued up until information about all components of all streams is gathered.

Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.

Parameters:
localCandidateThe local candidate that has been selected.
remoteCandidateThe remote candidate that has been selected.
timeoutThe timeout in milliseconds.
QDBusPendingReply Tp::Client::CallStreamEndpointInterface::SetEndpointState ( uint  component,
uint  state,
int  timeout = -1 
) [inline, slot]

Begins a call to the D-Bus method SetEndpointState on the remote object.

Change the EndpointState of the endpoint.

Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.

Parameters:
componentThe component whose state needs updating.
stateThe new state of this component.
timeoutThe timeout in milliseconds.
QDBusPendingReply Tp::Client::CallStreamEndpointInterface::AcceptSelectedCandidatePair ( const Tp::Candidate localCandidate,
const Tp::Candidate remoteCandidate,
int  timeout = -1 
) [inline, slot]

Begins a call to the D-Bus method AcceptSelectedCandidatePair on the remote object.

Called in response to CandidatePairSelected if/when this candidate pair is known to have passed its connectivity checks.

Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.

Parameters:
localCandidateThe local candidate that has been selected.
remoteCandidateThe remote candidate that has been selected.
timeoutThe timeout in milliseconds.
QDBusPendingReply Tp::Client::CallStreamEndpointInterface::RejectSelectedCandidatePair ( const Tp::Candidate localCandidate,
const Tp::Candidate remoteCandidate,
int  timeout = -1 
) [inline, slot]

Begins a call to the D-Bus method RejectSelectedCandidatePair on the remote object.

Called in response to CandidatePairSelected if/when this candidate pair is known to have failed its connectivity checks.

Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.

Parameters:
localCandidateThe local candidate that has been selected.
remoteCandidateThe remote candidate that has been selected.
timeoutThe timeout in milliseconds.
QDBusPendingReply Tp::Client::CallStreamEndpointInterface::SetControlling ( bool  controlling,
int  timeout = -1 
) [inline, slot]

Begins a call to the D-Bus method SetControlling on the remote object.

Set whether the local side is taking the Controlling role. Note that if there are multiple endpoints (e.g. SIP call forking) it may be the case that all endpoints need to have the same controlling/controlled orientation.

Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.

Parameters:
controllingThe new value of Controlling.
timeoutThe timeout in milliseconds.
void Tp::Client::CallStreamEndpointInterface::RemoteCredentialsSet ( const QString &  username,
const QString &  password 
) [signal]

Represents the signal RemoteCredentialsSet on the remote object.

Emitted when the remote ICE credentials for the endpoint are set. If each candidate has different credentials, then this signal will never be fired.

Parameters:
usernameThe username set.
passwordThe password set.

Represents the signal RemoteCandidatesAdded on the remote object.

Emitted when remote candidates are added to the RemoteCandidates property.

Parameters:
candidatesThe candidates that were added.
void Tp::Client::CallStreamEndpointInterface::CandidatePairSelected ( const Tp::Candidate localCandidate,
const Tp::Candidate remoteCandidate 
) [signal]

Represents the signal CandidatePairSelected on the remote object.

Emitted when a candidate is selected for use in the stream by the controlling side of an ICE session. The controlled side should call AcceptSelectedCandidatePair or RejectSelectedCandidatePair when connectivity checks have either succeeded or failed for this candidate pair. See also: SelectedCandidatePairs.

Parameters:
localCandidateThe local candidate that has been selected.
remoteCandidateThe remote candidate that has been selected.
void Tp::Client::CallStreamEndpointInterface::EndpointStateChanged ( uint  component,
uint  state 
) [signal]

Represents the signal EndpointStateChanged on the remote object.

Emitted when the EndpointState property changes.

Parameters:
componentThe component whose state has changed.
stateThe new state of this component.

Represents the signal ControllingChanged on the remote object.

The value of Controlling has changed.

Parameters:
controllingThe new value of Controlling.
void Tp::Client::CallStreamEndpointInterface::invalidate ( Tp::DBusProxy proxy,
const QString &  error,
const QString &  message 
) [protected, virtual]

Reimplemented from Tp::AbstractInterface.


Copyright © 2008-2011 Collabora Ltd. and Nokia Corporation
Telepathy-Qt 0.9.3