summaryrefslogtreecommitdiff
path: root/spec/Call_Content_Codec_Offer_Interface_RTCP_Feedback.xml
blob: 41f157164e10646db665cebdb031d84b3dd2514c (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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<?xml version="1.0" ?>
<node name="/Call_Content_Codec_Offer_Interface_RTCP_Feedback" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
  <tp:copyright> Copyright © 2005-2010 Nokia Corporation </tp:copyright>
  <tp:copyright> Copyright © 2005-2010 Collabora Ltd </tp:copyright>
  <tp:license xmlns="http://www.w3.org/1999/xhtml">
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.

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.

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.
  </tp:license>

  <interface name="org.freedesktop.Telepathy.Call.Content.CodecOffer.Interface.RTCPFeedback.DRAFT"
    tp:causes-havoc="experimental">
    <tp:added version="0.21.UNRELEASED">(draft version, not API-stable)</tp:added>
    <tp:requires interface="org.freedesktop.Telepathy.Call.Content.CodecOffer.DRAFT"/>

    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
      <p>This codec offer interface provides a method of signalling
        support for RTCP feedback, documented by <em>Extended RTP
        Profile for Real-time Transport Control Protocol (RTCP)-Based
        Feedback (RTP/AVPF)</em> (RFC 4585).</p>

      <p>Handlers should call
        <tp:member-ref>SetLocalFeedbackCodecs</tp:member-ref> just
        before calling <tp:dbus-ref
        namespace="ofdT.Call.Content">CodecOffer.DRAFT.Accept</tp:dbus-ref>.
        The codec identifiers used in
        <tp:member-ref>SetLocalFeedbackCodecs</tp:member-ref> should
        refer to the codecs used as <tp:dbus-ref
        namespace="ofdT.Call.Content.CodecOffer.DRAFT">Accept</tp:dbus-ref>'s
        arguments.
      </p>

      <p>If the remote contact codecs are already known (by examining
        the <tp:dbus-ref
        namespace="ofdT.Call.Content">CodecOffer.DRAFT.RemoteContactCodecMap</tp:dbus-ref>
        property) and the codec offer has the <tp:dbus-ref
        namespace="ofdT.Call.Content.CodecOffer.Interface">RTCPFeedback.DRAFT</tp:dbus-ref>
        interface, then the
        <tp:member-ref>RemoteFeedbackCodecs</tp:member-ref> property
        may contain useful details about what feedback parameters the
        remote contact supports.</p>

      <p>For more details on what RTCP Feedback can do and how to use
        it, one should refer to
        <a href="http://www.faqs.org/rfcs/rfc4585.html">RFC 4585</a>.</p>

    </tp:docstring>

    <method name="SetLocalFeedbackCodecs"
      tp:name-for-bindings="Set_Local_Feedback_Codecs">
      <arg name="Codecs" direction="in" type="a{ua(sa{ss})}"
        tp:type="RTCP_Feedback_Codec_Map" />
      <tp:docstring>
        Sets the <tp:member-ref>LocalFeedbackCodecs</tp:member-ref>
        property. This method should be called just before calling
        <tp:dbus-ref
        namespace="ofdT.Call.Content">CodecOffer.DRAFT.Accept</tp:dbus-ref>
        and should refer to the codecs used as the argument to said
        function.
      </tp:docstring>

      <tp:possible-errors>
        <tp:error name="org.freedesktop.Telepathy.Error.InvalidArgument"/>
      </tp:possible-errors>
    </method>

    <tp:struct name="RTCP_Feedback_Codec_Properties"
      array-name="RTCP_Feedback_Codec_Properties_List">
      <tp:docstring>
        A struct representing the properties of an RTCP feedback
        codec.
      </tp:docstring>
      <tp:member type="s" name="Type">
        <tp:docstring>
          Feedback type, for example "ack", "nack", or "ccm".
        </tp:docstring>
      </tp:member>
      <tp:member type="a{ss}" name="Parameters" tp:type="String_String_Map">
        <tp:docstring>
          Feedback parameters.
        </tp:docstring>
      </tp:member>
    </tp:struct>

    <tp:mapping name="RTCP_Feedback_Codec_Map">
      <tp:docstring>
        A map of codec and its feedback properties.
      </tp:docstring>
      <tp:member type="u" name="Codec_Identifier">
        <tp:docstring>
           Numeric identifier for the codec. This will be used as the
           PT in the SDP or content description.
        </tp:docstring>
      </tp:member>
      <tp:member type="a(sa{ss})" tp:type="RTCP_Feedback_Codec_Properties[]"
        name="Properties">
        <tp:docstring>
          The RTCP feedback properties for this codec.
        </tp:docstring>
      </tp:member>
    </tp:mapping>

    <property name="LocalFeedbackCodecs" type="a{ua(sa{ss})}"
      tp:type="RTCP_Feedback_Codec_Map"
      access="read" tp:name-for-bindings="Local_Feedback_Codecs">
      <tp:docstring>
        A map of local codec properties which have been set using the
        <tp:member-ref>SetLocalFeedbackCodecs</tp:member-ref> method.
      </tp:docstring>
    </property>

    <property name="RemoteFeedbackCodecs" type="a{ua(sa{ss})}"
      tp:type="RTCP_Feedback_Codec_Map"
      access="read" tp:name-for-bindings="Remote_Feedback_Codecs">
      <tp:docstring>
        A map of remote feedback codec properties which have been set
        by the CM.
      </tp:docstring>
    </property>

    <property name="RTCPMinimumInterval" type="u"
      access="read" tp:name-for-bindings="RTCP_Minimum_Interval">
      <tp:docstring>
        The minimum interval between two regular RTCP packets in
        milliseconds for this content. The default value is zero.
      </tp:docstring>
    </property>

    <property name="DoesAVPF" type="b"
      access="read" tp:name-for-bindings="Does_AVPF">
      <tp:docstring>
        True if the remote contact supports Audio-Visual Profile
        Feedback (AVPF), otherwise False.
      </tp:docstring>
    </property>
  </interface>
</node>
<!-- vim:set sw=2 sts=2 et ft=xml: -->