MediaSession: setMicrophoneActive() method
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The MediaSession
method setMicrophoneActive()
is used to indicate to the user agent whether the user's microphone is considered to be currently muted.
Call this method on the navigator
object's
mediaSession
object.
Note that the status of the microphone is not tracked in the MediaSession
itself, but must be tracked separately.
Syntax
js
setMicrophoneActive(active)
Parameters
active
-
A boolean indicating whether the microphone is considered muted or not.
Return value
None (undefined
).
Examples
Below is an example of updating the microphone mute state of the current
MediaSession
, as well as listening to requests to change the mute status with setActionHandler()
.
js
let microphoneActive = false;
navigator.mediaSession.setMicrophoneActive(microphoneActive);
navigator.mediaSession.setActionHandler("togglemicrophone", () => {
microphoneActive = !microphoneActive;
navigator.mediaSession.setMicrophoneActive(microphoneActive);
});
Specifications
Specification |
---|
Media Session Standard # dom-mediasession-setmicrophoneactive |
Browser compatibility
BCD tables only load in the browser