#include <TelepathyQt/CallStreamEndpoint>

Inherits Tp::AbstractInterface.

Public Slots
QDBusPendingReply	SetSelectedCandidatePair (const Tp::Candidate &localCandidate, const Tp::Candidate &remoteCandidate, int timeout=-1)

QDBusPendingReply	SetEndpointState (uint component, uint state, int timeout=-1)

QDBusPendingReply	AcceptSelectedCandidatePair (const Tp::Candidate &localCandidate, const Tp::Candidate &remoteCandidate, int timeout=-1)

QDBusPendingReply	RejectSelectedCandidatePair (const Tp::Candidate &localCandidate, const Tp::Candidate &remoteCandidate, int timeout=-1)

QDBusPendingReply	SetControlling (bool controlling, int timeout=-1)

Signals
void	RemoteCredentialsSet (const QString &username, const QString &password)

void	RemoteCandidatesAdded (const Tp::CandidateList &candidates)

void	CandidatePairSelected (const Tp::Candidate &localCandidate, const Tp::Candidate &remoteCandidate)

void	EndpointStateChanged (uint component, uint state)

void	ControllingChanged (bool controlling)

Signals inherited from Tp::AbstractInterface
void	propertiesChanged (const QVariantMap &changedProperties, const QStringList &invalidatedProperties)

Public Member Functions
	CallStreamEndpointInterface (const QString &busName, const QString &objectPath, QObject *parent=0)

	CallStreamEndpointInterface (const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)

	CallStreamEndpointInterface (Tp::DBusProxy *proxy)

Tp::PendingVariant *	requestPropertyRemoteCredentials () const

Tp::PendingVariant *	requestPropertyRemoteCandidates () const

Tp::PendingVariant *	requestPropertySelectedCandidatePairs () const

Tp::PendingVariant *	requestPropertyEndpointState () const

Tp::PendingVariant *	requestPropertyTransport () const

Tp::PendingVariant *	requestPropertyControlling () const

Tp::PendingVariant *	requestPropertyIsICELite () const

Tp::PendingVariantMap *	requestAllProperties () const

Public Member Functions inherited from Tp::AbstractInterface
virtual	~AbstractInterface ()

bool	isValid () const

QString	invalidationReason () const

QString	invalidationMessage () const

void	setMonitorProperties (bool monitorProperties)

bool	isMonitoringProperties () const

Static Public Member Functions
static QLatin1String	staticInterfaceName ()

Protected Member Functions
virtual void	invalidate (Tp::DBusProxy *, const QString &, const QString &)

Protected Member Functions inherited from Tp::AbstractInterface
	AbstractInterface (DBusProxy *proxy, const QLatin1String &interface)

	AbstractInterface (const QString &busName, const QString &path, const QLatin1String &interface, const QDBusConnection &connection, QObject *parent)

PendingVariant *	internalRequestProperty (const QString &name) const

PendingOperation *	internalSetProperty (const QString &name, const QVariant &newValue)

PendingVariantMap *	internalRequestAllProperties () const

Additional Inherited Members
Protected Slots inherited from Tp::AbstractInterface

Detailed Description

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

Constructor & Destructor Documentation

◆ CallStreamEndpointInterface() [1/3]

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

busName	Name of the service the object is on.
objectPath	Path to the object on the service.
parent	Passed to the parent class constructor.

◆ CallStreamEndpointInterface() [2/3]

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

connection	The bus via which the object can be reached.
busName	Name of the service the object is on.
objectPath	Path to the object on the service.
parent	Passed to the parent class constructor.

◆ CallStreamEndpointInterface() [3/3]

Tp::Client::CallStreamEndpointInterface::CallStreamEndpointInterface ( Tp::DBusProxy * proxy )

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

Parameters

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

Member Function Documentation

◆ staticInterfaceName()

static QLatin1String Tp::Client::CallStreamEndpointInterface::staticInterfaceName ( )

inlinestatic

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

Returns: The D-Bus interface name.

◆ requestPropertyRemoteCredentials()

Tp::PendingVariant* Tp::Client::CallStreamEndpointInterface::requestPropertyRemoteCredentials ( ) const

inline

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.

◆ requestPropertyRemoteCandidates()

Tp::PendingVariant* Tp::Client::CallStreamEndpointInterface::requestPropertyRemoteCandidates ( ) const

inline

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.

◆ requestPropertySelectedCandidatePairs()

Tp::PendingVariant* Tp::Client::CallStreamEndpointInterface::requestPropertySelectedCandidatePairs ( ) const

inline

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.

◆ requestPropertyEndpointState()

Tp::PendingVariant* Tp::Client::CallStreamEndpointInterface::requestPropertyEndpointState ( ) const

inline

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.

◆ requestPropertyTransport()

Tp::PendingVariant* Tp::Client::CallStreamEndpointInterface::requestPropertyTransport ( ) const

inline

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.

◆ requestPropertyControlling()

Tp::PendingVariant* Tp::Client::CallStreamEndpointInterface::requestPropertyControlling ( ) const

inline

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.

◆ requestPropertyIsICELite()

Tp::PendingVariant* Tp::Client::CallStreamEndpointInterface::requestPropertyIsICELite ( ) const

inline

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.

◆ requestAllProperties()

Tp::PendingVariantMap* Tp::Client::CallStreamEndpointInterface::requestAllProperties ( ) const

inline

Request all of the DBus properties on the interface.

Returns: A pending variant map which will emit finished when the properties have been retrieved.

◆ SetSelectedCandidatePair

QDBusPendingReply Tp::Client::CallStreamEndpointInterface::SetSelectedCandidatePair	(	const Tp::Candidate &	localCandidate,
		const Tp::Candidate &	remoteCandidate,
		int	timeout = `-1`
	)

inlineslot

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

localCandidate	The local candidate that has been selected.
remoteCandidate	The remote candidate that has been selected.
timeout	The timeout in milliseconds.

◆ SetEndpointState

QDBusPendingReply Tp::Client::CallStreamEndpointInterface::SetEndpointState	(	uint	component,
		uint	state,
		int	timeout = `-1`
	)

inlineslot

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

component	The component whose state needs updating.
state	The new state of this component.
timeout	The timeout in milliseconds.

◆ AcceptSelectedCandidatePair

QDBusPendingReply Tp::Client::CallStreamEndpointInterface::AcceptSelectedCandidatePair	(	const Tp::Candidate &	localCandidate,
		const Tp::Candidate &	remoteCandidate,
		int	timeout = `-1`
	)

inlineslot

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

localCandidate	The local candidate that has been selected.
remoteCandidate	The remote candidate that has been selected.
timeout	The timeout in milliseconds.

◆ RejectSelectedCandidatePair

QDBusPendingReply Tp::Client::CallStreamEndpointInterface::RejectSelectedCandidatePair	(	const Tp::Candidate &	localCandidate,
		const Tp::Candidate &	remoteCandidate,
		int	timeout = `-1`
	)

inlineslot

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

localCandidate	The local candidate that has been selected.
remoteCandidate	The remote candidate that has been selected.
timeout	The timeout in milliseconds.

◆ SetControlling

QDBusPendingReply Tp::Client::CallStreamEndpointInterface::SetControlling	(	bool	controlling,
		int	timeout = `-1`
	)

inlineslot

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

controlling	The new value of Controlling.
timeout	The timeout in milliseconds.

◆ RemoteCredentialsSet

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

username	The username set.
password	The password set.

◆ RemoteCandidatesAdded

void Tp::Client::CallStreamEndpointInterface::RemoteCandidatesAdded ( const Tp::CandidateList & candidates )

signal

Represents the signal RemoteCandidatesAdded on the remote object.

Emitted when remote candidates are added to the RemoteCandidates property.

Parameters

candidates

The candidates that were added.

◆ CandidatePairSelected

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

localCandidate	The local candidate that has been selected.
remoteCandidate	The remote candidate that has been selected.

◆ EndpointStateChanged

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

component	The component whose state has changed.
state	The new state of this component.

◆ ControllingChanged

void Tp::Client::CallStreamEndpointInterface::ControllingChanged ( bool controlling )

signal

Represents the signal ControllingChanged on the remote object.

The value of Controlling has changed.

Parameters

controlling

The new value of Controlling.

◆ invalidate()

void Tp::Client::CallStreamEndpointInterface::invalidate	(	Tp::DBusProxy *	proxy,
		const QString &	error,
		const QString &	message
	)

protectedvirtual

Reimplemented from Tp::AbstractInterface.

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CallStreamEndpointInterface() [1/3]

◆ CallStreamEndpointInterface() [2/3]

◆ CallStreamEndpointInterface() [3/3]

Member Function Documentation

◆ staticInterfaceName()

◆ requestPropertyRemoteCredentials()

◆ requestPropertyRemoteCandidates()

◆ requestPropertySelectedCandidatePairs()

◆ requestPropertyEndpointState()

◆ requestPropertyTransport()

◆ requestPropertyControlling()

◆ requestPropertyIsICELite()

◆ requestAllProperties()

◆ SetSelectedCandidatePair

◆ SetEndpointState

◆ AcceptSelectedCandidatePair

◆ RejectSelectedCandidatePair

◆ SetControlling

◆ RemoteCredentialsSet

◆ RemoteCandidatesAdded

◆ CandidatePairSelected

◆ EndpointStateChanged

◆ ControllingChanged

◆ invalidate()