The cancelWatchAvailability()
method of the RemotePlayback
interface cancels the request to watch for one or all available devices.
RemotePlayback: cancelWatchAvailability() method
Syntax
js
cancelWatchAvailability() cancelWatchAvailability(id)
Parameters
-
id
Optional -
The
callbackId
of a particular remote playback device.If a
callbackId
of 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
-
InvalidStateError
DOMException
-
Thrown if
disableRemotePlayback
istrue
for the media element. -
NotFoundError
DOMException
-
Thrown if an
id
is 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 | Opera | Safari | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | WebView Android | ||
cancelWatchAvailability |
121 | 121 | No | 107 | 13.1 | 56 | No | 43 | 13.4 | 6.0 | No |
© 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