diff options
author | Guillaume Desmottes <guillaume.desmottes@collabora.co.uk> | 2011-01-28 15:52:56 +0100 |
---|---|---|
committer | Guillaume Desmottes <guillaume.desmottes@collabora.co.uk> | 2011-01-31 11:52:14 +0100 |
commit | 6db0f671fc17443e84e0732394f88624e724bd3d (patch) | |
tree | 446a593322fa1316294caf0d91e550e70174aca0 /spec | |
parent | a0ef503aa657aa46ff53accf2980404c9e5d4bbd (diff) | |
download | telepathy-glib-6db0f671fc17443e84e0732394f88624e724bd3d.tar.gz |
update to spec 0.21.9
Diffstat (limited to 'spec')
-rw-r--r-- | spec/Call_Content.xml | 36 | ||||
-rw-r--r-- | spec/Call_Content_Interface_Media.xml | 36 | ||||
-rw-r--r-- | spec/Call_Stream_Endpoint.xml | 10 | ||||
-rw-r--r-- | spec/Call_Stream_Interface_Media.xml | 36 | ||||
-rw-r--r-- | spec/Channel_Type_File_Transfer.xml | 49 | ||||
-rw-r--r-- | spec/all.xml | 9 |
6 files changed, 126 insertions, 50 deletions
diff --git a/spec/Call_Content.xml b/spec/Call_Content.xml index 17ed71095..270d99b08 100644 --- a/spec/Call_Content.xml +++ b/spec/Call_Content.xml @@ -250,42 +250,6 @@ <tp:member-ref>StreamsRemoved</tp:member-ref> signals.</p> </tp:docstring> </property> - - <tp:enum name="Call_Content_Packetization_Type" type="u"> - <tp:added version="0.21.2"/> - <tp:docstring> - A packetization method that can be used for a content. - </tp:docstring> - - <tp:enumvalue suffix="RTP" value="0"> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - Real-time Transport Protocol, as documented by RFC 3550. - </tp:docstring> - </tp:enumvalue> - - <tp:enumvalue suffix="Raw" value="1"> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - Raw media. - </tp:docstring> - </tp:enumvalue> - - <tp:enumvalue suffix="MSN_Webcam" value="2"> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - MSN webcam. This is the video-only one-way type which was - used in earlier versions of WLM. Although no longer used, - modern WLM clients still support the MSN webcam protocol. - </tp:docstring> - </tp:enumvalue> - </tp:enum> - - <property name="Packetization" tp:name-for-bindings="Packetization" - type="u" tp:type="Call_Content_Packetization_Type" access="read" - tp:immutable="yes"> - <tp:added version="0.21.2"/> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>The packetization method in use for this content.</p> - </tp:docstring> - </property> </interface> </node> <!-- vim:set sw=2 sts=2 et ft=xml: --> diff --git a/spec/Call_Content_Interface_Media.xml b/spec/Call_Content_Interface_Media.xml index 274d8b213..038ce8c7a 100644 --- a/spec/Call_Content_Interface_Media.xml +++ b/spec/Call_Content_Interface_Media.xml @@ -326,6 +326,42 @@ there is no longer any active codec offer) signals.</p> </tp:docstring> </property> + + <tp:enum name="Call_Content_Packetization_Type" type="u"> + <tp:added version="0.21.2"/> + <tp:docstring> + A packetization method that can be used for a content. + </tp:docstring> + + <tp:enumvalue suffix="RTP" value="0"> + <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> + Real-time Transport Protocol, as documented by RFC 3550. + </tp:docstring> + </tp:enumvalue> + + <tp:enumvalue suffix="Raw" value="1"> + <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> + Raw media. + </tp:docstring> + </tp:enumvalue> + + <tp:enumvalue suffix="MSN_Webcam" value="2"> + <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> + MSN webcam. This is the video-only one-way type which was + used in earlier versions of WLM. Although no longer used, + modern WLM clients still support the MSN webcam protocol. + </tp:docstring> + </tp:enumvalue> + </tp:enum> + + <property name="Packetization" tp:name-for-bindings="Packetization" + type="u" tp:type="Call_Content_Packetization_Type" access="read" + tp:immutable="yes"> + <tp:added version="0.21.2"/> + <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> + <p>The packetization method in use for this content.</p> + </tp:docstring> + </property> </interface> </node> <!-- vim:set sw=2 sts=2 et ft=xml: --> diff --git a/spec/Call_Stream_Endpoint.xml b/spec/Call_Stream_Endpoint.xml index 4818168dc..cf1783d1e 100644 --- a/spec/Call_Stream_Endpoint.xml +++ b/spec/Call_Stream_Endpoint.xml @@ -72,7 +72,7 @@ </signal> <property name="RemoteCandidates" tp:name-for-bindings="Remote_Candidates" - type="a(usqa{sv})" tp:type="Candidate[]" access="read"> + type="a(usua{sv})" tp:type="Candidate[]" access="read"> <tp:docstring> A list of candidates for this endpoint. </tp:docstring> @@ -85,7 +85,7 @@ <tp:member-ref>RemoteCandidates</tp:member-ref> property. </tp:docstring> <arg name="Candidates" - type="a(usqa{sv})" tp:type="Candidate[]"> + type="a(usua{sv})" tp:type="Candidate[]"> <tp:docstring> The candidates that were added. </tp:docstring> @@ -98,7 +98,7 @@ Emitted when a candidate is selected for use in the stream. </tp:docstring> <arg name="Candidate" - type="(usqa{sv})" tp:type="Candidate"> + type="(usua{sv})" tp:type="Candidate"> <tp:docstring> The candidate that has been selected. </tp:docstring> @@ -107,7 +107,7 @@ <property name="SelectedCandidate" tp:name-for-bindings="Selected_Candidate" - type="(usqa{sv})" tp:type="Candidate" access="read"> + type="(usua{sv})" tp:type="Candidate" access="read"> <tp:docstring> The candidate that has been selected for use to stream packets to the remote contact. Change notification is given via the @@ -122,7 +122,7 @@ <tp:member-ref>CandidateSelected</tp:member-ref>. </tp:docstring> <arg name="Candidate" - type="(usqa{sv})" tp:type="Candidate" direction="in"> + type="(usua{sv})" tp:type="Candidate" direction="in"> <tp:docstring> The candidate that has been selected. </tp:docstring> diff --git a/spec/Call_Stream_Interface_Media.xml b/spec/Call_Stream_Interface_Media.xml index 9e62c8744..54476f0fa 100644 --- a/spec/Call_Stream_Interface_Media.xml +++ b/spec/Call_Stream_Interface_Media.xml @@ -110,15 +110,41 @@ </tp:member> </tp:mapping> + <tp:enum type="u" name="Stream_Component"> + <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> + Media streams can use more than one UDP socket: one for RTP (data) + and one for RTCP (control). Most of the time, they are adjacent + to each other, but some protocols (xmpp) signal each port separately. + </tp:docstring> + <tp:enumvalue suffix="Unknown" value="0"> + <tp:docstring> + The stream transport type is unknown or not applicable + (should not appear over dbus). + </tp:docstring> + </tp:enumvalue> + <tp:enumvalue suffix="Data" value="1"> + <tp:docstring> + This is the high-traffic data socket, containing the audio/video + data for the stream. + </tp:docstring> + </tp:enumvalue> + <tp:enumvalue suffix="Control" value="2"> + <tp:docstring> + This is the low-traffic control socket, usually containing feedback + about packet loss etc. + </tp:docstring> + </tp:enumvalue> + </tp:enum> + <tp:struct name="Candidate" array-name="Candidate_List"> <tp:docstring>A Stream Candidate.</tp:docstring> - <tp:member name="Component" type="u"> + <tp:member name="Component" type="u" tp:type="Stream_Component"> <tp:docstring>The component number.</tp:docstring> </tp:member> <tp:member name="IP" type="s"> <tp:docstring>The IP address to use.</tp:docstring> </tp:member> - <tp:member name="Port" type="q"> + <tp:member name="Port" type="u"> <tp:docstring>The port number to use.</tp:docstring> </tp:member> <tp:member name="Info" type="a{sv}" tp:type="Candidate_Info"> @@ -133,7 +159,7 @@ signal them to the remote contact(s). </tp:docstring> <arg name="Candidates" direction="in" - type="a(usqa{sv})" tp:type="Candidate[]"> + type="a(usua{sv})" tp:type="Candidate[]"> <tp:docstring> The candidates to be added. </tp:docstring> @@ -216,7 +242,7 @@ </property> <property name="LocalCandidates" tp:name-for-bindings="Local_Candidates" - type="a(usqa{sv})" tp:type="Candidate[]" access="read"> + type="a(usua{sv})" tp:type="Candidate[]" access="read"> <tp:docstring> [FIXME]. Change notification is via the <tp:member-ref>LocalCandidatesAdded</tp:member-ref> signal. @@ -229,7 +255,7 @@ Emitted when local candidates are added to the <tp:member-ref>LocalCandidates</tp:member-ref> property. </tp:docstring> - <arg name="Candidates" type="a(usqa{sv})" tp:type="Candidate[]"> + <arg name="Candidates" type="a(usua{sv})" tp:type="Candidate[]"> <tp:docstring> Candidates that have been added. </tp:docstring> diff --git a/spec/Channel_Type_File_Transfer.xml b/spec/Channel_Type_File_Transfer.xml index 19dda0601..6963d2133 100644 --- a/spec/Channel_Type_File_Transfer.xml +++ b/spec/Channel_Type_File_Transfer.xml @@ -260,6 +260,38 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </tp:docstring> </property> + <property name="URI" type="s" access="readwrite" + tp:name-for-bindings="URI" tp:immutable="sometimes" tp:requestable="yes"> + <tp:added version="0.21.9"/> + <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> + <p>For outgoing file transfers, this requestable property allows the channel + requester to inform observers (and the handler, if it is not the requester + itself) of the URI of the file being transferred. Note that the + connection manager SHOULD NOT read this file directly; the handler + streams the file into the CM through the socket negotiated using + <tp:member-ref>ProvideFile</tp:member-ref>.</p> + + <p>On outgoing file transfers, this property MUST NOT change after the channel + is requested.</p> + + <p>For incoming file transfers, this property MAY be set by the channel + handler before calling <tp:member-ref>AcceptFile</tp:member-ref> to + inform observers where the incoming file will be saved. + Setting this property once <tp:member-ref>AcceptFile</tp:member-ref> + has been called MUST fail. Once this property has been set + <tp:member-ref>URIDefined</tp:member-ref> is emitted.</p> + + <p>If set, this URI SHOULD generally point to a file on the local system, as + defined by <a href='http://www.apps.ietf.org/rfc/rfc1738.html#sec-3.10'> + RFC 1738 §3.10</a>; that is, it should be of the form + <tt>file:///path/to/file</tt> or <tt>file://localhost/path/to/file</tt>. + For outgoing files, this URI MAY use a different scheme, such as + <tt>http:</tt>, if a remote resource is being transferred + to a contact.</p> + + </tp:docstring> + </property> + <tp:enum name="File_Transfer_State" type="u"> <tp:enumvalue suffix="None" value="0"> <tp:docstring> @@ -525,6 +557,23 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </arg> </signal> + <signal name="URIDefined" + tp:name-for-bindings="URI_Defined"> + <tp:added version="0.21.9"/> + <tp:docstring> + Emitted when the value of the <tp:member-ref>URI</tp:member-ref> + property has been set. This signal MUST only be emitted on + incoming file transfers, and only if the handler sets the + <tp:member-ref>URI</tp:member-ref> property before + accepting the file. + </tp:docstring> + <arg name="URI" type="s"> + <tp:docstring> + The value of the <tp:member-ref>URI</tp:member-ref> property. + </tp:docstring> + </arg> + </signal> + </interface> </node> diff --git a/spec/all.xml b/spec/all.xml index 312340127..418340655 100644 --- a/spec/all.xml +++ b/spec/all.xml @@ -3,7 +3,7 @@ xmlns:xi="http://www.w3.org/2001/XInclude"> <tp:title>Telepathy D-Bus Interface Specification</tp:title> -<tp:version>0.21.8</tp:version> +<tp:version>0.21.9</tp:version> <tp:copyright>Copyright © 2005-2010 Collabora Limited</tp:copyright> <tp:copyright>Copyright © 2005-2010 Nokia Corporation</tp:copyright> @@ -179,13 +179,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <xi:include href="Channel_Interface_SMS.xml"/> </tp:section> - <tp:section name="Streamed Media-related interfaces"> + <tp:section name="Streamed Media/Call-related interfaces"> <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>These interfaces are only applicable to channels of type <tp:dbus-ref namespace='ofdT.Channel.Type'>StreamedMedia</tp:dbus-ref>, with the exception of the <tp:dbus-ref - namespace='ofdT.Channel.Interface'>Hold</tp:dbus-ref> interface, which - may also appear on <tp:dbus-ref + namespace='ofdT.Channel.Interface'>Hold</tp:dbus-ref> and + <tp:dbus-ref namespace="ofdT.Channel.Interface">DTMF</tp:dbus-ref> + interfaces, which may also appear on <tp:dbus-ref namespace='ofdT.Channel.Type'>Call.DRAFT</tp:dbus-ref> channels.</p> </tp:docstring> |