2
<node name="/Call_Content_Interface_Mute" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
3
<tp:copyright> Copyright © 2005-2010 Nokia Corporation </tp:copyright>
4
<tp:copyright> Copyright © 2005-2010 Collabora Ltd </tp:copyright>
5
<tp:license xmlns="http://www.w3.org/1999/xhtml">
6
This library is free software; you can redistribute it and/or
7
modify it under the terms of the GNU Lesser General Public
8
License as published by the Free Software Foundation; either
9
version 2.1 of the License, or (at your option) any later version.
11
This library is distributed in the hope that it will be useful,
12
but WITHOUT ANY WARRANTY; without even the implied warranty of
13
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14
Lesser General Public License for more details.
16
You should have received a copy of the GNU Lesser General Public
17
License along with this library; if not, write to the Free Software
18
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21
<interface name="org.freedesktop.Telepathy.Call.Content.Interface.Mute.DRAFT" tp:causes-havoc="experimental">
22
<tp:added version="0.19.6">(draft version, not API-stable)</tp:added>
23
<tp:requires interface="org.freedesktop.Telepathy.Call.Content.DRAFT"/>
25
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
26
<p>Interface for calls which may be muted. This only makes sense
27
for channels where audio or video is streaming between members.</p>
29
<p>Muting a call content indicates that the user does not wish to send
30
outgoing audio or video.</p>
32
<p>Although it's client's responsibility to actually mute the microphone
33
or turn off the camera, using this interface the client can also
34
inform the CM and other clients of that fact.</p>
37
For some protocols, the fact that the content is muted needs
38
to be transmitted to the peer; for others, the notification
39
to the peer is only informational (eg. XMPP), and some
40
protocols may have no notion of muting at all.
44
<signal name="MuteStateChanged" tp:name-for-bindings="Mute_State_Changed">
46
Emitted to indicate that the mute state has changed for this call content.
47
This may occur as a consequence of the client calling
48
<tp:member-ref>SetMuted</tp:member-ref>, or as an indication that another
49
client has (un)muted the content.
51
<arg name="MuteState" type="b">
53
True if the content is now muted.
58
<property name="MuteState" type="b"
59
access="read" tp:name-for-bindings="Mute_State">
61
True if the content is muted.
65
<method name="SetMuted" tp:name-for-bindings="Set_Muted">
66
<tp:changed version="0.21.2">renamed from SetMuted to Mute</tp:changed>
67
<tp:changed version="0.21.3">renamed back from Mute to SetMuted</tp:changed>
68
<arg direction="in" name="Muted" type="b">
70
True if the client has muted the content.
74
<p>Inform the CM that the call content has been muted or unmuted by
77
<p>It is the client's responsibility to actually mute or unmute the
78
microphone or camera used for the content. However, the client
79
MUST call this whenever it mutes or unmutes the content.</p>
85
<!-- vim:set sw=2 sts=2 et ft=xml: -->