HTMLIFrameElement.getVolume()

The getVolume() method of the HTMLIFrameElement gets the current volume of the browser <iframe>.

Syntax

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

var request = instanceOfHTMLIframeElement.getVolume();

and a Promise version:

instanceOfHTMLIframeElement.getVolume().then(function(volume) { ... });

Returns

• Callback version: A DOMRequest that represents the get volume request. It has an onsuccess handler to handle the success case, and an onerror handler to handle the failure case. The volume value is available in the request.result property, and is a floating point number between 0 and 1.
• Promise version: A Promise that resolves with the volume value — a floating point number between 0 and 1.

Parameters

None.

Example

Callback version:

var browser = document.querySelector('iframe');
var request = browser.getVolume();
request.onsuccess = function() {
  console.log('The current browser volume is ' + request.result);
}

Promise version:

var browser = document.querySelector('iframe');
browser.getVolume().then(function(volume) {
  console.log('The current browser volume is ' + volume);
});

Specification

Not part of any specification.

Browser compatibility

[1] Supported in chrome code only.

See also

• Using the Browser API