diff options
author | David Laban <david.laban@collabora.co.uk> | 2011-03-11 16:22:52 +0000 |
---|---|---|
committer | David Laban <david.laban@collabora.co.uk> | 2011-03-11 16:22:52 +0000 |
commit | 71d7927cc2085940de5f47a87e62e541f90fc544 (patch) | |
tree | 5b7243cddbaa98f80f374107826ca8c72b55e0a6 /spec/Call_Content.xml | |
parent | 0af0d08bbecaa1d9f53450a4c23ec3042d27ca98 (diff) |
Merge Content.Iface.Mute into Content.
We decided mute wasn't optional.
Diffstat (limited to 'spec/Call_Content.xml')
-rw-r--r-- | spec/Call_Content.xml | 61 |
1 files changed, 59 insertions, 2 deletions
diff --git a/spec/Call_Content.xml b/spec/Call_Content.xml index c66a77c9..2743de87 100644 --- a/spec/Call_Content.xml +++ b/spec/Call_Content.xml @@ -130,8 +130,7 @@ <tp:added version="0.19.11"/> <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Extra interfaces provided by this content, such as <tp:dbus-ref - namespace="ofdT.Call">Content.Interface.Media.DRAFT2</tp:dbus-ref> or - <tp:dbus-ref namespace="ofdT.Call">Content.Interface.Mute.DRAFT</tp:dbus-ref>. + namespace="ofdT.Call">Content.Interface.Media.DRAFT2</tp:dbus-ref>. This SHOULD NOT include the Content interface itself, and cannot change once the content has been created.</p> </tp:docstring> @@ -250,6 +249,64 @@ <tp:member-ref>StreamsRemoved</tp:member-ref> signals.</p> </tp:docstring> </property> + <signal name="MuteStateChanged" tp:name-for-bindings="Mute_State_Changed"> + <tp:docstring> + Emitted to indicate that the mute state has changed for this call content. + This may occur as a consequence of the client calling + <tp:member-ref>SetMuted</tp:member-ref>, or as an indication that another + client has (un)muted the content. + </tp:docstring> + <arg name="MuteState" type="b"> + <tp:docstring> + True if the content is now muted. + </tp:docstring> + </arg> + </signal> + + <property name="MuteState" type="b" + access="read" tp:name-for-bindings="Mute_State"> + + <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> + <p>True if the content is muted.</p> + + <p>Muting a call content indicates that the user does not wish to send + outgoing audio or video.</p> + + <p>Although it may be possible for the client to actually mute the + microphone or turn off the camera itself, using this interface the + client can also inform the CM and other clients of that fact. If this + interface is used, the CM will take care of the details of telling the + streaming implementation (hardware or software) to mute all associated + streams. </p> + + <tp:rationale> + For some protocols, the fact that the content is muted needs + to be transmitted to the peer; for others, the notification + to the peer is only informational (eg. XMPP), and some + protocols may have no notion of muting at all. + </tp:rationale> + </tp:docstring> + + </property> + + <method name="SetMuted" tp:name-for-bindings="Set_Muted"> + <tp:changed version="0.21.2">renamed from SetMuted to Mute</tp:changed> + <tp:changed version="0.21.3">renamed back from Mute to SetMuted</tp:changed> + <arg direction="in" name="Muted" type="b"> + <tp:docstring> + True if the client has muted the content. + </tp:docstring> + </arg> + <tp:docstring> + <p>Inform the CM that the call content has been muted or unmuted by + the client.</p> + + <p>It is the client's responsibility to actually mute or unmute the + microphone or camera used for the content. However, the client + MUST call this whenever it mutes or unmutes the content.</p> + </tp:docstring> + </method> + </interface> </node> <!-- vim:set sw=2 sts=2 et ft=xml: --> |