Home · Modules · All Classes · All Namespaces |
#include <TelepathyQt/_gen/svc-channel.h>
Inherits Tp::AbstractAdaptor.
Public Slots | |
void | SetRinging (const QDBusMessage &dbusMessage) |
void | SetQueued (const QDBusMessage &dbusMessage) |
void | Accept (const QDBusMessage &dbusMessage) |
void | Hangup (uint reason, const QString &detailedHangupReason, const QString &message, const QDBusMessage &dbusMessage) |
QDBusObjectPath | AddContent (const QString &contentName, uint contentType, uint initialDirection, const QDBusMessage &dbusMessage) |
Signals | |
void | ContentAdded (const QDBusObjectPath &content) |
void | ContentRemoved (const QDBusObjectPath &content, const Tp::CallStateReason &reason) |
void | CallStateChanged (uint callState, uint callFlags, const Tp::CallStateReason &callStateReason, const QVariantMap &callStateDetails) |
void | CallMembersChanged (const Tp::CallMemberMap &flagsChanged, const Tp::HandleIdentifierMap &identifiers, const Tp::UIntList &removed, const Tp::CallStateReason &reason) |
Public Member Functions | |
Tp::ObjectPathList | Contents () const |
QVariantMap | CallStateDetails () const |
uint | CallState () const |
uint | CallFlags () const |
Tp::CallStateReason | CallStateReason () const |
bool | HardwareStreaming () const |
Tp::CallMemberMap | CallMembers () const |
Tp::HandleIdentifierMap | MemberIdentifiers () const |
uint | InitialTransport () const |
bool | InitialAudio () const |
bool | InitialVideo () const |
QString | InitialAudioName () const |
QString | InitialVideoName () const |
bool | MutableContents () const |
Public Member Functions inherited from Tp::AbstractAdaptor | |
AbstractAdaptor (const QDBusConnection &connection, QObject *adaptee, QObject *parent) | |
~AbstractAdaptor () | |
QDBusConnection | dbusConnection () const |
QObject * | adaptee () const |
Adaptor class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Type.Call1".
Tp::ObjectPathList Tp::Service::ChannelTypeCallAdaptor::Contents | ( | ) | const |
Return the value of the exported D-Bus object property Contents
of type Tp::ObjectPathList
.
Adaptees should export this property as a Qt property named 'contents' with type Tp::ObjectPathList.
The list of CallContentInterface objects that are part of this call. Change notification is via the ContentAdded() and ContentRemoved() signals.
Contents
. QVariantMap Tp::Service::ChannelTypeCallAdaptor::CallStateDetails | ( | ) | const |
Return the value of the exported D-Bus object property CallStateDetails
of type QVariantMap
.
Adaptees should export this property as a Qt property named 'callStateDetails' with type QVariantMap.
A map used to provide optional extensible details for the CallState , CallFlags and/or CallStateReason .
Well-known keys and their corresponding value types include:
forwarded-to
key
(i.e. the contact's identifier in the IM protocol).CallStateDetails
. uint Tp::Service::ChannelTypeCallAdaptor::CallState | ( | ) | const |
Return the value of the exported D-Bus object property CallState
of type uint
.
Adaptees should export this property as a Qt property named 'callState' with type uint.
The current high-level state of this call. The CallFlags provide additional information, and the CallStateReason and CallStateDetails explain the reason for the current values for those properties.
Note that when in a conference call, this property is purely to show your state in joining the call. The receiver (or remote contact) in this context is the conference server itself. The property does not change when other call members' states change.
Clients MAY consider unknown values in this property to be an error.
CallState
. uint Tp::Service::ChannelTypeCallAdaptor::CallFlags | ( | ) | const |
Return the value of the exported D-Bus object property CallFlags
of type uint
.
Adaptees should export this property as a Qt property named 'callFlags' with type uint.
Flags representing the status of the call as a whole, providing more specific information than the CallState .
Clients are expected to ignore unknown flags in this property, without error.
When an ongoing call is active and not on hold or has any other problems, this property will be 0.
CallFlags
. Tp::CallStateReason Tp::Service::ChannelTypeCallAdaptor::CallStateReason | ( | ) | const |
Return the value of the exported D-Bus object property CallStateReason
of type Tp::CallStateReason
.
Adaptees should export this property as a Qt property named 'callStateReason' with type Tp::CallStateReason.
The reason for the last change to the CallState and/or CallFlags . The CallStateDetails MAY provide additional information.
CallStateReason
. bool Tp::Service::ChannelTypeCallAdaptor::HardwareStreaming | ( | ) | const |
Return the value of the exported D-Bus object property HardwareStreaming
of type bool
.
Adaptees should export this property as a Qt property named 'hardwareStreaming' with type bool.
If this property is True, all of the media streaming is done by some mechanism outside the scope of Telepathy.
A connection manager might be intended for a specialized hardware device, which will take care of the audio streaming (e.g. telepathy-ring, which uses GSM hardware which does the actual audio streaming for the call).
If this is False, the handler is responsible for doing the actual media streaming for at least some contents itself. Those contents will have the CallContentInterfaceMediaInterface interface, to communicate the necessary information to a streaming implementation. Connection managers SHOULD operate like this, if possible.
Many connection managers (such as telepathy-gabble) only do the call signalling, and expect the client to do the actual streaming using something like Farsight, to improve latency and allow better UI integration.
HardwareStreaming
. Tp::CallMemberMap Tp::Service::ChannelTypeCallAdaptor::CallMembers | ( | ) | const |
Return the value of the exported D-Bus object property CallMembers
of type Tp::CallMemberMap
.
Adaptees should export this property as a Qt property named 'callMembers' with type Tp::CallMemberMap.
A mapping from the remote contacts that are part of this call to flags describing their status. This mapping never has the local user's handle as a key.
When the call ends, this property should be an empty list, and notified with CallMembersChanged()
If the Call implements ChannelInterfaceGroupInterface and the Group members are channel-specific handles, then this call SHOULD also use channel-specific handles.
Anonymous members are exposed as channel-specific handles with no owner.
CallMembers
. Tp::HandleIdentifierMap Tp::Service::ChannelTypeCallAdaptor::MemberIdentifiers | ( | ) | const |
Return the value of the exported D-Bus object property MemberIdentifiers
of type Tp::HandleIdentifierMap
.
Adaptees should export this property as a Qt property named 'memberIdentifiers' with type Tp::HandleIdentifierMap.
The string identifiers for handles mentioned in CallMembers, to give clients the minimal information necessary to create contacts without waiting for round-trips.
MemberIdentifiers
. uint Tp::Service::ChannelTypeCallAdaptor::InitialTransport | ( | ) | const |
Return the value of the exported D-Bus object property InitialTransport
of type uint
.
Adaptees should export this property as a Qt property named 'initialTransport' with type uint.
If set on a requested channel, this indicates the transport that
should be used for this call. Where not applicable, this property
is defined to be
InitialTransport
. bool Tp::Service::ChannelTypeCallAdaptor::InitialAudio | ( | ) | const |
Return the value of the exported D-Bus object property InitialAudio
of type bool
.
Adaptees should export this property as a Qt property named 'initialAudio' with type bool.
If set to True in a channel request that will create a new channel, the connection manager should immediately attempt to establish an audio stream to the remote contact, making it unnecessary for the client to call ChannelTypeCallInterface::AddContent() .
If this property, or InitialVideo, is passed to EnsureChannel (as opposed to CreateChannel), the connection manager SHOULD ignore these properties when checking whether it can return an existing channel as suitable; these properties only become significant when the connection manager has decided to create a new channel.
If True on a requested channel, this indicates that the audio stream has already been requested and the client does not need to call RequestStreams, although it MAY still do so.
If True on an unrequested (incoming) channel, this indicates that the remote contact initially requested an audio stream; this does not imply that that audio stream is still active (as indicated by ChannelTypeCallInterface::Contents ).
The name of this new content can be decided by using the InitialAudioName property.
Connection managers that support the ConnectionInterfaceContactCapabilitiesInterface interface SHOULD represent the capabilities of receiving audio and/or video calls by including a channel class in a contact's capabilities with ChannelType = Call in the fixed properties dictionary, and InitialAudio and/or InitialVideo in the allowed properties list. Clients wishing to discover whether a particular contact is likely to be able to receive audio and/or video calls SHOULD use this information.
Not all clients support video calls, and it would also be possible (although unlikely) to have a client which could only stream video, not audio.
Clients that are willing to receive audio and/or video calls SHOULD include the following among their channel classes if calling ConnectionInterfaceContactCapabilitiesInterface::UpdateCapabilities() (clients of a ChannelDispatcherInterface SHOULD instead arrange for the ChannelDispatcher to do this, by including the filters in their ClientHandlerInterface::HandlerChannelFilter properties):
Connection managers for protocols with capability discovery, like XMPP, need this information to advertise the appropriate capabilities for their protocol.
InitialAudio
. bool Tp::Service::ChannelTypeCallAdaptor::InitialVideo | ( | ) | const |
Return the value of the exported D-Bus object property InitialVideo
of type bool
.
Adaptees should export this property as a Qt property named 'initialVideo' with type bool.
The same as InitialAudio , but for a video stream. This property is immutable (cannot change).
In particular, note that if this property is False, this does not imply that an active video stream has not been added, only that no video stream was active at the time the channel appeared.
This property is the correct way to discover whether connection managers, contacts etc. support video calls; it appears in capabilities structures in the same way as InitialAudio.
InitialVideo
. QString Tp::Service::ChannelTypeCallAdaptor::InitialAudioName | ( | ) | const |
Return the value of the exported D-Bus object property InitialAudioName
of type QString
.
Adaptees should export this property as a Qt property named 'initialAudioName' with type QString.
If InitialAudio is set to True, then this property will name the intial audio content with the value of this property.
Content names are meant to be significant, but if no name can be given to initial audio content, then its name cannot be meaningful or even localized.
If this property is empty or missing from the channel request and InitialAudio is True, then the CM must come up with a sensible for the content, such as "audio".
If the protocol has no concept of stream names then this property will not show up in the allowed properties list of the Requestable Channel Classes for call channels.
InitialAudioName
. QString Tp::Service::ChannelTypeCallAdaptor::InitialVideoName | ( | ) | const |
Return the value of the exported D-Bus object property InitialVideoName
of type QString
.
Adaptees should export this property as a Qt property named 'initialVideoName' with type QString.
The same as InitialAudioName , but for a video stream created by setting InitialVideo to True. This property is immutable and so cannot change.
InitialVideoName
. bool Tp::Service::ChannelTypeCallAdaptor::MutableContents | ( | ) | const |
Return the value of the exported D-Bus object property MutableContents
of type bool
.
Adaptees should export this property as a Qt property named 'mutableContents' with type bool.
If True, a stream of a different content type can be added after the Channel has been requested
If this property is missing, clients SHOULD assume that it is False, and thus that the channel's streams cannot be changed once the call has started.
If this property isn't present in the "allowed" set in any of the Call entries contact capabilities, then user interfaces MAY choose to show a separate "call" option for each class of call.
For example, once an audio-only Google Talk call has started, it is not possible to add a video stream; both audio and video must be requested at the start of the call if video is desired. User interfaces may use this pseudo-capability as a hint to display separate "Audio call" and "Video call" buttons, rather than a single "Call1" button with the option to add and remove video once the call has started for contacts without this flag.
MutableContents
.
|
slot |
Begins a call to the exported D-Bus method SetRinging
on this object.
Adaptees should export this method as a Qt slot with the following signature: void setRinging(const Tp::Service::ChannelTypeCallAdaptor::SetRingingContextPtr &context);
Implementations should call MethodInvocationContext::setFinished (or setFinishedWithError accordingly) on the received context object once the method has finished processing.
Indicate that the local user has been alerted about the incoming call.
This method is only useful if the
channel's ChannelInterface::Requested
property is False, and
the CallState is
In all other states, this method SHOULD fail with the error NotAvailable.
|
slot |
Begins a call to the exported D-Bus method SetQueued
on this object.
Adaptees should export this method as a Qt slot with the following signature: void setQueued(const Tp::Service::ChannelTypeCallAdaptor::SetQueuedContextPtr &context);
Implementations should call MethodInvocationContext::setFinished (or setFinishedWithError accordingly) on the received context object once the method has finished processing.
Notifies the CM that the local user is already in a call, so this call has been put in a call-waiting style queue.
This method is only useful if the
channel's ChannelInterface::Requested
property is False, and
the CallState is
Locally_Queued is a little like Locally_Held, but applies to calls that have not been Accepted (the Locally_Queued flag should be unset by the CM when Accept is called). It should also be set in response to the state of the world, rather than in response to user action.
|
slot |
Begins a call to the exported D-Bus method Accept
on this object.
Adaptees should export this method as a Qt slot with the following signature: void accept(const Tp::Service::ChannelTypeCallAdaptor::AcceptContextPtr &context);
Implementations should call MethodInvocationContext::setFinished (or setFinishedWithError accordingly) on the received context object once the method has finished processing.
For incoming calls in state
For outgoing calls in state
Otherwise, this method SHOULD fail with the error NotAvailable.
This method should be called exactly once per Call, by whatever client (user interface) is handling the channel.
When this method is called, for each CallContentInterface whose
CallContentInterface::Disposition is
|
slot |
Begins a call to the exported D-Bus method Hangup
on this object.
Adaptees should export this method as a Qt slot with the following signature: void hangup(uint reason, const QString& detailedHangupReason, const QString& message, const Tp::Service::ChannelTypeCallAdaptor::HangupContextPtr &context);
Implementations should call MethodInvocationContext::setFinished (or setFinishedWithError accordingly) on the received context object once the method has finished processing.
Request that the call is ended. All contents will be removed from the Call so that the Contents property will be the empty list.
reason | A generic hangup reason. |
detailedHangupReason | A more specific reason for the call hangup, if one is available, or an empty string otherwise. |
message | A human-readable message to be sent to the remote contact(s). XMPP Jingle allows calls to be terminated with a human-readable message. |
|
slot |
Begins a call to the exported D-Bus method AddContent
on this object.
Adaptees should export this method as a Qt slot with the following signature: void addContent(const QString& contentName, uint contentType, uint initialDirection, const Tp::Service::ChannelTypeCallAdaptor::AddContentContextPtr &context);
Implementations should call MethodInvocationContext::setFinished (or setFinishedWithError accordingly) on the received context object once the method has finished processing.
Request that a new Content of type Content_Type is added to the Call1. Handlers should check the value of the MutableContents property before trying to add another content as it might not be allowed.
contentName | The suggested name of the content to add. The content name property should be meaningful, so should be given a name which is significant to the user. The name could be a localized "audio", "video" or perhaps include some string identifying the source, such as a webcam identifier. If there is already a content with the same name as this property then a sensible suffix should be added. For example, if this argument is "audio" but a content of the same name already exists, a sensible suffix such as " (1)" is appended to name the new content "audio (1)". A further content with the name "audio" would then be named "audio (2)". |
contentType | The media stream type of the content to be added to the call. |
initialDirection | The requested initial direction of the new content. |
Path to the newly-created Call1.Content object.
|
signal |
Represents the exported D-Bus signal ContentAdded
on this object.
Adaptees should export this signal as a Qt signal with the following signature: void contentAdded(const QDBusObjectPath& content);
The adaptee signal will be automatically relayed as a D-Bus signal once emitted.
content | Path to the newly-created Content object. |
|
signal |
Represents the exported D-Bus signal ContentRemoved
on this object.
Adaptees should export this signal as a Qt signal with the following signature: void contentRemoved(const QDBusObjectPath& content, const Tp::CallStateReason& reason);
The adaptee signal will be automatically relayed as a D-Bus signal once emitted.
content | The Content which was removed. |
reason | Why the content was removed. |
|
signal |
Represents the exported D-Bus signal CallStateChanged
on this object.
Adaptees should export this signal as a Qt signal with the following signature: void callStateChanged(uint callState, uint callFlags, const Tp::CallStateReason& callStateReason, const QVariantMap& callStateDetails);
The adaptee signal will be automatically relayed as a D-Bus signal once emitted.
callState | The new value of the CallState property. |
callFlags | The new value of the CallFlags property. |
callStateReason | The new value of the CallStateReason property. |
callStateDetails | The new value of the CallStateDetails property. |
|
signal |
Represents the exported D-Bus signal CallMembersChanged
on this object.
Adaptees should export this signal as a Qt signal with the following signature: void callMembersChanged(const Tp::CallMemberMap& flagsChanged, const Tp::HandleIdentifierMap& identifiers, const Tp::UIntList& removed, const Tp::CallStateReason& reason);
The adaptee signal will be automatically relayed as a D-Bus signal once emitted.
flagsChanged | A map from members of the call to their new call member flags, including at least the members who have been added to CallMembers, and the members whose flags have changed. |
identifiers | The identifiers of the contacts in the Flags_Changed map. |
removed | A list of members who have left the call, i.e. keys to be removed from CallMembers. |
reason | A structured reason for the change. |
TelepathyQt 0.9.8 | Generated by 1.8.15 |