From b2e7daca8cf62663aaef34b49a7e5b5d56370804 Mon Sep 17 00:00:00 2001 From: Will Thompson Date: Wed, 30 Mar 2011 14:58:09 +0100 Subject: Update to spec 0.22.1. --- spec/Channel_Type_Call.xml | 8 ++ spec/Channel_Type_Contact_Search.xml | 23 +++- spec/Connection_Interface_Requests.xml | 5 +- spec/Connection_Manager.xml | 22 +++- spec/Media_Stream_Handler.xml | 192 +++++++++++++++++++++++++++++++-- spec/Protocol.xml | 13 ++- spec/all.xml | 2 +- spec/errors.xml | 15 +++ 8 files changed, 256 insertions(+), 24 deletions(-) (limited to 'spec') diff --git a/spec/Channel_Type_Call.xml b/spec/Channel_Type_Call.xml index 045d41693..e1474c5ac 100644 --- a/spec/Channel_Type_Call.xml +++ b/spec/Channel_Type_Call.xml @@ -836,6 +836,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. normally be localized or suitable for display to users, and is only applicable when the call state is Call_State_Ended. + +
balance-required - i
+
Optionally included when a call cannot be connected because + there is InsufficientBalance, + indicating what the required balance would be to place this call. + The value of this key has the same units and scale as + AccountBalance. +
diff --git a/spec/Channel_Type_Contact_Search.xml b/spec/Channel_Type_Contact_Search.xml index fefa77a26..98789ab40 100644 --- a/spec/Channel_Type_Contact_Search.xml +++ b/spec/Channel_Type_Contact_Search.xml @@ -31,12 +31,31 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.A channel type for searching server-stored user directories. A new channel should be requested by a client for each search attempt, and closed when the search is completed or the required result has been - found. Channels of this type should have + +

Connections that support contact search channels SHOULD have an entry + in RequestableChannelClasses with the ChannelType fixed to this + interface, and no other fixed properties. That requestable + channel class MAY also have the Server and Limit properties in its + list of allowed properties, depending on the protocol.

+ + +

The requestable channel class would normally also have TargetHandleType fixed to + None, but the initial implementation of ContactSearch + (in telepathy-gabble) didn't do this.

+ + +

All channels of this type should have TargetHandleType None (and hence TargetHandle 0 and TargetID - ""). Requests for channels of this type need only + "").

+ +

Requests for channels of this type need only optionally specify the Server property (if it is an allowed property in the connection's RequestableChannelClasses).

diff --git a/spec/Connection_Interface_Requests.xml b/spec/Connection_Interface_Requests.xml index 2f233fa53..c8dc32804 100644 --- a/spec/Connection_Interface_Requests.xml +++ b/spec/Connection_Interface_Requests.xml @@ -486,7 +486,10 @@ org.freedesktop.Telepathy.Channel.ChannelType and org.freedesktop.Telepathy.Channel.TargetHandleType. -

+ (One exception is that ContactSearch channels do not have TargetHandleType + None in their requestable channel classes, for + historical reasons.)

diff --git a/spec/Connection_Manager.xml b/spec/Connection_Manager.xml index 3683fcadf..10ade57e8 100644 --- a/spec/Connection_Manager.xml +++ b/spec/Connection_Manager.xml @@ -196,11 +196,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - Get a list of the parameters which must or may be provided to the - RequestConnection method when connecting - to the given protocol, - or registering (the boolean "register" parameter is available, - and set to true). + Get a list of the parameters which may be specified in the + Parameters of an + Account (or, for + specialised applications which do not use the account manager, passed + to RequestConnection). Some parameters + are mandatory, and some parameters only make sense when registering new + accounts with the server; see the Param_Spec + documentation for more details. @@ -323,6 +326,15 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.Connect method.

+

Most applications should not use this method: they + should instead use the the Connection property on an + Account object obtained + from the AccountManager. This method is used + internally by the account manager to create connections when + needed.

+

The parameters which must and may be provided in the parameters dictionary can be discovered with the GetParameters method. These diff --git a/spec/Media_Stream_Handler.xml b/spec/Media_Stream_Handler.xml index 123ea8be7..dbcaf816e 100644 --- a/spec/Media_Stream_Handler.xml +++ b/spec/Media_Stream_Handler.xml @@ -20,6 +20,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + + Handles signalling the information pertaining to a specific media stream. + A client should provide information to this handler as and when it is + available. + + @@ -533,7 +539,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 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 + If these codecs are compatible with the remote codecs, then the client must call SupportedCodecs, otherwise call Error. @@ -581,16 +587,16 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. The payload type to use when sending events. The value 0xFFFFFFFF - means to send with the already configured event type instead of using - the specified one. + means to send with the already configured event type instead of using + the specified one. Request that a telephony event (as defined by RFC 4733) is transmitted over this stream until StopTelephonyEvent is called. This differs from StartTelephonyEvent in that you force the event to be transmitted - as a RFC 4733 named event, not as sound. You can also force a specific - Codec ID. + as a RFC 4733 named event, not as sound. You can also force a specific + Codec ID. - - Handles signalling the information pertaining to a specific media stream. - A client should provide information to this handler as and when it is - available. - + + + + + The minimum interval between two regular RTCP packets in + milliseconds for this content. If no special value is desired, one + should put MAXUINT (0xFFFFFFFF). + + + + + The RTCP feedback messages for this codec. + + + + + + + + A struct defining an RTCP feedback message. + + + + Feedback type, for example "ack", "nack", or "ccm". + + + + + Feedback subtype, according to the Type, can be an empty string (""), + if there is no subtype. + For example, generic nack is Type="nack" Subtype="". + + + + + Feedback parameters as a string. Format is defined in the relevant RFC + + + + + + + + A map of codec and its feedback properties. + + + + Numeric identifier for the codec. This will be used as the + PT in the SDP or content description. + + + + + The RTCP feedback properties for this codec. + + + + + + + + + Remote Feedback messages desired by the remote side + + + + Signal emitted when the connection manager wishes to inform the + client of the feedback messages supported by the remote end. + This signal is emitted before + SetRemoteCodecs. If the client + supports any of these messages, it must call + SupportedFeedbackMessages before calling + SupportedCodecs. + + + + + + + + Locally supported feedback messages. + + + + Inform the connection manager of the supported feedback messages + for this session. + This is called a before calling + SupportedCodecs, + Ready or + CodecsUpdated to indicate the local, + or negotiated feedback messages. + + + + + + + A struct defining a RTP Header extension + + + + Identifier to be negotiated + + + + + Direction in which the Header Extension is negotiated. + + + + + URI defining the extension + + + + + Feedback parameters as a string. Format is defined in the relevant RFC + + + + + + + + + Header extensions desired by the remote side + + + + Signal emitted when the connection manager wishes to inform the + client of the RTP header extensions supported by the remote end. + This signal is emitted before + SetRemoteCodecs. If the client + supports any of these messages, it must call + SupportedHeaderExtensions before calling + SupportedCodecs. + + + + + + + + Locally supported RTP header extensions. + + + + Inform the connection manager of the supported RTP header extensions + for this session. + This is called before calling + SupportedCodecs, + Ready or + CodecsUpdated to indicate the local + or negotiated RTP header extensions. + + + diff --git a/spec/Protocol.xml b/spec/Protocol.xml index 5e2c9b197..e987a638d 100644 --- a/spec/Protocol.xml +++ b/spec/Protocol.xml @@ -99,10 +99,15 @@ allowed=org.freedesktop.Telepathy.Channel.TargetHandle;org.freedesktop.Telepathy access="read" type="a(susv)" tp:type="Param_Spec[]" tp:immutable="yes"> -

The parameters which must or may be provided to the - RequestConnection method when connecting to the - given protocol.

+

The parameters which may be specified in the + Parameters of an + Account (or, for + specialised applications which do not use the account manager, passed + to RequestConnection). + Some parameters are mandatory, and some parameters only make sense + when registering new accounts with the server; see the + Param_Spec documentation for more details.

Connection managers with a .manager file (as described as part of the diff --git a/spec/all.xml b/spec/all.xml index a5644a90f..bf15a903e 100644 --- a/spec/all.xml +++ b/spec/all.xml @@ -3,7 +3,7 @@ xmlns:xi="http://www.w3.org/2001/XInclude"> Telepathy D-Bus Interface Specification -0.22.0 +0.22.1 Copyright © 2005-2011 Collabora Limited Copyright © 2005-2011 Nokia Corporation diff --git a/spec/errors.xml b/spec/errors.xml index d63662edb..6753301f8 100644 --- a/spec/errors.xml +++ b/spec/errors.xml @@ -581,6 +581,21 @@ + + + +

Raised if the user has insufficient + Balance + to place a call.

+ +

The key 'balance-required' MAY be included in + CallStateDetails + (with the same units and scale as + AccountBalance) + to indicate how much credit is required to make this call.

+ + + Copyright © 2005-2010 Collabora Limited Copyright © 2005-2009 Nokia Corporation -- cgit v1.2.1