本文にスキップする
Version: 5.5

ミュート状態の共有および制御

ミュートとは、ローカルマイク装置から転送するオーディオを無効にすることをいいます。ローカルのオーディオをミュート/ミュート解除し、アプリケーションのミュート状態をピアと共有できます。また、特定のピアもしくはすべてのピアにミュート/ミュート解除をリクエストすることもできます。

ローカルオーディオのミュート制御と共有

ローカルオーディオをミュート/ミュート解除するにはmuteMyAudio()を使用します。

1対1通話

1対1通話では、ローカルオーディオのミュート状態の変更がpeerMicDidMuteまたはpeerMicDidUnmuteを通じてピアに転送されます。

1対1通話ローカルオーディオのミュートシーケンス図

グループ通話

グループ通話では、ローカルオーディオのミュート状態の変更がpeersMicDidMuteまたはpeersMicDidUnmuteを通じてピアに転送されます。

グループ通話ローカルオーディオのミュートシーケンス図

リモートオーディオのミュートのリクエスト

特定のピアまたはすべてのピアに対してオーディオをミュート/ミュート解除するようにリクエストできます。

  • 1対1通話やグループ通話で特定のピアに対してミュート/ミュート解除するようにリクエストするには、requestPeerMute()を使用します。
  • グループ通話ですべてのピアに対してミュート/ミュート解除するようにリクエストするには、requestPeersMute()を使用します。

ミュートリクエストはmyMuteRequestedByPeerを通じてピアに通知されます。

Note

ピアがリクエストを受信した際にオーディオをミュート/ミュート解除するかどうかは、実装によって異なります。

次の例では、ピアがリクエストに応じてミュート/ミュート解除することを仮定しています。

1対1通話

1対1通話では、リモートオーディオのミュート状態の変更がpeerMicDidMuteまたはpeerMicDidUnmuteを通じてローカルユーザーに転送されます。

1対1通話リモートオーディオのミュートシーケンス図

グループ通話

グループ通話では、リモートオーディオのミュート状態の変更がpeersMicDidMuteまたはpeersMicDidUnmuteを通じてローカルユーザーに転送されます。

グループ通話リモートオー��ディオのミュートシーケンス図

関連API

ミュートの制御とミュート状態の共有に関連するAPIは次のとおりです。

1対1通話

メソッド

  • PlanetKitCallmuteMyAudio() iOS, macOS
  • PlanetKitCallrequestPeerMute() iOS, macOS

イベント

  • PlanetKitCallDelegatepeerMicDidMute iOS, macOS
  • PlanetKitCallDelegatepeerMicDidUnmute iOS, macOS
  • PlanetKitCallDelegatemyMuteRequestedByPeer iOS, macOS

グループ通話

メソッド

  • PlanetKitConferencemuteMyAudio() iOS, macOS
  • PlanetKitConferencerequestPeerMute() iOS, macOS
  • PlanetKitConferencerequestPeersMute() iOS, macOS

イベント

  • PlanetKitConferenceDelegatepeersMicDidMute iOS, macOS
  • PlanetKitConferenceDelegatepeersMicDidUnmute iOS, macOS
  • PlanetKitConferenceDelegatemyMuteRequestedByPeer iOS, macOS