#include <TelepathyQt4/Client/MediaStreamHandler>
Public Slots | |
QDBusPendingReply | CodecChoice (uint codecID) |
QDBusPendingReply | Error (uint errorCode, const QString &message) |
QDBusPendingReply | NativeCandidatesPrepared () |
QDBusPendingReply | NewActiveCandidatePair (const QString &nativeCandidateID, const QString &remoteCandidateID) |
QDBusPendingReply | NewNativeCandidate (const QString &candidateID, const Telepathy::MediaStreamHandlerTransportList &transports) |
QDBusPendingReply | Ready (const Telepathy::MediaStreamHandlerCodecList &codecs) |
QDBusPendingReply | SetLocalCodecs (const Telepathy::MediaStreamHandlerCodecList &codecs) |
QDBusPendingReply | StreamState (uint state) |
QDBusPendingReply | SupportedCodecs (const Telepathy::MediaStreamHandlerCodecList &codecs) |
QDBusPendingReply | CodecsUpdated (const Telepathy::MediaStreamHandlerCodecList &codecs) |
QDBusPendingReply | HoldState (bool held) |
QDBusPendingReply | UnholdFailure () |
Signals | |
void | AddRemoteCandidate (const QString &candidateID, const Telepathy::MediaStreamHandlerTransportList &transports) |
void | Close () |
void | RemoveRemoteCandidate (const QString &candidateID) |
void | SetActiveCandidatePair (const QString &nativeCandidateID, const QString &remoteCandidateID) |
void | SetRemoteCandidateList (const Telepathy::MediaStreamHandlerCandidateList &remoteCandidates) |
void | SetRemoteCodecs (const Telepathy::MediaStreamHandlerCodecList &codecs) |
void | SetStreamPlaying (bool playing) |
void | SetStreamSending (bool sending) |
void | StartTelephonyEvent (uchar event) |
void | StopTelephonyEvent () |
void | SetStreamHeld (bool held) |
Public Member Functions | |
MediaStreamHandlerInterface (const QString &serviceName, const QString &objectPath, QObject *parent=0) | |
MediaStreamHandlerInterface (const QDBusConnection &connection, const QString &serviceName, const QString &objectPath, QObject *parent=0) | |
MediaStreamHandlerInterface (Telepathy::Client::DBusProxy *proxy) | |
Static Public Member Functions | |
static const char * | staticInterfaceName () |
Protected Member Functions | |
virtual void | invalidate (Telepathy::Client::DBusProxy *, const QString &, const QString &) |
Telepathy::Client::MediaStreamHandlerInterface::MediaStreamHandlerInterface | ( | const QString & | serviceName, | |
const QString & | objectPath, | |||
QObject * | parent = 0 | |||
) |
Creates a MediaStreamHandlerInterface associated with the given object on the session bus.
serviceName | Name of the service the object is on. | |
objectPath | Path to the object on the service. | |
parent | Passed to the parent class constructor. |
Telepathy::Client::MediaStreamHandlerInterface::MediaStreamHandlerInterface | ( | const QDBusConnection & | connection, | |
const QString & | serviceName, | |||
const QString & | objectPath, | |||
QObject * | parent = 0 | |||
) |
Creates a MediaStreamHandlerInterface associated with the given object on the given bus.
connection | The bus via which the object can be reached. | |
serviceName | Name of the service the object is on. | |
objectPath | Path to the object on the service. | |
parent | Passed to the parent class constructor. |
Telepathy::Client::MediaStreamHandlerInterface::MediaStreamHandlerInterface | ( | Telepathy::Client::DBusProxy * | proxy | ) |
Creates a MediaStreamHandlerInterface associated with the same object as the given proxy.
proxy | The proxy to use. It will also be the QObject::parent() for this object. |
void Telepathy::Client::MediaStreamHandlerInterface::AddRemoteCandidate | ( | const QString & | candidateID, | |
const Telepathy::MediaStreamHandlerTransportList & | transports | |||
) | [signal] |
Represents the signal "AddRemoteCandidate" on the remote object.
Signal emitted when the connection manager wishes to inform the client of a new remote candidate.
candidateID | String identifier for this candidate | |
transports | Array of transports for this candidate with fields, as defined in NewNativeCandidate |
void Telepathy::Client::MediaStreamHandlerInterface::Close | ( | ) | [signal] |
Represents the signal "Close" on the remote object.
Signal emitted when the connection manager wishes the stream to be closed.
QDBusPendingReply Telepathy::Client::MediaStreamHandlerInterface::CodecChoice | ( | uint | codecID | ) | [inline, slot] |
Begins a call to the D-Bus method "CodecChoice" on the remote object.
Inform the connection manager of codec used to receive data.
References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().
QDBusPendingReply Telepathy::Client::MediaStreamHandlerInterface::CodecsUpdated | ( | const Telepathy::MediaStreamHandlerCodecList & | codecs | ) | [inline, slot] |
Begins a call to the D-Bus method "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.
codecs | Locally supported codecs, which SHOULD be the same as were previously in effect, but possibly with different parameters. |
References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().
QDBusPendingReply Telepathy::Client::MediaStreamHandlerInterface::Error | ( | uint | errorCode, | |
const QString & | message | |||
) | [inline, slot] |
Begins a call to the D-Bus method "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.
errorCode | ID of error, from the MediaStreamError enumeration | |
message | String describing the error |
References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().
QDBusPendingReply Telepathy::Client::MediaStreamHandlerInterface::HoldState | ( | bool | held | ) | [inline, slot] |
Begins a call to the D-Bus method "HoldState" on the remote object.
Notify the connection manager that the stream's hold state has been changed successfully in response to SetStreamHeld.
held | If true, the stream is now on hold. |
References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().
virtual void Telepathy::Client::MediaStreamHandlerInterface::invalidate | ( | Telepathy::Client::DBusProxy * | , | |
const QString & | , | |||
const QString & | ||||
) | [protected, virtual] |
Reimplemented from Telepathy::Client::AbstractInterface.
QDBusPendingReply Telepathy::Client::MediaStreamHandlerInterface::NativeCandidatesPrepared | ( | ) | [inline, slot] |
Begins a call to the D-Bus method "NativeCandidatesPrepared" on the remote object.
Informs the connection manager that all possible native candisates have been discovered for the moment.
References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().
QDBusPendingReply Telepathy::Client::MediaStreamHandlerInterface::NewActiveCandidatePair | ( | const QString & | nativeCandidateID, | |
const QString & | remoteCandidateID | |||
) | [inline, slot] |
Begins a call to the D-Bus method "NewActiveCandidatePair" on the remote object.
Informs the connection manager that a valid candidate pair has been discovered and streaming is in progress.
References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().
QDBusPendingReply Telepathy::Client::MediaStreamHandlerInterface::NewNativeCandidate | ( | const QString & | candidateID, | |
const Telepathy::MediaStreamHandlerTransportList & | transports | |||
) | [inline, slot] |
Begins a call to the D-Bus method "NewNativeCandidate" on the remote object.
Inform this MediaStreamHandler that a new native transport candidate has been ascertained.
candidateID | String identifier for this candidate | |
transports | Array of transports for this candidate, with fields:
|
References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().
QDBusPendingReply Telepathy::Client::MediaStreamHandlerInterface::Ready | ( | const Telepathy::MediaStreamHandlerCodecList & | codecs | ) | [inline, slot] |
Begins a call to the D-Bus method "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.
codecs | Locally-supported codecs. |
References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().
void Telepathy::Client::MediaStreamHandlerInterface::RemoveRemoteCandidate | ( | const QString & | candidateID | ) | [signal] |
Represents the signal "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.
candidateID | String identifier for remote candidate to drop |
void Telepathy::Client::MediaStreamHandlerInterface::SetActiveCandidatePair | ( | const QString & | nativeCandidateID, | |
const QString & | remoteCandidateID | |||
) | [signal] |
Represents the signal "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.
QDBusPendingReply Telepathy::Client::MediaStreamHandlerInterface::SetLocalCodecs | ( | const Telepathy::MediaStreamHandlerCodecList & | codecs | ) | [inline, slot] |
Begins a call to the D-Bus method "SetLocalCodecs" on the remote object.
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.
This is useful for gatewaying calls between two connection managers. Given an incoming call, you need to call <tp:member-ref>Ready</tp:member-ref> 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.
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.
codecs | Locally-supported codecs |
References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().
void Telepathy::Client::MediaStreamHandlerInterface::SetRemoteCandidateList | ( | const Telepathy::MediaStreamHandlerCandidateList & | remoteCandidates | ) | [signal] |
Represents the signal "SetRemoteCandidateList" on the remote object.
Signal emitted when the connection manager wishes to inform the client of all the available remote candidates at once.
remoteCandidates | A list of candidate id and a list of transports as defined in NewNativeCandidate |
void Telepathy::Client::MediaStreamHandlerInterface::SetRemoteCodecs | ( | const Telepathy::MediaStreamHandlerCodecList & | codecs | ) | [signal] |
Represents the signal "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.
codecs | Codecs supported by the remote peer. |
void Telepathy::Client::MediaStreamHandlerInterface::SetStreamHeld | ( | bool | held | ) | [signal] |
Represents the signal "SetStreamHeld" on the remote object.
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).
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.
<tp:rationale>
It is assumed that relinquishing a resource will not fail. If it does, the call is probably doomed anyway. </tp:rationale>
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.
<tp:rationale>
This means that if a resource is unavailable, the remote contact will never even be told that we tried to acquire it. </tp:rationale>
held | If true, the stream is to be placed on hold. |
void Telepathy::Client::MediaStreamHandlerInterface::SetStreamPlaying | ( | bool | playing | ) | [signal] |
Represents the signal "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 Telepathy::Client::MediaStreamHandlerInterface::SetStreamSending | ( | bool | sending | ) | [signal] |
Represents the signal "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 Telepathy::Client::MediaStreamHandlerInterface::StartTelephonyEvent | ( | uchar | event | ) | [signal] |
Represents the signal "StartTelephonyEvent" on the remote object.
Request that a telephony event (as defined by RFC 4733) is transmitted over this stream until StopTelephonyEvent is called.
event | A telephony event code as defined by RFC 4733. |
static const char* Telepathy::Client::MediaStreamHandlerInterface::staticInterfaceName | ( | ) | [inline, static] |
Returns the name of the interface "org.freedesktop.Telepathy.Media.StreamHandler", which this class represents.
void Telepathy::Client::MediaStreamHandlerInterface::StopTelephonyEvent | ( | ) | [signal] |
Represents the signal "StopTelephonyEvent" on the remote object.
Request that any ongoing telephony events (as defined by RFC 4733) being transmitted over this stream are stopped.
QDBusPendingReply Telepathy::Client::MediaStreamHandlerInterface::StreamState | ( | uint | state | ) | [inline, slot] |
Begins a call to the D-Bus method "StreamState" on the remote object.
Informs the connection manager of the stream's current state, as as specified in Channel.Type.StreamedMedia::ListStreams.
References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().
QDBusPendingReply Telepathy::Client::MediaStreamHandlerInterface::SupportedCodecs | ( | const Telepathy::MediaStreamHandlerCodecList & | codecs | ) | [inline, slot] |
Begins a call to the D-Bus method "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.
codecs | Locally supported codecs. |
References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().
QDBusPendingReply Telepathy::Client::MediaStreamHandlerInterface::UnholdFailure | ( | ) | [inline, slot] |
Begins a call to the D-Bus method "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.
References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().