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 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 anonsuccess
handler to handle the success case, and anonerror
handler to handle the failure case. The volume value is available in therequest.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
Supported since Firefox 47, in chrome code only.
Unlikely ever to be supported in other browsers.