Home · All Classes · All Namespaces · Modules · Functions · Files

Tpy::Client::CallStreamEndpointInterface Class Reference

#include <TelepathyQt4Yell/Channel>

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.Call.Stream.Endpoint.DRAFT."


Constructor & Destructor Documentation

Tpy::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.
Tpy::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.
Tpy::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.
Tpy::Client::CallStreamEndpointInterface::CallStreamEndpointInterface ( const Tp::Client::ChannelInterface &  mainInterface  )  [explicit]

Creates a CallStreamEndpointInterface associated with the same object as the given proxy. Additionally, the created proxy will have the same parent as the given proxy.

Parameters:
mainInterface The proxy to use.
Tpy::Client::CallStreamEndpointInterface::CallStreamEndpointInterface ( const Tp::Client::ChannelInterface &  mainInterface,
QObject *  parent 
)

Creates a CallStreamEndpointInterface associated with the same object as the given proxy. However, a different parent object can be specified.

Parameters:
mainInterface The proxy to use.
parent Passed to the parent class constructor.

Member Function Documentation

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

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

Returns:
The D-Bus interface name.
Tp::PendingVariant* Tpy::Client::CallStreamEndpointInterface::requestPropertyRemoteCredentials (  )  const [inline]

Asynchronous getter for the remote object property "RemoteCredentials" of type Tpy::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.
Tp::PendingVariant* Tpy::Client::CallStreamEndpointInterface::requestPropertyRemoteCandidates (  )  const [inline]

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

A list of candidates for this endpoint.

Returns:
A pending variant which will emit finished when the property has been retrieved.
Tp::PendingVariant* Tpy::Client::CallStreamEndpointInterface::requestPropertySelectedCandidate (  )  const [inline]

Asynchronous getter for the remote object property "SelectedCandidate" of type Tpy::Candidate.

The candidate that has been selected for use to stream packets to the remote contact. Change notification is given via the the CandidateSelected signal.

Returns:
A pending variant which will emit finished when the property has been retrieved.
Tp::PendingVariant* Tpy::Client::CallStreamEndpointInterface::requestPropertyStreamState (  )  const [inline]

Asynchronous getter for the remote object property "StreamState" of type uint.

The stream state of the endpoint.

Returns:
A pending variant which will emit finished when the property has been retrieved.
Tp::PendingVariant* Tpy::Client::CallStreamEndpointInterface::requestPropertyTransport (  )  const [inline]

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

The transport type for the stream endpoint.

Returns:
A pending variant which will emit finished when the property has been retrieved.
Tp::PendingVariantMap* Tpy::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.
QDBusPendingReply Tpy::Client::CallStreamEndpointInterface::SetSelectedCandidate ( const Tpy::Candidate candidate,
int  timeout = -1 
) [inline, slot]

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

Set the value of CandidateSelected.

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

Parameters:
candidate The candidate that has been selected.
timeout The timeout in milliseconds.
QDBusPendingReply Tpy::Client::CallStreamEndpointInterface::SetStreamState ( uint  state,
int  timeout = -1 
) [inline, slot]

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

Change the StreamState 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:
state The requested stream state.
timeout The timeout in milliseconds.
void Tpy::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.
void Tpy::Client::CallStreamEndpointInterface::RemoteCandidatesAdded ( const Tpy::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.
void Tpy::Client::CallStreamEndpointInterface::CandidateSelected ( const Tpy::Candidate candidate  )  [signal]

Represents the signal "CandidateSelected" on the remote object.

Emitted when a candidate is selected for use in the stream.

Parameters:
candidate The candidate that has been selected.
void Tpy::Client::CallStreamEndpointInterface::StreamStateChanged ( uint  state  )  [signal]

Represents the signal "StreamStateChanged" on the remote object.

Emitted when the StreamState property changes.

Parameters:
state The new StreamState value.
void Tpy::Client::CallStreamEndpointInterface::invalidate ( Tp::DBusProxy *  proxy,
const QString &  error,
const QString &  message 
) [protected, virtual]


Copyright © 2008-2010 Collabora Ltd. and Nokia Corporation
Telepathy-Qt4-Yell 0.1.6