HTMLIFrameElement.getMuted()

Non-standard
This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

The getMuted() method of the HTMLIFrameElement indicates whether the browser <iframe> is currently muted.

Syntax

There are two versions of this method, a callback version:

var request = instanceOfHTMLIframeElement.getMuted();

and a Promise version:

instanceOfHTMLIframeElement.getMuted().then(function(muted) { ... });

Returns

Callback version: A DOMRequest that represents the get muted request. It has an onsuccess handler to handle the success case, and an onerror handler to handle the failure case. The muted value is available in the request.result property, and is a Boolean value — true means muted, and false means unmuted.
Promise version: A Promise that resolves with the muted value — a Boolean where true means muted, and false means unmuted.

Parameters

None.

Example

Callback version:

var browser = document.querySelector('iframe');

var request = browser.getMuted();

request.onsuccess = function() {
  if(request.result) {
    console.log('The browser is muted.');
  } else {
    console.log('The browser is unmuted.');
  }
}

Promise version:

var browser = document.querySelector('iframe');

browser.getMuted().then(function(muted) {
  if(muted) {
    console.log('The browser is muted.');
  } else {
    console.log('The browser is unmuted.');
  }
});

Specification

Not part of any specification.

Browser compatibility

Supported since Firefox 47, in chrome code only.