2
<node name="/Media_Stream_Handler" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
3
<tp:copyright> Copyright (C) 2005, 2006 Collabora Limited </tp:copyright>
4
<tp:copyright> Copyright (C) 2005, 2006 Nokia Corporation </tp:copyright>
5
<tp:copyright> Copyright (C) 2006 INdT </tp:copyright>
6
<tp:license xmlns="http://www.w3.org/1999/xhtml">
7
<p>This library is free software; you can redistribute it and/or
8
modify it under the terms of the GNU Lesser General Public
9
License as published by the Free Software Foundation; either
10
version 2.1 of the License, or (at your option) any later version.</p>
12
<p>This library is distributed in the hope that it will be useful,
13
but WITHOUT ANY WARRANTY; without even the implied warranty of
14
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15
Lesser General Public License for more details.</p>
17
<p>You should have received a copy of the GNU Lesser General Public
18
License along with this library; if not, write to the Free Software
19
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
21
<interface name="org.freedesktop.Telepathy.Media.StreamHandler">
23
<tp:struct name="Media_Stream_Handler_Candidate"
24
array-name="Media_Stream_Handler_Candidate_List">
25
<tp:member type="s" name="Name"/>
26
<tp:member type="a(usuussduss)" name="Transports"
27
tp:type="Media_Stream_Handler_Transport[]"/>
30
<tp:struct name="Media_Stream_Handler_Transport"
31
array-name="Media_Stream_Handler_Transport_List">
32
<tp:member type="u" name="Component_Number"/>
33
<tp:member type="s" name="IP_Address"/>
34
<tp:member type="u" name="Port"/>
35
<tp:member type="u" tp:type="Media_Stream_Base_Proto" name="Protocol"/>
36
<tp:member type="s" name="Subtype"/>
37
<tp:member type="s" name="Profile"/>
38
<tp:member type="d" name="Preference_Value"/>
39
<tp:member type="u" tp:type="Media_Stream_Transport_Type"
40
name="Transport_Type"/>
41
<tp:member type="s" name="Username"/>
42
<tp:member type="s" name="Password"/>
45
<tp:struct name="Media_Stream_Handler_Codec"
46
array-name="Media_Stream_Handler_Codec_List">
47
<tp:member type="u" name="Codec_ID"/>
48
<tp:member type="s" name="Name"/>
49
<tp:member type="u" tp:type="Media_Stream_Type" name="Media_Type"/>
50
<tp:member type="u" name="Clock_Rate"/>
51
<tp:member type="u" name="Number_Of_Channels"/>
52
<tp:member type="a{ss}" name="Parameters" tp:type="String_String_Map"/>
55
<signal name="AddRemoteCandidate">
56
<arg name="candidate_id" type="s">
58
String identifier for this candidate
61
<arg name="transports" type="a(usuussduss)"
62
tp:type="Media_Stream_Handler_Transport[]">
64
Array of transports for this candidate with fields,
65
as defined in NewNativeCandidate
69
Signal emitted when the connection manager wishes to inform the
70
client of a new remote candidate.
75
Signal emitted when the connection manager wishes the stream to be
79
<method name="CodecChoice">
80
<arg direction="in" name="codec_id" type="u"/>
82
Inform the connection manager of the current codec choice.
86
<arg direction="in" name="errno" type="u" tp:type="Media_Stream_Error">
88
ID of error, from the MediaStreamError enumeration
91
<arg direction="in" name="message" type="s">
93
String describing the error
97
Inform the connection manager that an error occured in this stream. The
98
connection manager should emit the StreamError signal for the stream on
99
the relevant channel, and remove the stream from the session.
102
<tp:enum name="Media_Stream_Error" type="u">
103
<tp:enumvalue suffix="Unknown" value="0">
105
An unknown error occured.
108
<tp:enumvalue suffix="EOS" value="1">
110
The end of the stream was reached.
114
<method name="NativeCandidatesPrepared">
116
Informs the connection manager that all possible native candisates
117
have been discovered for the moment.
120
<method name="NewActiveCandidatePair">
121
<arg direction="in" name="native_candidate_id" type="s"/>
122
<arg direction="in" name="remote_candidate_id" type="s"/>
124
Informs the connection manager that a valid candidate pair
125
has been discovered and streaming is in progress.
128
<tp:enum name="Media_Stream_Base_Proto" type="u">
129
<tp:enumvalue suffix="UDP" value="0">
130
<tp:docstring>UDP (User Datagram Protocol)</tp:docstring>
132
<tp:enumvalue suffix="TCP" value="1">
133
<tp:docstring>TCP (Transmission Control Protocol)</tp:docstring>
136
<method name="NewNativeCandidate">
137
<arg direction="in" name="candidate_id" type="s">
139
String identifier for this candidate
142
<arg direction="in" name="transports" type="a(usuussduss)"
143
tp:type="Media_Stream_Handler_Transport[]">
144
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
145
Array of transports for this candidate, with fields:
147
<li>component number</li>
148
<li>IP address (as a string)</li>
150
<li>base network protocol (one of the values of MediaStreamBaseProto)</li>
151
<li>proto subtype (e.g. RTP)</li>
152
<li>proto profile (e.g. AVP)</li>
153
<li>our preference value of this transport (double in range 0.0-1.0
154
inclusive); 1 signals the most preferred transport</li>
155
<li>transport type, one of the values of MediaStreamTransportType</li>
156
<li>username if authentication is required</li>
157
<li>password if authentication is required</li>
162
Inform this MediaStreamHandler that a new native transport candidate
163
has been ascertained.
166
<tp:enum name="Media_Stream_Transport_Type" type="u">
167
<tp:enumvalue suffix="Local" value="0">
172
<tp:enumvalue suffix="Derived" value="1">
174
An external address derived by a method such as STUN
177
<tp:enumvalue suffix="Relay" value="2">
179
An external stream relay
183
<method name="Ready">
184
<arg direction="in" name="codecs" type="a(usuuua{ss})">
186
As for SupportedCodecs.
190
Inform the connection manager that a client is ready to handle
191
this StreamHandler. Also provide it with info about all supported
195
<method name="SetLocalCodecs">
196
<arg name="codecs" type="a(usuuua{ss})" direction="in">
197
<tp:docstring>Codecs in the same format as for
198
SupportedCodecs, which have the same semantics as the
199
local codecs passed to Ready</tp:docstring>
202
Used to provide codecs after Ready(), so the media client can go
203
ready for an incoming call and exchange candidates/codecs before
204
knowing what local codecs are available.
207
<signal name="RemoveRemoteCandidate">
208
<arg name="candidate_id" type="s">
210
String identifier for remote candidate to drop
214
Signal emitted when the connection manager wishes to inform the
215
client that the remote end has removed a previously usable
219
<signal name="SetActiveCandidatePair">
220
<arg name="native_candidate_id" type="s"/>
221
<arg name="remote_candidate_id" type="s"/>
223
Emitted by the connection manager to inform the client that a
224
valid candidate pair has been discovered by the remote end
225
and streaming is in progress.
228
<signal name="SetRemoteCandidateList">
229
<arg name="remote_candidates" type="a(sa(usuussduss))"
230
tp:type="Media_Stream_Handler_Candidate[]">
232
A list of candidate id and a list of transports
233
as defined in NewNativeCandidate
237
Signal emitted when the connection manager wishes to inform the
238
client of all the available remote candidates at once.
241
<signal name="SetRemoteCodecs">
242
<arg name="codecs" type="a(usuuua{ss})"
243
tp:type="Media_Stream_Handler_Codec[]">
244
<tp:docstring>As for SupportedCodecs</tp:docstring>
247
Signal emitted when the connection manager wishes to inform the
248
client of the codecs supported by the remote end.
251
<signal name="SetStreamPlaying">
252
<arg name="playing" type="b"/>
254
Signal emitted when the connection manager wishes to set the
255
stream playing or stopped.
258
<signal name="SetStreamSending">
259
<arg name="sending" type="b"/>
261
Signal emitted when the connection manager wishes to set whether or not
262
the stream sends to the remote end.
265
<signal name="StartTelephonyEvent">
266
<arg name="event" type="y">
268
A telephony event code as defined by RFC 4733.
272
Request that a telephony event (as defined by RFC 4733) is transmitted
273
over this stream until StopTelephonyEvent is called.
276
<signal name="StopTelephonyEvent">
278
Request that any ongoing telephony events (as defined by RFC 4733)
279
being transmitted over this stream are stopped.
282
<method name="StreamState">
283
<arg direction="in" name="state" type="u" tp:type="Media_Stream_State"/>
285
Informs the connection manager of the stream's current state, as
286
as specified in Channel.Type.StreamedMedia::ListStreams.
289
<method name="SupportedCodecs">
290
<arg direction="in" name="codecs" type="a(usuuua{ss})"
291
tp:type="Media_Stream_Handler_Codec[]">
293
List of codec info structures, each containing:
298
<li>Clock rate of codec</li>
299
<li>Number of supported channels</li>
300
<li>String key-value pairs for supported optional parameters</li>
305
Inform the connection manager of the supported codecs for this session.
306
This is called after the connection manager has emitted SetRemoteCodecs
307
to notify what codecs are supported by the peer, and will thus be an
308
intersection of all locally supported codecs (passed to Ready)
309
and those supported by the peer.
313
Handles signalling the information pertaining to a specific media stream.
314
A client should provide information to this handler as and when it is
319
<!-- vim:set sw=2 sts=2 et ft=xml: -->
added
removed
spec/Media_Stream_Handler.xml
