2
<node name="/Call_Stream_Endpoint"
3
xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
4
<tp:copyright>Copyright © 2009-2010 Collabora Ltd.</tp:copyright>
5
<tp:copyright>Copyright © 2009-2010 Nokia Corporation</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
23
<interface name="org.freedesktop.Telepathy.Call.Stream.Endpoint.DRAFT"
24
tp:causes-havoc="experimental">
25
<tp:added version="0.19.0">(draft 1)</tp:added>
27
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
28
<p>This object represents an endpoint for a stream. In a one-to-one
29
call, there will be one (bidirectional) stream per content and
30
one endpoint per stream (as there is only one remote
31
contact). In a multi-user call there is a stream for each remote
32
contact and each stream has one endpoint as it refers to the one
33
physical machine on the other end of the stream.</p>
35
<p>The multiple endpoint use case appears when SIP call forking
36
is used. Unlike jingle call forking (which is just making
37
multiple jingle calls to different resources appear as one
38
call), SIP call forking is actually done at the server so you
39
have one stream to the remote contact and then and endpoint for
40
each SIP client to be called.</p>
43
<property name="RemoteCredentials"
44
tp:name-for-bindings="Remote_Credentials"
45
type="(ss)" tp:type="Stream_Credentials" access="read">
47
The ICE credentials used for all candidates. If each candidate
48
has different credentials, then this property SHOULD be ("",
49
""). Per-candidate credentials are set in the
50
<tp:type>Candidate</tp:type>'s
51
<tp:type>Candidate_Info</tp:type> a{sv}.
55
<signal name="RemoteCredentialsSet"
56
tp:name-for-bindings="Remote_Credentials_Set">
57
<arg name="Username" type="s">
62
<arg name="Password" type="s">
68
Emitted when the remote ICE credentials for the endpoint are
69
set. If each candidate has different credentials, then this
70
signal will never be fired.
74
<property name="RemoteCandidates" tp:name-for-bindings="Remote_Candidates"
75
type="a(usua{sv})" tp:type="Candidate[]" access="read">
77
A list of candidates for this endpoint.
81
<signal name="RemoteCandidatesAdded"
82
tp:name-for-bindings="Remote_Candidates_Added">
84
Emitted when remote candidates are added to the
85
<tp:member-ref>RemoteCandidates</tp:member-ref> property.
87
<arg name="Candidates"
88
type="a(usua{sv})" tp:type="Candidate[]">
90
The candidates that were added.
95
<signal name="CandidateSelected"
96
tp:name-for-bindings="Candidate_Selected">
98
Emitted when a candidate is selected for use in the stream.
100
<arg name="Candidate"
101
type="(usua{sv})" tp:type="Candidate">
103
The candidate that has been selected.
108
<property name="SelectedCandidate"
109
tp:name-for-bindings="Selected_Candidate"
110
type="(usua{sv})" tp:type="Candidate" access="read">
112
The candidate that has been selected for use to stream packets
113
to the remote contact. Change notification is given via the
114
the <tp:member-ref>CandidateSelected</tp:member-ref> signal.
118
<method name="SetSelectedCandidate"
119
tp:name-for-bindings="Set_Selected_Candidate">
122
<tp:member-ref>CandidateSelected</tp:member-ref>.
124
<arg name="Candidate"
125
type="(usua{sv})" tp:type="Candidate" direction="in">
127
The candidate that has been selected.
131
<tp:error name="org.freedesktop.Telepathy.Error.InvalidArgument"/>
132
</tp:possible-errors>
135
<property name="StreamState" tp:name-for-bindings="Stream_State"
136
type="u" tp:type="Media_Stream_State"
139
The stream state of the endpoint.
143
<signal name="StreamStateChanged"
144
tp:name-for-bindings="Stream_State_Changed">
146
Emitted when the <tp:member-ref>StreamState</tp:member-ref>
149
<arg name="state" type="u" tp:type="Media_Stream_State">
151
The new <tp:member-ref>StreamState</tp:member-ref> value.
156
<method name="SetStreamState"
157
tp:name-for-bindings="Set_Stream_State">
159
Change the <tp:member-ref>StreamState</tp:member-ref> of the
162
<arg direction="in" name="State" type="u" tp:type="Media_Stream_State">
164
The requested stream state.
168
<tp:error name="org.freedesktop.Telepathy.Error.InvalidArgument"/>
169
<tp:error name="org.freedesktop.Telepathy.Error.NotAvailable"/>
170
</tp:possible-errors>
173
<property name="Transport" tp:name-for-bindings="Transport"
174
type="u" tp:type="Stream_Transport_Type" access="read">
176
The transport type for the stream endpoint.
182
<!-- vim:set sw=2 sts=2 et ft=xml: -->
added
removed
telepathy-yell/spec/Call_Stream_Endpoint.xml
