MediaStreamTrack: mute イベント

mute イベントは、トラックのソースが一時的にメディアデータを提供することができなくなったときに MediaStreamTrack へ送られます。トラックがメディア出力可能になると、 unmute が送られます。

mute イベントと unmute イベントとの間、トラックの muted プロパティの値は true になります。

メモ: 多くの人が「ミュート」と考える状態 (すなわち、トラックを無音にすることをユーザーが制御できる方法) は実際には MediaStreamTrack.enabled プロパティを使用して管理され、こちらではイベントが発生しません。

バブリング なし
キャンセル 不可
インターフェイス Event
イベントハンドラープロパティ onmute

この例では、イベントハンドラーを mute および unmute の各イベントに設定し、 MediaStreamTrack が入った変数 musicTrack のソースからメディアが流れていない場合を検出しています。

musicTrack.addEventListener("mute", event => {
  document.getElementById("timeline-widget").style.backgroundColor = "#aaa";
}, false);

musicTrack.addEventListener("unmute", event => {
 document.getElementById("timeline-widget").style.backgroundColor = "#fff";
}, false);

これらのイベントハンドラーのある場面で、トラック musicTrackmuted の状態になったとき、 timeline-widget の ID を持った要素の背景色が #aaa に変化します。トラックのミュート状態を抜けたことを — unmute イベントが到着したことによって — 検出すると、背景色は白に戻ります。

onmute イベントハンドラープロパティを使用してこのイベントのハンドラーを設定することもできます。同様に、 onunmute イベントハンドラープロパティが unmute イベントを設定するために利用できます。以下の例ではこれを示しています。

musicTrack.onmute = event => {
  document.getElementById("timeline-widget").style.backgroundColor = "#aaa";
}

musicTrack.mute = event = > {
  document.getElementById("timeline-widget").style.backgroundColor = "#fff";
}

仕様書

仕様書 状態 備考
Media Capture and Streams
unmute の定義
勧告候補 初回定義

ブラウザーの互換性

BCD tables only load in the browser

関連情報

  • onmute イベントハンドラープロパティ
  • unmute イベント