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.

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.

Group call

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

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.

Group call

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

Related API

APIs related to mute sharing and control are as follows.

1-to-1 call

Methods

• muteMyAudio() of PlanetKitCall ^{iOS, macOS}
• requestPeerMute() of PlanetKitCall ^{iOS, macOS}

Events

• peerMicDidMute of PlanetKitCallDelegate ^{iOS, macOS}
• peerMicDidUnmute of PlanetKitCallDelegate ^{iOS, macOS}
• myMuteRequestedByPeer of PlanetKitCallDelegate ^{iOS, macOS}

Group call

Methods

• muteMyAudio() of PlanetKitConference ^{iOS, macOS}
• requestPeerMute() of PlanetKitConference ^{iOS, macOS}
• requestPeersMute() of PlanetKitConference ^{iOS, macOS}

Events

• peersMicDidMute of PlanetKitConferenceDelegate ^{iOS, macOS}
• peersMicDidUnmute of PlanetKitConferenceDelegate ^{iOS, macOS}
• myMuteRequestedByPeer of PlanetKitConferenceDelegate ^{iOS, macOS}