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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
<?xml version="1.0" ?>
<node name="/Call_Content_Interface_Media"
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.Interface.Media.DRAFT"
tp:causes-havoc="experimental">
<tp:added version="0.19.0">(draft 1)</tp:added>
<tp:requires interface="org.freedesktop.Telepathy.Call.Content.DRAFT"/>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Interface to use by a software implementation of media
streaming.</p>
<p>On new <tp:dbus-ref
namespace="ofdT.Channel.Type">Call.DRAFT</tp:dbus-ref> channels,
handlers should wait for <tp:dbus-ref
namespace="ofdT.Call.Content">CodecOffer.DRAFT</tp:dbus-ref>
objects to appear (one will either already be present, or will
appear at some point in the channel's lifetime).</p>
<p>If the Call is incoming, then the codec offer's <tp:dbus-ref
namespace="ofdT.Call.Content.CodecOffer.DRAFT">RemoteContactCodecMap</tp:dbus-ref>
will already be filled with the codec information of the
remote contacts. Depending on the protocol, an outgoing call's
<tp:dbus-ref
namespace="ofdT.Call.Content.CodecOffer.DRAFT">RemoteContactCodecMap</tp:dbus-ref>
will either be filled with remote contact codec information, or
it will be empty. If empty, then this SHOULD be interpreted to
mean that all codecs are supported. Once a compatible list of
codecs has been decided, <tp:dbus-ref
namespace="ofdT.Call.Content">CodecOffer.DRAFT.Accept</tp:dbus-ref>
should be called with the details of these codecs.</p>
</tp:docstring>
<tp:struct name="Codec" array-name="Codec_List">
<tp:docstring>
A description of a codec.
</tp:docstring>
<tp:member name="Identifier" type="u">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
Numeric identifier for the codec. This will be used as the PT in the
SDP or content description.
</tp:docstring>
</tp:member>
<tp:member name="Name" type="s">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
The name of the codec.
</tp:docstring>
</tp:member>
<tp:member name="Clockrate" type="u">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
The clockrate of the codec.
</tp:docstring>
</tp:member>
<tp:member name="Channels" type="u">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
Number of channels of the codec if applicable, otherwise 0.
</tp:docstring>
</tp:member>
<tp:member name="Parameters" type="a{ss}" tp:type="String_String_Map">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
Extra parameters for this codec.
</tp:docstring>
</tp:member>
</tp:struct>
<tp:mapping name="Contact_Codec_Map">
<tp:docstring>
A map from contact to the list of codecs he or she supports.
</tp:docstring>
<tp:member name="Handle" type="u" tp:type="Contact_Handle">
<tp:docstring>
A contact handle.
</tp:docstring>
</tp:member>
<tp:member name="Codecs" type="a(usuua{ss})" tp:type="Codec[]">
<tp:docstring>
The codecs that the contact supports.
</tp:docstring>
</tp:member>
</tp:mapping>
<tp:struct name="Codec_Offering">
<tp:docstring>
A codec offer and its corresponding remote contact codec map.
</tp:docstring>
<tp:member name="Codec_Offer" type="o">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
The object path to the <tp:dbus-ref namespace="ofdT.Call.Content"
>CodecOffer.DRAFT</tp:dbus-ref>
</tp:docstring>
</tp:member>
<tp:member name="Remote_Contact_Codec_Map" type="a{ua(usuua{ss})}"
tp:type="Contact_Codec_Map">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
The <tp:dbus-ref namespace="ofdT.Call.Content"
>CodecOffer.DRAFT.RemoteContactCodecMap</tp:dbus-ref> property
of the codec offer.
</tp:docstring>
</tp:member>
</tp:struct>
<signal name="CodecsChanged" tp:name-for-bindings="Codecs_Changed">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Emitted when the codecs in use change.</p>
<p>As well as acting as change notification for the
<tp:member-ref>ContactCodecMap</tp:member-ref>, emission of this
signal implies that the <tp:member-ref>CodecOffer</tp:member-ref>
property has changed to <code>('/', {})</code>.</p>
</tp:docstring>
<arg name="Updated_Codecs" type="a{ua(usuua{ss})}"
tp:type="Contact_Codec_Map">
<tp:docstring>
A map from contact to his or her codecs. Each pair in this
map is added to the
<tp:member-ref>ContactCodecMap</tp:member-ref> property,
replacing any previous pair with that key.
</tp:docstring>
</arg>
<arg name="Removed_Contacts" type="au" tp:type="Contact_Handle[]">
<tp:docstring>
A list of keys which were removed from the
<tp:member-ref>ContactCodecMap</tp:member-ref>, probably because
those contacts left the call.
</tp:docstring>
</arg>
</signal>
<method name="UpdateCodecs" tp:name-for-bindings="Update_Codecs">
<tp:docstring>
Update the local codec mapping. This method should only be
used during an existing call to update the codec mapping.
</tp:docstring>
<arg name="Codecs" direction="in"
type="a(usuua{ss})" tp:type="Codec[]">
<tp:docstring>
The codecs now supported by the local user.
</tp:docstring>
</arg>
<tp:possible-errors>
<tp:error name="org.freedesktop.Telepathy.Error.NotAvailable">
<tp:docstring>
Raised when not used during an existing call to update the codec mapping.
</tp:docstring>
</tp:error>
</tp:possible-errors>
</method>
<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 the
<tp:member-ref>CodecsChanged</tp:member-ref> signal.</p>
</tp:docstring>
</property>
<signal name="NewCodecOffer" tp:name-for-bindings="New_Codec_Offer">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Emitted when a new <tp:dbus-ref namespace="ofdT.Call.Content"
>CodecOffer.DRAFT</tp:dbus-ref> appears. The streaming
implementation MUST respond by calling the <tp:dbus-ref
namespace="ofdT.Call.Content.CodecOffer.DRAFT"
>Accept</tp:dbus-ref> or <tp:dbus-ref
namespace="ofdT.Call.Content.CodecOffer.DRAFT"
>Reject</tp:dbus-ref> method on the codec offer object.</p>
<p>Emission of this signal indicates that the
<tp:member-ref>CodecOffer</tp:member-ref> property has changed to
<code>(Offer, Codecs)</code>.</p>
</tp:docstring>
<arg name="Offer" type="o">
<tp:docstring>
The object path of the new codec offer. This replaces any previous
codec offer.
</tp:docstring>
</arg>
<arg name="Codecs" type="a{ua(usuua{ss})}" tp:type="Contact_Codec_Map">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The <tp:dbus-ref namespace="ofdT.Call.Content"
>CodecOffer.DRAFT.RemoteContactCodecMap</tp:dbus-ref> property
of the codec offer.</p>
<tp:rationale>
Having the <tp:dbus-ref
namespace="ofdT.Call.Content.CodecOffer.DRAFT">RemoteContactCodecMap</tp:dbus-ref>
property here saves a D-Bus round-trip - it shouldn't be
necessary to get the property from the CodecOffer object, in
practice.
</tp:rationale>
</tp:docstring>
</arg>
</signal>
<property name="CodecOffer" tp:name-for-bindings="Codec_Offer"
type="(oa{ua(usuua{ss})})" tp:type="Codec_Offering" access="read">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The object path to the current
<tp:dbus-ref namespace="ofdT.Call.Content"
>CodecOffer.DRAFT</tp:dbus-ref> object, and its
<tp:dbus-ref namespace="ofdT.Call.Content"
>CodecOffer.DRAFT.RemoteContactCodecMap</tp:dbus-ref> property.
If the object path is "/" then there isn't an outstanding
codec offer, and the mapping MUST be empty.</p>
<tp:rationale>
Having the <tp:dbus-ref
namespace="ofdT.Call.Content.CodecOffer.DRAFT">RemoteContactCodecMap</tp:dbus-ref>
property here saves a D-Bus round-trip - it shouldn't be
necessary to get the property from the CodecOffer object, in
practice.
</tp:rationale>
<p>Change notification is via the
<tp:member-ref>NewCodecOffer</tp:member-ref> (which replaces the
value of this property with a new codec offer), and
<tp:member-ref>CodecsChanged</tp:member-ref> (which implies that
there is no longer any active codec offer) signals.</p>
</tp:docstring>
</property>
</interface>
</node>
<!-- vim:set sw=2 sts=2 et ft=xml: -->
|
