Skip to main content
Version: 6.0

Mute sharing and control

Mute means disabling audio transmission from the local microphone. You can mute or unmute local audio and share your application's mute status with peers. You can also request a specific peer or all peers to mute or unmute their audio.

Note

Prior to PlanetKit 6.0, mute control did not directly affect the operation of microphone. Starting with PlanetKit 6.0, however, the microphone is controlled by mute control as follows:

  • When you mute the local audio, PlanetKit turns off the microphone and disables audio transmission, making the microphone indicator turned off.
  • When you unmute the local audio, PlanetKit turns on the microphone and enables audio transmission, making the microphone indicator turned on.

Control and share local audio mute​

To mute or unmute local audio, use muteMyAudio().

1-to-1 call​

In 1-to-1 calls, the status change of local audio mute is sent to peers through peerMicDidMute or peerMicDidUnmute.

1-to-1 call mute local audio sequence diagram

Group call​

In group calls, the status change of local audio mute is sent to peers through peersMicDidMute or peersMicDidUnmute.

Group call mute local audio sequence diagram

Request remote audio mute​

You can request a specific peer or all peers to mute or unmute their audio.

  • To request a specific peer to mute or unmute one's own audio in 1-to-1 calls or group calls, use requestPeerMute().
  • To request all peers to mute or unmute their audio in group calls, use requestPeersMute().

Requests for mute are notified to peers through myMuteRequestedByPeer.

Note

Whether the peers need to mute or unmute their audio when they get a request is implementation-dependent.

The following examples assume that the peers will mute or unmute their audio according to the request.

1-to-1 call​

In 1-to-1 calls, the status change of remote audio mute is sent to the local user through peerMicDidMute or peerMicDidUnmute.

1-to-1 call mute remote audio sequence diagram

Group call​

In group calls, the status change of remote audio mute is sent to the local user through peersMicDidMute or peersMicDidUnmute.

Group call mute remote audio sequence diagram

APIs related to mute sharing and control are as follows.

1-to-1 call​

Methods​

Events​

Group call​

Methods​

Events​