summaryrefslogtreecommitdiff
path: root/spec/Call_Content.xml
diff options
context:
space:
mode:
authorSimon McVittie <simon.mcvittie@collabora.co.uk>2010-10-15 15:34:37 +0100
committerSimon McVittie <simon.mcvittie@collabora.co.uk>2010-10-15 16:03:22 +0100
commit25ecb5c19f540c2bbf397c9224c074d446cc4c91 (patch)
treebb4e32c46e4390b6084a27b32605e46fee8dee3f /spec/Call_Content.xml
parent8e5e5b675aaf67dfdfa64c78213786f3216f9355 (diff)
Update to spec 0.21.2
- add TP_ERROR_REJECTED - add SendNamedTelephonyEvent and SendSoundTelephonyEvent - do a trivial port of the Call CM to new APIs: - rename Senders to Members, etc. - emit added/removed streams as an array of one path Reviewed-by: Jonny Lamb <jonny.lamb@collabora.co.uk>
Diffstat (limited to 'spec/Call_Content.xml')
-rw-r--r--spec/Call_Content.xml177
1 files changed, 143 insertions, 34 deletions
diff --git a/spec/Call_Content.xml b/spec/Call_Content.xml
index 8df078b66..704769adf 100644
--- a/spec/Call_Content.xml
+++ b/spec/Call_Content.xml
@@ -1,8 +1,8 @@
<?xml version="1.0" ?>
<node name="/Call_Content"
xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
- <tp:copyright>Copyright © 2009 Collabora Ltd.</tp:copyright>
- <tp:copyright>Copyright © 2009 Nokia Corporation</tp:copyright>
+ <tp:copyright>Copyright © 2009-2010 Collabora Ltd.</tp:copyright>
+ <tp:copyright>Copyright © 2009-2010 Nokia Corporation</tp:copyright>
<tp:license xmlns="http://www.w3.org/1999/xhtml">
<p>This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
@@ -27,14 +27,78 @@
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
This object represents one Content inside a Call. For example in an
audio/video call there would be one audio and one video content. Each
- content has one or more <tp:dbus-ref
- namespace="org.freedesktop.Telepathy.Call">Stream.DRAFT</tp:dbus-ref>
- objects which represent the actual transport to one or more contacts.
-
+ content has one or more <tp:dbus-ref namespace="ofdT.Call"
+ >Stream.DRAFT</tp:dbus-ref> objects which represent the actual
+ transport to one or more contacts.
</tp:docstring>
+ <tp:enum name="Content_Removal_Reason" type="u">
+ <tp:added version="0.21.2"/>
+ <tp:docstring>
+ A simple 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.
+ </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:docstring>Remove the content from the call.</tp:docstring>
+ <tp:changed version="0.21.2">previously there were no
+ arguments</tp:changed>
+ <tp:docstring>
+ Remove the content from the call.
+ </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 otherwise.
+ </tp:docstring>
+ </arg>
+
+ <arg direction="in" name="Message" type="s">
+ <tp:docstring>
+ A human-readable message for the reason of removing the
+ content, for example "Fatal streaming failure", "no codec
+ intersection", etc. 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">
@@ -52,9 +116,8 @@
<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.Call">Content.Interface.Media.DRAFT</tp:dbus-ref> or
+ <tp:dbus-ref namespace="ofdT.Call">Content.Interface.Mute.DRAFT</tp:dbus-ref>.
This SHOULD NOT include the Content interface itself, and cannot
change once the content has been created.</p>
</tp:docstring>
@@ -62,8 +125,15 @@
<property name="Name" tp:name-for-bindings="Name" type="s" access="read">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>The name of the content.
- [FIXME: rationale?]</p>
+ <p>The name of the content.</p>
+
+ <tp:rationale>
+ 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.
+ </tp:rationale>
</tp:docstring>
</property>
@@ -101,14 +171,14 @@
<tp:enumvalue suffix="Initial" value="2">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The content was initially part of the call. When <tp:dbus-ref
- namespace="org.freedesktop.Telepathy.Channel.Type.Call.DRAFT"
- >Accept</tp:dbus-ref> is called on the channel, all streams of
- this content where the self-handle's sending state in <tp:dbus-ref
- namespace="org.freedesktop.Telepathy.Call.Stream.DRAFT"
- >Senders</tp:dbus-ref> is Sending_State_Pending_Send
- will be moved to Sending_State_Sending as if <tp:dbus-ref
- namespace="org.freedesktop.Telepathy.Call.Stream.DRAFT"
- >SetSending</tp:dbus-ref>(TRUE) had been called.</p>
+ namespace="ofdT.Channel.Type.Call.DRAFT">Accept</tp:dbus-ref>
+ is called on the channel, all streams of this content where
+ the self-handle's sending state in <tp:dbus-ref
+ namespace="ofdT.Call.Stream.DRAFT">Members</tp:dbus-ref>
+ is Sending_State_Pending_Send will be moved to
+ Sending_State_Sending as if <tp:dbus-ref
+ namespace="ofdT.Call.Stream.DRAFT">SetSending</tp:dbus-ref>
+ (TRUE) had been called.</p>
</tp:docstring>
</tp:enumvalue>
</tp:enum>
@@ -120,24 +190,28 @@
</tp:docstring>
</property>
- <signal name="StreamAdded" tp:name-for-bindings="Stream_Added">
+ <signal name="StreamsAdded" tp:name-for-bindings="Streams_Added">
+ <tp:changed version="0.21.2">plural version, renamed from
+ StreamAdded</tp:changed>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Emitted when a stream is added to a call</p>
+ <p>Emitted when streams are added to a call.</p>
</tp:docstring>
- <arg name="Stream" type="o">
+ <arg name="Streams" type="ao">
<tp:docstring>
- The stream which was added
+ The streams which were added.
</tp:docstring>
</arg>
</signal>
- <signal name="StreamRemoved" tp:name-for-bindings="Stream_Removed">
+ <signal name="StreamsRemoved" tp:name-for-bindings="Streams_Removed">
+ <tp:changed version="0.21.2">plural version, renamed from
+ StreamRemoved</tp:changed>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Emitted when a stream is added to a call</p>
+ <p>Emitted when streams are removed from a call</p>
</tp:docstring>
- <arg name="Stream" type="o">
+ <arg name="Streams" type="ao">
<tp:docstring>
- The stream which was removed
+ The streams which were removed.
</tp:docstring>
</arg>
</signal>
@@ -145,10 +219,9 @@
<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="org.freedesktop.Telepathy.Call">Stream.DRAFT</tp:dbus-ref>
- objects that exist in this content.</p>
+ <p>The list of <tp:dbus-ref namespace="ofdT.Call"
+ >Stream.DRAFT</tp:dbus-ref> objects that exist in this
+ content.</p>
<tp:rationale>
<p>In a conference call multiple parties can share one media content
@@ -159,8 +232,44 @@
</tp:rationale>
<p>Change notification is via
- <tp:member-ref>StreamAdded</tp:member-ref> and
- <tp:member-ref>StreamRemoved</tp:member-ref>.</p>
+ <tp:member-ref>StreamsAdded</tp:member-ref> and
+ <tp:member-ref>StreamsRemoved</tp:member-ref>.</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:added version="0.21.2"/>
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ <p>The packetization method in use for this content. This
+ property is immutable.</p>
</tp:docstring>
</property>
</interface>