summaryrefslogtreecommitdiff
path: root/spec/Call_Content_Codec_Offer.xml
blob: f88143f69751e30ee4550cb71b23231ddd24f6b1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
<?xml version="1.0" ?>
<node name="/Call_Content_Codec_Offer"
  xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
  <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
      License as published by the Free Software Foundation; either
      version 2.1 of the License, or (at your option) any later version.</p>

    <p>This library is distributed in the hope that it will be useful,
      but WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      Lesser General Public License for more details.</p>

    <p>You should have received a copy of the GNU Lesser General Public
      License along with this library; if not, write to the Free Software
      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
      02110-1301, USA.</p>
  </tp:license>

  <interface name="org.freedesktop.Telepathy.Call.Content.CodecOffer.DRAFT"
      tp:causes-havoc="experimental">
    <tp:added version="0.19.0">(draft 1)</tp:added>

    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
      This object represents an offer of a Codec payload mapping.
    </tp:docstring>

    <method name="Accept" tp:name-for-bindings="Accept">
      <arg name="Codecs" direction="in"
        type="a(usuua{ss})" tp:type="Codec[]">
        <tp:docstring>
          The local codec mapping to send to the remote contacts and
          to use in the <tp:dbus-ref
          namespace="ofdT.Call">Content.DRAFT</tp:dbus-ref>.
        </tp:docstring>
      </arg>
      <tp:docstring>
        Accept the updated Codec mapping and update the local mapping.
      </tp:docstring>
      <tp:possible-errors>
        <tp:error name="org.freedesktop.Telepathy.Error.InvalidArgument">
          <tp:docstring>
            The codecs given as the argument are invalid in some way.
          </tp:docstring>
        </tp:error>
      </tp:possible-errors>
    </method>

    <method name="Reject" tp:name-for-bindings="Reject">
      <tp:docstring>
        Reject the proposed update to the codecs
        FIXME add error codes and strings here
      </tp:docstring>
    </method>

    <property name="Interfaces" tp:name-for-bindings="Interfaces"
      type="as" tp:type="DBus_Interface[]" access="read" tp:immutable="yes">
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
        <p>Extra interfaces provided by this codec offer.  This SHOULD
          NOT include the CodecOffer interface itself, and cannot change
          once the content has been created.</p>
      </tp:docstring>
    </property>

    <property name="RemoteContactCodecs"
      tp:name-for-bindings="Remote_Contact_Codecs"
      type="a(usuua{ss})" tp:type="Codec[]" access="read"
      tp:immutable="yes">
      <tp:docstring>
        A list of codecs the remote contact supports.
      </tp:docstring>
    </property>

    <property name="RemoteContact" tp:name-for-bindings="Remote_Contact"
      type="u" tp:type="Contact_Handle" access="read" tp:immutable="yes">
      <tp:docstring>
        The contact handle that this codec offer applies to.
      </tp:docstring>
    </property>


  </interface>
</node>
<!-- vim:set sw=2 sts=2 et ft=xml: -->