diff options
Diffstat (limited to 'spec/Call_Content.xml')
| -rw-r--r-- | spec/Call_Content.xml | 122 |
1 files changed, 34 insertions, 88 deletions
diff --git a/spec/Call_Content.xml b/spec/Call_Content.xml index 270d99b08..e97e98fce 100644 --- a/spec/Call_Content.xml +++ b/spec/Call_Content.xml @@ -20,91 +20,31 @@ 02110-1301, USA.</p> </tp:license> - <interface name="org.freedesktop.Telepathy.Call.Content.DRAFT" + <interface name="org.freedesktop.Telepathy.Call1.Content" tp:causes-havoc="experimental"> <tp:added version="0.19.0">(draft 1)</tp:added> + <tp:requires + interface="org.freedesktop.Telepathy.Call1.Interface.Mute"/> <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> This object represents one Content inside a <tp:dbus-ref - namespace="ofdT.Channel.Type">Call.DRAFT</tp:dbus-ref>. For + namespace="ofdT.Channel.Type">Call1</tp:dbus-ref>. For example, in an audio/video call there would be one audio content and one video content. Each content has one or more <tp:dbus-ref - namespace="ofdT.Call">Stream.DRAFT</tp:dbus-ref> objects which + namespace="ofdT.Call1">Stream</tp:dbus-ref> objects which represent the actual transport to one or more remote contacts. </tp:docstring> - <tp:enum name="Content_Removal_Reason" type="u"> - <tp:added version="0.21.2"/> - <tp:docstring> - A representation of the reason for a content to be removed, - which may be used by simple clients, or used as a fallback - when the DBus_Reason is not understood. This enum will be - extended with future reasons as and when appropriate, so - clients SHOULD keep up to date with its values, but also be - happy to fallback to the Unknown value when an unknown value - is encountered. - </tp:docstring> - - <tp:enumvalue suffix="Unknown" value="0"> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - We just don't know. Unknown values of this enum SHOULD also be - treated like this. - </tp:docstring> - </tp:enumvalue> - - <tp:enumvalue suffix="User_Requested" value="1"> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>The local user requests that this content is removed - from the call.</p> - </tp:docstring> - </tp:enumvalue> - - <tp:enumvalue suffix="Error" value="2"> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>There is an error with the content which means that it - has to be removed from the call.</p> - </tp:docstring> - </tp:enumvalue> - - <tp:enumvalue suffix="Unsupported" value="3"> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>Some aspect of the content is unsupported so has to be - removed from the call.</p> - </tp:docstring> - </tp:enumvalue> - </tp:enum> - <method name="Remove" tp:name-for-bindings="Remove"> <tp:changed version="0.21.2">previously there were no arguments</tp:changed> <tp:docstring> - Remove the content from the call. + Remove the content from the call. This will cause + <tp:member-ref>Removed</tp:member-ref>((self_handle, + <tp:value-ref type="Call_State_Change_Reason">User_Requested</tp:value-ref>, "", "")) to be + emitted. </tp:docstring> - <arg direction="in" name="Reason" type="u" - tp:type="Content_Removal_Reason"> - <tp:docstring> - A generic hangup reason. - </tp:docstring> - </arg> - - <arg direction="in" name="Detailed_Removal_Reason" type="s" - tp:type="DBus_Error_Name"> - <tp:docstring> - A more specific reason for the content removal, if one is - available, or an empty string. - </tp:docstring> - </arg> - - <arg direction="in" name="Message" type="s"> - <tp:docstring> - A human-readable message for the reason of removing the - content, such as "Fatal streaming failure" or "no codec - intersection". This property can be left empty if no reason - is to be given. - </tp:docstring> - </arg> - <tp:possible-errors> <tp:error name="org.freedesktop.Telepathy.Error.NetworkError" /> <tp:error name="org.freedesktop.Telepathy.Error.NotImplemented"> @@ -120,7 +60,7 @@ <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Emitted when the content is removed from the call. This is the same as the <tp:dbus-ref - namespace="ofdT.Channel.Type">Call.DRAFT.ContentRemoved</tp:dbus-ref> + namespace="ofdT.Channel.Type">Call1.ContentRemoved</tp:dbus-ref> signal.</p> </tp:docstring> </signal> @@ -130,8 +70,9 @@ <tp:added version="0.19.11"/> <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Extra interfaces provided by this content, such as <tp:dbus-ref - namespace="ofdT.Call">Content.Interface.Media.DRAFT</tp:dbus-ref> or - <tp:dbus-ref namespace="ofdT.Call">Content.Interface.Mute.DRAFT</tp:dbus-ref>. + namespace="ofdT.Call1">Content.Interface.Media</tp:dbus-ref>, + <tp:dbus-ref namespace="ofdT.Channel">Interface.Hold</tp:dbus-ref> or + <tp:dbus-ref namespace="ofdT.Call1">Interface.Mute</tp:dbus-ref>. This SHOULD NOT include the Content interface itself, and cannot change once the content has been created.</p> </tp:docstring> @@ -164,13 +105,13 @@ The disposition of this content, which defines whether to automatically start sending data on the streams when <tp:dbus-ref - namespace="ofdT.Channel.Type">Call.DRAFT</tp:dbus-ref> is + namespace="ofdT.Channel.Type.Call1">Accept</tp:dbus-ref> is called on the channel. </tp:docstring> <tp:enumvalue suffix="None" value="0"> <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - The content has no specific disposition + The content has no specific disposition. </tp:docstring> </tp:enumvalue> @@ -178,14 +119,14 @@ <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>The content was initially part of the call. When <tp:dbus-ref - namespace="ofdT.Channel.Type.Call.DRAFT">Accept</tp:dbus-ref> + namespace="ofdT.Channel.Type.Call1">Accept</tp:dbus-ref> is called on the channel, all streams of this content with <tp:dbus-ref - namespace="ofdT.Call.Stream.DRAFT">LocalSendingState</tp:dbus-ref> - set to <tp:type>Sending_State</tp:type>_Pending_Send will be - moved to <tp:type>Sending_State</tp:type>_Sending as if + namespace="ofdT.Call1.Stream">LocalSendingState</tp:dbus-ref> + set to <tp:value-ref type="Sending_State">Pending_Send</tp:value-ref> will be + moved to <tp:value-ref type="Sending_State">Sending</tp:value-ref> as if <tp:dbus-ref - namespace="ofdT.Call.Stream.DRAFT">SetSending</tp:dbus-ref> + namespace="ofdT.Call1.Stream">SetSending</tp:dbus-ref> (True) had been called.</p> </tp:docstring> </tp:enumvalue> @@ -208,7 +149,7 @@ <arg name="Streams" type="ao"> <tp:docstring> The <tp:dbus-ref - namespace="ofdT.Call">Stream.DRAFT</tp:dbus-ref>s which were + namespace="ofdT.Call1">Stream</tp:dbus-ref>s which were added. </tp:docstring> </arg> @@ -221,19 +162,24 @@ <p>Emitted when streams are removed from a call</p> </tp:docstring> <arg name="Streams" type="ao"> - <tp:docstring> - The <tp:dbus-ref - namespace="ofdT.Call">Stream.DRAFT</tp:dbus-ref>s which were - removed. - </tp:docstring> - </arg> + <tp:docstring> + The <tp:dbus-ref + namespace="ofdT.Call1">Stream</tp:dbus-ref>s which were + removed. + </tp:docstring> + </arg> + <arg name="Reason" type="(uuss)" tp:type="Call_State_Reason"> + <tp:docstring> + Why the content was removed. + </tp:docstring> + </arg> </signal> <property name="Streams" tp:name-for-bindings="Streams" type="ao" access="read"> <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>The list of <tp:dbus-ref namespace="ofdT.Call" - >Stream.DRAFT</tp:dbus-ref> objects that exist in this + <p>The list of <tp:dbus-ref namespace="ofdT.Call1" + >Stream</tp:dbus-ref> objects that exist in this content.</p> <tp:rationale> |