Home · Modules · All Classes · All Namespaces |
#include <TelepathyQt/CallStream>
Inherits Tp::AbstractInterface.
Public Slots | |
QDBusPendingReply | CompleteSendingStateChange (uint state, int timeout=-1) |
QDBusPendingReply | ReportSendingFailure (uint reason, const QString &error, const QString &message, int timeout=-1) |
QDBusPendingReply | CompleteReceivingStateChange (uint state, int timeout=-1) |
QDBusPendingReply | ReportReceivingFailure (uint reason, const QString &error, const QString &message, int timeout=-1) |
QDBusPendingReply | SetCredentials (const QString &username, const QString &password, int timeout=-1) |
QDBusPendingReply | AddCandidates (const Tp::CandidateList &candidates, int timeout=-1) |
QDBusPendingReply | FinishInitialCandidates (int timeout=-1) |
QDBusPendingReply | Fail (const Tp::CallStateReason &reason, int timeout=-1) |
Signals | |
void | SendingStateChanged (uint state) |
void | ReceivingStateChanged (uint state) |
void | LocalCandidatesAdded (const Tp::CandidateList &candidates) |
void | LocalCredentialsChanged (const QString &username, const QString &password) |
void | RelayInfoChanged (const Tp::StringVariantMapList &relayInfo) |
void | STUNServersChanged (const Tp::SocketAddressIPList &servers) |
void | ServerInfoRetrieved () |
void | EndpointsChanged (const Tp::ObjectPathList &endpointsAdded, const Tp::ObjectPathList &endpointsRemoved) |
void | ICERestartRequested () |
Signals inherited from Tp::AbstractInterface | |
void | propertiesChanged (const QVariantMap &changedProperties, const QStringList &invalidatedProperties) |
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 |
Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Call1.Stream.Interface.Media".
Tp::Client::CallStreamInterfaceMediaInterface::CallStreamInterfaceMediaInterface | ( | const QString & | busName, |
const QString & | objectPath, | ||
QObject * | parent = 0 |
||
) |
Creates a CallStreamInterfaceMediaInterface associated with the given object on the session bus.
busName | Name of the service the object is on. |
objectPath | Path to the object on the service. |
parent | Passed to the parent class constructor. |
Tp::Client::CallStreamInterfaceMediaInterface::CallStreamInterfaceMediaInterface | ( | const QDBusConnection & | connection, |
const QString & | busName, | ||
const QString & | objectPath, | ||
QObject * | parent = 0 |
||
) |
Creates a CallStreamInterfaceMediaInterface associated with the given object on the given bus.
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. |
Tp::Client::CallStreamInterfaceMediaInterface::CallStreamInterfaceMediaInterface | ( | Tp::DBusProxy * | proxy | ) |
Creates a CallStreamInterfaceMediaInterface associated with the same object as the given proxy.
proxy | The proxy to use. It will also be the QObject::parent() for this object. |
|
explicit |
Creates a CallStreamInterfaceMediaInterface associated with the same object as the given proxy. Additionally, the created proxy will have the same parent as the given proxy.
mainInterface | The proxy to use. |
Tp::Client::CallStreamInterfaceMediaInterface::CallStreamInterfaceMediaInterface | ( | const Tp::Client::CallStreamInterface & | mainInterface, |
QObject * | parent | ||
) |
Creates a CallStreamInterfaceMediaInterface associated with the same object as the given proxy. However, a different parent object can be specified.
mainInterface | The proxy to use. |
parent | Passed to the parent class constructor. |
|
inlinestatic |
Returns the name of the interface "org.freedesktop.Telepathy.Call1.Stream.Interface.Media", which this class represents.
|
inline |
Asynchronous getter for the remote object property SendingState
of type uint
.
Indicates whether the streaming implementation is/should be sending media for this stream. The streaming implementation should be able to rely on reading this value and listening to SendingStateChanged to determine whether it should be sending media or not. It should not need to listen to the Hold interfaces on the Call/Content. Feedback on success should be given via CompleteSendingStateChange. Failures should be reported via ReportSendingFailure.
|
inline |
Asynchronous getter for the remote object property ReceivingState
of type uint
.
The counterpart of SendingState. Indicates whether the streaming implementation is/should be expecting to receive media for this stream. The CM should only tell the streaming implementation to stop receiving if it has been told to put the stream on hold, or the stream has been removed from the call.
|
inline |
Asynchronous getter for the remote object property Transport
of type uint
.
The transport for this stream.
|
inline |
Asynchronous getter for the remote object property LocalCandidates
of type Tp::CandidateList
.
[FIXME]. Change notification is via the LocalCandidatesAdded signal.
|
inline |
Asynchronous getter for the remote object property LocalCredentials
of type Tp::StreamCredentials
.
The local credentials are sent to the remote site over the signalling protocol. They are used in ICE to make sure that the connectivity checks come from the right peer. Change notification is via the LocalCredentialsChanged signal. This property will be a pair of empty strings if ICE has not yet been started.
|
inline |
Asynchronous getter for the remote object property STUNServers
of type 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. Change notification is via the STUNServersChanged() signal. The IP addresses MUST NOT be given as DNS hostnames.
|
inline |
Asynchronous getter for the remote object property RelayInfo
of type Tp::StringVariantMapList
.
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. Well-known map keys are:
ip
- stype
- sEither udp
for UDP (UDP MUST be assumed if this
key is omitted), tcp
for TCP, or
tls
.
The precise meaning of this key depends on the
Transport property: if
Transport is ICE, tls
means
TLS over TCP as referenced by ICE draft 19, and if
Transport is GTalk_P2P, tls
means
a fake SSL session over TCP as implemented by libjingle.
port
- qunique-id
- stype
s, there
is usually little point in connecting to both. Use
priority
to determine which version to prefer in this
case. Can also be used by the streaming implementation to avoid
connecting to the same relay multiple times if relaying is
required for both audio and video.priority
- uunique-id
,
the one with the highest priority should be used, or the streaming
implementation should use the one whose type
has the
most desirable properties)username
- spassword
- scomponent
- uAn 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.
The type of relay server that this represents depends on the value of the Transport property. If Transport is ICE, this is a TURN server; if Transport is GTalk_P2P, this is a Google relay server; otherwise, the meaning of RelayInfo is undefined.
If relaying is not possible for this stream, the list is empty.
Change notification is given via the RelayInfoChanged() signal.
|
inline |
Asynchronous getter for the remote object property HasServerInfo
of type bool
.
True if all the initial information about STUN servers and Relay servers has been retrieved. Change notification is via the ServerInfoRetrieved() signal.
|
inline |
Asynchronous getter for the remote object property Endpoints
of type Tp::ObjectPathList
.
The list of Endpoint objects that exist for this stream. Change notification is via the EndpointsChanged signal.
|
inline |
Asynchronous getter for the remote object property ICERestartPending
of type bool
.
State recovery for ICERestartRequested. Set when the signal is emitted, and unset when SetCredentials is called. Useful for debugging.
|
inline |
Request all of the DBus properties on the interface.
|
inlineslot |
Begins a call to the D-Bus method CompleteSendingStateChange
on the remote object.
Called in response to SendingStateChanged() (Pending_*, *) to indicate that the media state has successfully progressed from Pending_{Start, Stop, Pause} to the corresponding non-pending state.
Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
state | The new (non-pending) value of SendingState. |
timeout | The timeout in milliseconds. |
|
inlineslot |
Begins a call to the D-Bus method ReportSendingFailure
on the remote object.
Can be called at any point to indicate a failure in the outgoing portion of the stream.
Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
timeout | The timeout in milliseconds. |
|
inlineslot |
Begins a call to the D-Bus method CompleteReceivingStateChange
on the remote object.
Called in response to ReceivingStateChanged() (Pending_*, *) to indicate that the media state has successfully progressed from Pending_{Start, Stop, Pause} to the corresponding non-pending state.
Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
state | The new (non-pending) value of ReceivingState. |
timeout | The timeout in milliseconds. |
|
inlineslot |
Begins a call to the D-Bus method ReportReceivingFailure
on the remote object.
Can be called at any point to indicate a failure in the incoming portion of the stream.
Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
timeout | The timeout in milliseconds. |
|
inlineslot |
Begins a call to the D-Bus method SetCredentials
on the remote object.
Used to set the username fragment and password for streams that have global credentials.
Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
username | The username to use when authenticating on the stream. |
password | The password to use when authenticating on the stream. |
timeout | The timeout in milliseconds. |
|
inlineslot |
Begins a call to the D-Bus method AddCandidates
on the remote object.
Add candidates to the LocalCandidates property and signal them to the remote contact(s). Note that connection managers MAY delay the sending of candidates until FinishInitialCandidates is called.
Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
candidates | The candidates to be added. |
timeout | The timeout in milliseconds. |
|
inlineslot |
Begins a call to the D-Bus method FinishInitialCandidates
on the remote object.
This indicates to the CM that the initial batch of candidates has been added, and should now be processed/sent to the remote side. Protocols supporting Raw UDP SHOULD wait for FinishInitialCandidates, and then set the lowest priority candidate as the Raw UDP candidate.
Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
timeout | The timeout in milliseconds. |
|
inlineslot |
Begins a call to the D-Bus method Fail
on the remote object.
Signal an unrecoverable error for this stream, and remove it. If all streams are removed from a content, then it will also be removed.
Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
reason | A structured reason for stream removal. |
timeout | The timeout in milliseconds. |
|
signal |
Represents the signal SendingStateChanged
on the remote object.
Change notification for SendingState. Note that this information is duplicated onto the Stream interface, so that UIs can ignore the Media interface, and streaming implementations can ignore everything but the media interface.
state | The new value of SendingState. |
|
signal |
Represents the signal ReceivingStateChanged
on the remote object.
Change notification for ReceivingState.
state | The new value of ReceivingState. |
|
signal |
Represents the signal LocalCandidatesAdded
on the remote object.
Emitted when local candidates are added to the LocalCandidates property.
candidates | Candidates that have been added. |
|
signal |
Represents the signal LocalCredentialsChanged
on the remote object.
Emitted when the value of LocalCredentials changes to a non-empty value. This should only happen when the streaming implementation calls SetCredentials, so this signal is mostly useful for debugging.
|
signal |
Represents the signal RelayInfoChanged
on the remote object.
Emitted when the value of RelayInfo changes.
|
signal |
Represents the signal STUNServersChanged
on the remote object.
Emitted when the value of STUNServers changes.
|
signal |
Represents the signal ServerInfoRetrieved
on the remote object.
Signals that the initial information about STUN and Relay servers has been retrieved, i.e. the HasServerInfo property is now true.
|
signal |
Represents the signal EndpointsChanged
on the remote object.
Emitted when the Endpoints property changes.
endpointsAdded | Endpoints that were added. |
endpointsRemoved | Endpoints that no longer exist. |
|
signal |
Represents the signal ICERestartRequested
on the remote object.
Emitted when the remote side requests an ICE restart (e.g. third party call control, when the remote endpoint changes). The streaming implementation should call SetCredentials again.
|
protectedvirtual |
Reimplemented from Tp::AbstractInterface.
TelepathyQt 0.9.8 | Generated by 1.8.15 |