Interface Call1.Interface.Mute

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

Methods

RequestMuted (b: Muted) → nothing

Signals

MuteStateChanged (u: MuteState)

Properties

LocalMuteState u ( Local_Mute_State) Read only

Types

Local_Mute_State Enum u
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.25.2. (as stable API)
Objects implementing this interface must also implement:

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.

It should always be possible to mute an entire call. It is sometimes also possible to mute individual Contents (e.g. to prevent background noise from disturbing other participants, but remain visible on webcam) or to mute individual streams (e.g. to "whisper" to other call participants)

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)

RequestMuted (b: Muted) → nothing

Changed in 0.21.2. renamed from SetMuted to Mute
Changed in 0.21.3. renamed back from Mute to SetMuted

Parameters

  • Muted — b
    • True if the client wishes to mute the Content or Call.

Inform the CM that the Call, Content or Stream should be muted or unmuted.

The CM will tell the streaming implementation to Mute Streams as required, and emit MuteStateChanged when done.

Signals

(Permalink)

MuteStateChanged (u: MuteState)

Parameters

Emitted to indicate that the mute state has changed for this call content. This may occur as a consequence of the client calling RequestMuted, or as an indication that another client has (un)muted the content.

Properties

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

LocalMuteState — u (Local_Mute_State)

Read only
The current mute state of this part of the call. New Contents should inherit the value of this property from the parent Call1. Similarly, Streams should inherit it from the parent Content.

Types

Enum (Permalink)

Local_Mute_State — u

The mute state of (at least part of) the call. See LocalMuteState for more details.
  • Unmuted (0)
    • All streams are unmuted (the call is active). New channels SHOULD have this mute state.
  • Muted (1)
    • All streams are Muted.
  • Pending_Mute (2)
    • The connection manager is attempting to move to state Muted, but has not yet completed that operation. It is unspecified whether any, all or none of the streams making up the channel are muted. Examining the Mute state of Call Contents (if applicable) may provide more useful information.
  • Pending_Unmute (3)
    • The connection manager is attempting to move to state Unmuted, but has not yet completed that operation. It is unspecified whether any, all or none of the streams making up the channel are muted. Examining the Mute state of Call Contents or Streams may provide more useful information.
  • Partially_Muted (4)
    • Some of the constituent Streams are Muted. This state only makes sense on Call Channels or Contents. Examining the Mute state of Call Contents or Streams should provide more useful information.