[telepathy-spec/master] Content.I.Media.ContactCodecMap: document

Simon McVittie simon.mcvittie at collabora.co.uk
Tue Dec 1 04:56:35 PST 2009


---
 spec/Call_Content_Interface_Media.xml |   14 ++++++++++++++
 1 files changed, 14 insertions(+), 0 deletions(-)

diff --git a/spec/Call_Content_Interface_Media.xml b/spec/Call_Content_Interface_Media.xml
index a9ecbae..f33b5fa 100644
--- a/spec/Call_Content_Interface_Media.xml
+++ b/spec/Call_Content_Interface_Media.xml
@@ -152,6 +152,20 @@
 
     <property name="ContactCodecMap" tp:name-for-bindings="Contact_Codec_Map"
       type="a{ua(usuua{ss})}" tp:type="Contact_Codec_Map" access="read">
+      <tp:docstring>
+        <p>A map from contact handles (including the local user's own handle)
+          to the codecs supported by that contact.</p>
+
+        <p>Change notification is via
+          <tp:member-ref>CodecsChanged</tp:member-ref>.</p>
+
+        <p>The local user's handle MUST be present in this map, using the
+          <tp:dbus-ref namespace="org.freedesktop.Telepathy.Channel.Interface"
+            >Group.SelfHandle</tp:dbus-ref> if the channel implements
+          Group, or the <tp:dbus-ref
+            namespace="org.freedesktop.Telepathy"
+            >Connection.SelfHandle</tp:dbus-ref> otherwise.</p>
+      </tp:docstring>
     </property>
 
     <signal name="NewCodecOffer" tp:name-for-bindings="New_Codec_Offer">
-- 
1.5.6.5




More information about the telepathy-commits mailing list