The mute
event is sent to a MediaStreamTrack
when the track's source is temporarily unable to provide media data.
When the track is once again able to produce media output, an unmute
event is sent.
During the time between the mute
event and the unmute
event, the value of the track's muted
property is true
.
Note: The condition that most people think of as "muted" (that is, a user-toggled state of silencing a track) is actually managed using the MediaStreamTrack.enabled
property, for which there are no events.
This event is not cancelable and does not bubble.
Use the event name in methods like addEventListener()
, or set an event handler property.
addEventListener("mute", (event) => {});
onmute = (event) => {};
In this example, event handlers are established for the mute
and unmute
events in order to detect when the media is not flowing from the source for the MediaStreamTrack
referenced by 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,
);
With these event handlers in place, when the track musicTrack
enters its muted
state, the element with the ID timeline-widget
gets its background color changed to #aaa
. When the track exits the muted state—detected by the arrival of an unmute
event—the background color is restored to white.
You can also use the onmute
event handler property to set up a handler for this event; similarly, the onunmute
event handler is available for setting up a handler for the unmute
event. The following example shows this:
musicTrack.onmute = (event) => {
document.getElementById("timeline-widget").style.backgroundColor = "#aaa";
};
musicTrack.onunmute = (event) => {
document.getElementById("timeline-widget").style.backgroundColor = "#fff";
};
The following example shows how to mute tracks using receivers.
audioTrack.addEventListener("mute", (event) => {
});
videoTrack.addEventListener("mute", (event) => {
});
const transceivers = peer.getTransceivers();
const audioTrack = transceivers[0];
audioTrack.direction = "recvonly";
const videoTrack = transceivers[1];
videoTrack.direction = "recvonly";
transceivers
is an array of RTCRtpTransceiver
where you can find the audio or video track sent and received. For more information, see the direction
article.