HTMLIFrameElement.getMuted()

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

[1] Supported in chrome code only.

See also

• Using the Browser API