The cancelWatchAvailability() method of the RemotePlayback interface cancels the request to watch for one or all available devices.
On this page
RemotePlayback: cancelWatchAvailability() method
Syntax
js
cancelWatchAvailability()
cancelWatchAvailability(id)
Parameters
idOptional-
The
callbackIdof a particular remote playback device.If a
callbackIdof a specific device is passed in, then that device will be removed from the list of watched devices. Otherwise, the whole list will be cleared.
Return value
A Promise that resolves with undefined.
Exceptions
InvalidStateErrorDOMException-
Thrown if
disableRemotePlaybackistruefor the media element. NotFoundErrorDOMException-
Thrown if an
idis passed but it does not match any availablecallbackId.
Examples
Once a remote playback device has been identified and is connected, the monitoring of available devices can be stopped using cancelWatchAvailability().
js
function switchToRemoteUI() {
// Indicate that the state is 'connecting' or 'connected' to the user.
// For example, hide the video element as only controls are needed.
videoElem.style.display = "none";
// Stop monitoring the availability of remote playback devices.
videoElem.remote.cancelWatchAvailability();
}
Specifications
Browser compatibility
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
cancelWatchAvailability |
56 | 79 | No | No | 43 | 13.1 | No | 56 | No | 43 | 13.4 | 6.0 |
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/RemotePlayback/cancelWatchAvailability