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

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

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

Note

PlanetKit 6.0以前では、ミュートの制御がマイクの作動に直接的な影響を及ぼすことはありませんでした。しかし、PlanetKit 6.0からミュートの制御が次のようにマイクを制御します。

  • ローカルオーディオをミュートにすると、PlanetKitがマイクをオフにしてオーディオ送信を無効にするため、マイクインジケーター(microphone indicator)がオフになります。
  • ローカルオーディオのミュートを解除すると、PlanetKitがマイクをオンにしてオーディオ送信を有効にするため、マイクインジケーターがオンになります。

ローカルオーディオのミュート制御および共有

ローカルオーディオをミュート/ミュート解除するには、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通話

メソッド

イベント

グループ通話

メソッド

イベント