RemotePlayback: cancelWatchAvailability() method
The cancelWatchAvailability() method of the RemotePlayback interface cancels the request to watch for one or all available devices.
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
| Specification |
|---|
| Remote Playback API # dom-remoteplayback-cancelwatchavailability |
Browser compatibility
BCD tables only load in the browser