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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
|
<?xml version="1.0" ?>
<node name="/Call_Stream_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.Stream.Interface.Media.DRAFT"
tp:causes-havoc="experimental">
<tp:added version="0.19.0">(draft 1)</tp:added>
<tp:requires interface="org.freedesktop.Telepathy.Call.Stream.DRAFT"/>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
[FIXME]
<h4>ICE restarts</h4>
<p>If the <tp:dbus-ref
namespace="ofdT.Call.Stream.Endpoint.DRAFT">RemoteCredentialsSet</tp:dbus-ref>
signal is fired during a call once it has been called before
whilst setting up the call for initial use, and the
credentials have changed, then there has been an ICE
restart. In such a case, the CM SHOULD also empty the remote
candidate list in the <tp:dbus-ref
namespace="ofdT.Call.Stream">Endpoint.DRAFT</tp:dbus-ref>.</p>
<p>If the CM does an ICE restart, then the
<tp:member-ref>PleaseRestartICE</tp:member-ref> signal is
emitted and the streaming implementation should then call
<tp:member-ref>SetCredentials</tp:member-ref> again.</p>
<p>For more information on ICE restarts see
<a href="http://tools.ietf.org/html/rfc5245#section-9.1.1.1">RFC 5245
section 9.1.1.1</a></p>
</tp:docstring>
<method name="SetCredentials" tp:name-for-bindings="Set_Credentials">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Used to set the username fragment and password for streams that have
global credentials.</p>
</tp:docstring>
<arg name="Username" type="s" direction="in">
<tp:docstring>
The username to use when authenticating on the stream.
</tp:docstring>
</arg>
<arg name="Password" type="s" direction="in">
<tp:docstring>
The password to use when authenticating on the stream.
</tp:docstring>
</arg>
</method>
<tp:mapping name="Candidate_Info">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Extra information about the candidate. Allowed and mandatory keys
depend on the transport protocol used. The following keys are commenly
used:</p>
<dl>
<dt>Type (u)</dt>
<dd>type of candidate (host, srflx, prflx, relay)</dd>
<dt>Foundation (s)</dt>
<dd>the foundation of this candiate</dd>
<dt>Protocol (u) </dt>
<dd>Underlying protocol of the candidate (udp, tcp) </dd>
<dt>Priority (u) </dt>
<dd>Priority of the candidate </dd>
<dt>BaseIP (u) </dt>
<dd>Base IP of this candidate </dd>
<dt>Username (s) </dt>
<dd>Username of this candidate
(only if credentials are per candidate)</dd>
<dt>Password (s) </dt>
<dd>Password of this candidate
(only if credentials are per candidate)</dd>
<dt>RawUDPFallback (b) </dt>
<dd>Indicate whether this candidate may be used to provide a UDP
fallback</dd>
</dl>
</tp:docstring>
<tp:member name="Key" type="s">
<tp:docstring>One of the well-known keys documented here, or an
implementation-specific key.</tp:docstring>
</tp:member>
<tp:member name="Value" type="v">
<tp:docstring>The value corresponding to that key.</tp:docstring>
</tp:member>
</tp:mapping>
<tp:enum type="u" name="Stream_Component">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
Media streams can use more than one UDP socket: one for RTP (data)
and one for RTCP (control). Most of the time, they are adjacent
to each other, but some protocols (xmpp) signal each port separately.
</tp:docstring>
<tp:enumvalue suffix="Unknown" value="0">
<tp:docstring>
The stream transport type is unknown or not applicable
(should not appear over dbus).
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Data" value="1">
<tp:docstring>
This is the high-traffic data socket, containing the audio/video
data for the stream.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Control" value="2">
<tp:docstring>
This is the low-traffic control socket, usually containing feedback
about packet loss etc.
</tp:docstring>
</tp:enumvalue>
</tp:enum>
<tp:struct name="Candidate" array-name="Candidate_List">
<tp:docstring>A Stream Candidate.</tp:docstring>
<tp:member name="Component" type="u" tp:type="Stream_Component">
<tp:docstring>The component number.</tp:docstring>
</tp:member>
<tp:member name="IP" type="s">
<tp:docstring>The IP address to use.</tp:docstring>
</tp:member>
<tp:member name="Port" type="u">
<tp:docstring>The port number to use.</tp:docstring>
</tp:member>
<tp:member name="Info" type="a{sv}" tp:type="Candidate_Info">
<tp:docstring>Additional information about the candidate.</tp:docstring>
</tp:member>
</tp:struct>
<method name="AddCandidates" tp:name-for-bindings="Add_Candidates">
<tp:docstring>
Add candidates to the
<tp:member-ref>LocalCandidates</tp:member-ref> property and
signal them to the remote contact(s).
</tp:docstring>
<arg name="Candidates" direction="in"
type="a(usua{sv})" tp:type="Candidate[]">
<tp:docstring>
The candidates to be added.
</tp:docstring>
</arg>
</method>
<method name="CandidatesPrepared"
tp:name-for-bindings="Candidates_Prepared">
<tp:docstring>
This indicates to the CM that the initial batch of candidates
has been added.
</tp:docstring>
</method>
<tp:enum type="u" name="Stream_Transport_Type">
<tp:changed version="0.21.2">WLM_8_5 was removed</tp:changed>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
A transport that can be used for streaming.
</tp:docstring>
<tp:enumvalue suffix="Unknown" value="0">
<tp:docstring>
The stream transport type is unknown or not applicable
(for streams that do not have a configurable transport).
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Raw_UDP" value="1">
<tp:docstring>
Raw UDP, with or without STUN. All streaming clients are assumed to
support this transport, so there is no handler capability token for
it in the <tp:dbus-ref namespace="ofdT.Channel.Type"
>Call.DRAFT</tp:dbus-ref> interface.
[This corresponds to "none" or "stun" in the old Media.StreamHandler
interface.]
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="ICE" value="2">
<tp:docstring>
Interactive Connectivity Establishment, as defined by RFC
5245. Note that this value covers ICE-UDP only.
[This corresponds to "ice-udp" in the old
Media.StreamHandler interface.]
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="GTalk_P2P" value="3">
<tp:docstring>
Google Talk peer-to-peer connectivity establishment, as implemented
by libjingle 0.3.
[This corresponds to "gtalk-p2p" in the old Media.StreamHandler
interface.]
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="WLM_2009" value="4">
<tp:docstring>
The transport used by Windows Live Messenger 2009 or later, which
resembles ICE draft 19.
[This corresponds to "wlm-2009" in the old Media.StreamHandler
interface.]
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="SHM" value="5">
<tp:added version="0.21.2"/>
<tp:docstring>
Shared memory transport, as implemented by the GStreamer
shmsrc and shmsink plugins.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="Multicast" value="6">
<tp:added version="0.21.5"/>
<tp:docstring>
Multicast transport.
</tp:docstring>
</tp:enumvalue>
</tp:enum>
<property name="Transport" tp:name-for-bindings="Transport"
type="u" tp:type="Stream_Transport_Type" access="read" tp:immutable="yes">
<tp:docstring>
The transport for this stream.
</tp:docstring>
</property>
<property name="LocalCandidates" tp:name-for-bindings="Local_Candidates"
type="a(usua{sv})" tp:type="Candidate[]" access="read">
<tp:docstring>
[FIXME]. Change notification is via the
<tp:member-ref>LocalCandidatesAdded</tp:member-ref> signal.
</tp:docstring>
</property>
<signal name="LocalCandidatesAdded"
tp:name-for-bindings="Local_Candidates_Added">
<tp:docstring>
Emitted when local candidates are added to the
<tp:member-ref>LocalCandidates</tp:member-ref> property.
</tp:docstring>
<arg name="Candidates" type="a(usua{sv})" tp:type="Candidate[]">
<tp:docstring>
Candidates that have been added.
</tp:docstring>
</arg>
</signal>
<tp:struct name="Stream_Credentials">
<tp:docstring>A username and password pair.</tp:docstring>
<tp:member name="Username" type="s">
<tp:docstring>The username.</tp:docstring>
</tp:member>
<tp:member name="Password" type="s">
<tp:docstring>The password.</tp:docstring>
</tp:member>
</tp:struct>
<property name="LocalCredentials" tp:name-for-bindings="Local_Credentials"
type="(ss)" tp:type="Stream_Credentials" access="read">
<tp:docstring>
[FIXME]. Change notification is via the
<tp:member-ref>LocalCredentialsChanged</tp:member-ref> signal.
</tp:docstring>
</property>
<signal name="LocalCredentialsChanged"
tp:name-for-bindings="Local_Credentials_Changed">
<tp:changed version="0.21.2">renamed from LocalCredentailsSet</tp:changed>
<tp:docstring>
Emitted when the value of
<tp:member-ref>LocalCredentials</tp:member-ref> changes.
</tp:docstring>
<arg name="Username" type="s" />
<arg name="Password" type="s" />
</signal>
<signal name="RelayInfoChanged"
tp:name-for-bindings="Relay_Info_Changed">
<tp:docstring>
Emitted when the value of
<tp:member-ref>RelayInfo</tp:member-ref> changes.
</tp:docstring>
<arg name="Relay_Info" type="aa{sv}" tp:type="String_Variant_Map[]" />
</signal>
<signal name="STUNServersChanged"
tp:name-for-bindings="STUN_Servers_Changed">
<tp:docstring>
Emitted when the value of
<tp:member-ref>STUNServers</tp:member-ref> changes.
</tp:docstring>
<arg name="Servers" type="a(sq)" tp:type="Socket_Address_IP[]" />
</signal>
<property name="STUNServers" tp:name-for-bindings="STUN_Servers"
type="a(sq)" tp:type="Socket_Address_IP[]" access="read">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The IP addresses of possible STUN servers to use for NAT
traversal, as dotted-quad IPv4 address literals or RFC2373
IPv6 address literals. Change notification is via the
<tp:member-ref>STUNServersChanged</tp:member-ref>
signal. The IP addresses MUST NOT be given as DNS hostnames.</p>
<tp:rationale>
High-quality connection managers already need an asynchronous
DNS resolver, so they might as well resolve this name to an IP
to make life easier for streaming implementations.
</tp:rationale>
</tp:docstring>
</property>
<property name="RelayInfo" type="aa{sv}" access="read"
tp:type="String_Variant_Map[]" tp:name-for-bindings="Relay_Info">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>A list of mappings describing TURN or Google relay servers
available for the client to use in its candidate gathering, as
determined from the protocol. Map keys are:</p>
<dl>
<dt><code>ip</code> - s</dt>
<dd>The IP address of the relay server as a dotted-quad IPv4
address literal or an RFC2373 IPv6 address literal. This MUST NOT
be a DNS hostname.
<tp:rationale>
High-quality connection managers already need an asynchronous
DNS resolver, so they might as well resolve this name to an IP
and make life easier for streaming implementations.
</tp:rationale>
</dd>
<dt><code>type</code> - s</dt>
<dd>
<p>Either <code>udp</code> for UDP (UDP MUST be assumed if this
key is omitted), <code>tcp</code> for TCP, or
<code>tls</code>.</p>
<p>The precise meaning of this key depends on the
<tp:member-ref>Transport</tp:member-ref> property: if
Transport is ICE, <code>tls</code> means
TLS over TCP as referenced by ICE draft 19, and if
Transport is GTalk_P2P, <code>tls</code> means
a fake SSL session over TCP as implemented by libjingle.</p>
</dd>
<dt><code>port</code> - q</dt>
<dd>The UDP or TCP port of the relay server as an ASCII unsigned
integer</dd>
<dt><code>username</code> - s</dt>
<dd>The username to use</dd>
<dt><code>password</code> - s</dt>
<dd>The password to use</dd>
<dt><code>component</code> - u</dt>
<dd>The component number to use this relay server for, as an
ASCII unsigned integer; if not included, this relay server
may be used for any or all components.
<tp:rationale>
In ICE draft 6, as used by Google Talk, credentials are only
valid once, so each component needs relaying separately.
</tp:rationale>
</dd>
</dl>
<tp:rationale>
<p>An equivalent of the gtalk-p2p-relay-token property on
MediaSignalling channels is not included here. The connection
manager should be responsible for making the necessary HTTP
requests to turn the token into a username and password.</p>
</tp:rationale>
<p>The type of relay server that this represents depends on
the value of the <tp:member-ref>Transport</tp:member-ref>
property. If Transport is ICE, this is a TURN server;
if Transport is GTalk_P2P, this is a Google relay server;
otherwise, the meaning of RelayInfo is undefined.</p>
<p>If relaying is not possible for this stream, the list is
empty.</p>
<p>Change notification is given via the
<tp:member-ref>RelayInfoChanged</tp:member-ref> signal.</p>
</tp:docstring>
</property>
<signal name="ServerInfoRetrieved"
tp:name-for-bindings="Server_Info_Retrieved">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Signals that the initial information about STUN and Relay servers
has been retrieved, i.e. the
<tp:member-ref>HasServerInfo</tp:member-ref> property is
now true.</p>
</tp:docstring>
</signal>
<property name="HasServerInfo" type="b"
tp:name-for-bindings="Has_Server_Info" access="read">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>True if all the initial information about STUN servers and Relay
servers has been retrieved. Change notification is via the
<tp:member-ref>ServerInfoRetrieved</tp:member-ref> signal.</p>
<tp:rationale>
Streaming implementations that can't cope with STUN and
relay servers being added later SHOULD wait for this
property to become true before proceeding.
</tp:rationale>
</tp:docstring>
</property>
<signal name="EndpointsChanged"
tp:name-for-bindings="Endpoints_Changed">
<tp:docstring>
Emitted when the <tp:member-ref>Endpoints</tp:member-ref> property
changes.
</tp:docstring>
<arg name="Endpoints_Added" type="ao">
<tp:docstring>
Endpoints that were added.
</tp:docstring>
</arg>
<arg name="Endpoints_Removed" type="ao">
<tp:docstring>
Endpoints that no longer exist.
</tp:docstring>
</arg>
</signal>
<property name="Endpoints" tp:name-for-bindings="Endpoints"
type="ao" access="read">
<tp:docstring>
<p>The list of <tp:dbus-ref namespace="ofdT.Call.Stream"
>Endpoint.DRAFT</tp:dbus-ref> objects that exist for this
stream.</p>
<p>Change notification is via the
<tp:member-ref>EndpointsChanged</tp:member-ref> signal.</p>
</tp:docstring>
</property>
<signal name="PleaseRestartICE"
tp:name-for-bindings="Please_Restart_ICE">
<tp:docstring>
Emitted when the CM does an ICE restart to notify the
streaming implementation that it should call
<tp:member-ref>SetCredentials</tp:member-ref> again.
</tp:docstring>
</signal>
</interface>
</node>
<!-- vim:set sw=2 sts=2 et ft=xml: -->
|