Interface Call.Content.Interface.Mute.DRAFT

Interface Index (Compact) | Summary | Description | Methods | Signals | Properties

Methods

Muted (b: Muted) → nothing

Signals

MuteStateChanged (b: MuteState)

Properties

MuteState b Read only
WARNING: This interface is experimental and is likely to cause havoc to your API/ABI if bindings are generated. Do not include this interface in libraries that care about compatibility.
Added in 0.19.6. (draft version, not API-stable)

Description

Interface for calls which may be muted. This only makes sense for channels where audio or video is streaming between members.

Muting a call content indicates that the user does not wish to send outgoing audio or video.

Although it's client's responsibility to actually mute the microphone or turn off the camera, using this interface the client can also inform the CM and other clients of that fact.

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.

Methods

(Permalink)

Muted (b: Muted) → nothing

Parameters

  • Muted — b
    • True if the client has muted the content.

Inform the CM that the call content has been muted or unmuted by che client.

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.

Signals

(Permalink)

MuteStateChanged (b: MuteState)

Parameters

  • MuteState — b
    • True if the content is now muted.
Emitted to indicate that the mute state has changed for this call content. This may occur as a consequence of the client calling Muted, or as an indication that another client has (un)muted the content.

Properties

Accessed using the org.freedesktop.DBus.Properties interface.
(Permalink)

MuteState — b

Read only
True if the content is muted.