/
index.md
60 lines (40 loc) · 1.74 KB
/
index.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
---
title: "RemotePlayback: cancelWatchAvailability() method"
short-title: cancelWatchAvailability()
slug: Web/API/RemotePlayback/cancelWatchAvailability
page-type: web-api-instance-method
browser-compat: api.RemotePlayback.cancelWatchAvailability
---
{{APIRef("Remote Playback API")}}
The **`cancelWatchAvailability()`** method of the {{domxref("RemotePlayback")}} interface cancels the request to watch for one or all available devices.
## Syntax
```js-nolint
cancelWatchAvailability()
cancelWatchAvailability(id)
```
### Parameters
- `id` {{optional_inline}}
- : 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 {{jsxref("Promise")}} that resolves with `undefined`.
### Exceptions
- `InvalidStateError` {{domxref("DOMException")}}
- : Thrown if {{domxref("HTMLMediaElement.disableRemotePlayback","disableRemotePlayback")}} is `true` for the media element.
- `NotFoundError` {{domxref("DOMException")}}
- : Thrown if an `id` is passed but it does not match any available `callbackId`.
## 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
{{Specifications}}
## Browser compatibility
{{Compat}}