2
<node name="/Call_Content"
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.Content.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
This object represents one Content inside a <tp:dbus-ref
29
namespace="ofdT.Channel.Type">Call.DRAFT</tp:dbus-ref>. For
30
example, in an audio/video call there would be one audio content
31
and one video content. Each content has one or more <tp:dbus-ref
32
namespace="ofdT.Call">Stream.DRAFT</tp:dbus-ref> objects which
33
represent the actual transport to one or more remote contacts.
36
<tp:enum name="Content_Removal_Reason" type="u">
37
<tp:added version="0.21.2"/>
39
A representation of the reason for a content to be removed,
40
which may be used by simple clients, or used as a fallback
41
when the DBus_Reason is not understood. This enum will be
42
extended with future reasons as and when appropriate, so
43
clients SHOULD keep up to date with its values, but also be
44
happy to fallback to the Unknown value when an unknown value
48
<tp:enumvalue suffix="Unknown" value="0">
49
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
50
We just don't know. Unknown values of this enum SHOULD also be
55
<tp:enumvalue suffix="User_Requested" value="1">
56
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
57
<p>The local user requests that this content is removed
62
<tp:enumvalue suffix="Error" value="2">
63
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
64
<p>There is an error with the content which means that it
65
has to be removed from the call.</p>
69
<tp:enumvalue suffix="Unsupported" value="3">
70
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
71
<p>Some aspect of the content is unsupported so has to be
72
removed from the call.</p>
77
<method name="Remove" tp:name-for-bindings="Remove">
78
<tp:changed version="0.21.2">previously there were no
79
arguments</tp:changed>
81
Remove the content from the call.
84
<arg direction="in" name="Reason" type="u"
85
tp:type="Content_Removal_Reason">
87
A generic hangup reason.
91
<arg direction="in" name="Detailed_Removal_Reason" type="s"
92
tp:type="DBus_Error_Name">
94
A more specific reason for the content removal, if one is
95
available, or an empty string.
99
<arg direction="in" name="Message" type="s">
101
A human-readable message for the reason of removing the
102
content, such as "Fatal streaming failure" or "no codec
103
intersection". This property can be left empty if no reason
109
<tp:error name="org.freedesktop.Telepathy.Error.NetworkError" />
110
<tp:error name="org.freedesktop.Telepathy.Error.NotImplemented">
112
Raised when a Call doesn't support removing contents
113
(e.g. a Google Talk video call).
116
</tp:possible-errors>
119
<signal name="Removed" tp:name-for-bindings="Removed">
120
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
121
<p>Emitted when the content is removed from the call. This
122
is the same as the <tp:dbus-ref
123
namespace="ofdT.Channel.Type">Call.DRAFT.ContentRemoved</tp:dbus-ref>
128
<property name="Interfaces" tp:name-for-bindings="Interfaces"
129
type="as" tp:type="DBus_Interface[]" access="read" tp:immutable="yes">
130
<tp:added version="0.19.11"/>
131
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
132
<p>Extra interfaces provided by this content, such as <tp:dbus-ref
133
namespace="ofdT.Call">Content.Interface.Media.DRAFT</tp:dbus-ref> or
134
<tp:dbus-ref namespace="ofdT.Call">Content.Interface.Mute.DRAFT</tp:dbus-ref>.
135
This SHOULD NOT include the Content interface itself, and cannot
136
change once the content has been created.</p>
140
<property name="Name" tp:name-for-bindings="Name" type="s" access="read"
142
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
143
<p>The name of the content.</p>
146
The content name property should be meaningful, so should be
147
given a name which is significant to the user. The name
148
could be the "audio" or "video" string localized, or perhaps
149
include some string identifying the source, such as a webcam
155
<property name="Type" tp:name-for-bindings="Type"
156
type="u" tp:type="Media_Stream_Type" access="read" tp:immutable="yes">
157
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
158
<p>The media type of this content.</p>
162
<tp:enum name="Call_Content_Disposition" type="u">
164
The disposition of this content, which defines whether to
165
automatically start sending data on the streams when
167
namespace="ofdT.Channel.Type">Call.DRAFT</tp:dbus-ref> is
168
called on the channel.
171
<tp:enumvalue suffix="None" value="0">
172
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
173
The content has no specific disposition
177
<tp:enumvalue suffix="Initial" value="1">
178
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
179
<p>The content was initially part of the call. When
181
namespace="ofdT.Channel.Type.Call.DRAFT">Accept</tp:dbus-ref>
182
is called on the channel, all streams of this content with
184
namespace="ofdT.Call.Stream.DRAFT">LocalSendingState</tp:dbus-ref>
185
set to <tp:type>Sending_State</tp:type>_Pending_Send will be
186
moved to <tp:type>Sending_State</tp:type>_Sending as if
188
namespace="ofdT.Call.Stream.DRAFT">SetSending</tp:dbus-ref>
189
(True) had been called.</p>
194
<property name="Disposition" tp:name-for-bindings="Disposition"
195
type="u" tp:type="Call_Content_Disposition" access="read"
198
The disposition of this content.
202
<signal name="StreamsAdded" tp:name-for-bindings="Streams_Added">
203
<tp:changed version="0.21.2">plural version, renamed from
204
StreamAdded</tp:changed>
205
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
206
<p>Emitted when streams are added to a call.</p>
208
<arg name="Streams" type="ao">
211
namespace="ofdT.Call">Stream.DRAFT</tp:dbus-ref>s which were
217
<signal name="StreamsRemoved" tp:name-for-bindings="Streams_Removed">
218
<tp:changed version="0.21.2">plural version, renamed from
219
StreamRemoved</tp:changed>
220
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
221
<p>Emitted when streams are removed from a call</p>
223
<arg name="Streams" type="ao">
226
namespace="ofdT.Call">Stream.DRAFT</tp:dbus-ref>s which were
232
<property name="Streams" tp:name-for-bindings="Streams"
233
type="ao" access="read">
234
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
235
<p>The list of <tp:dbus-ref namespace="ofdT.Call"
236
>Stream.DRAFT</tp:dbus-ref> objects that exist in this
240
In a conference call multiple parties can share one media
241
content (say, audio), but the streaming of that media can
242
either be shared or separate. For example, in a multicast
243
conference all contacts would share one stream, while in a
244
Muji conference there would be a stream for each
248
<p>Change notification is through the
249
<tp:member-ref>StreamsAdded</tp:member-ref> and
250
<tp:member-ref>StreamsRemoved</tp:member-ref> signals.</p>
255
<!-- vim:set sw=2 sts=2 et ft=xml: -->