@sebbo2002/node-pyatv 4.3.1 → 4.3.3-develop.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/docs/coverage/cobertura-coverage.xml +4 -4
- package/docs/coverage/device-event.ts.html +1 -1
- package/docs/coverage/device-events.ts.html +1 -1
- package/docs/coverage/device.ts.html +1 -1
- package/docs/coverage/fake-spawn.ts.html +1 -1
- package/docs/coverage/index.html +1 -1
- package/docs/coverage/index.ts.html +1 -1
- package/docs/coverage/instance.ts.html +1 -1
- package/docs/coverage/tools.ts.html +4 -4
- package/docs/coverage/types.ts.html +1 -1
- package/docs/reference/assets/main.js +2 -2
- package/docs/reference/assets/style.css +3 -2
- package/docs/reference/classes/NodePyATVDevice.html +60 -60
- package/docs/reference/classes/NodePyATVDeviceEvent.html +5 -5
- package/docs/reference/classes/default.html +10 -10
- package/docs/reference/enums/NodePyATVDeviceState.html +1 -1
- package/docs/reference/enums/NodePyATVKeys.html +1 -1
- package/docs/reference/enums/NodePyATVListenerState.html +1 -1
- package/docs/reference/enums/NodePyATVMediaType.html +1 -1
- package/docs/reference/enums/NodePyATVPowerState.html +1 -1
- package/docs/reference/enums/NodePyATVProtocol.html +1 -1
- package/docs/reference/enums/NodePyATVRepeatState.html +1 -1
- package/docs/reference/enums/NodePyATVShuffleState.html +1 -1
- package/docs/reference/index.html +1 -1
- package/docs/reference/interfaces/NodePyATVDeviceOptions.html +1 -1
- package/docs/reference/interfaces/NodePyATVFindAndInstanceOptions.html +1 -1
- package/docs/reference/interfaces/NodePyATVFindOptions.html +1 -1
- package/docs/reference/interfaces/NodePyATVGetStateOptions.html +1 -1
- package/docs/reference/interfaces/NodePyATVInstanceOptions.html +1 -1
- package/docs/reference/interfaces/NodePyATVState.html +1 -1
- package/docs/reference/interfaces/NodePyATVVersionResponse.html +1 -1
- package/docs/reference/modules.html +1 -1
- package/docs/tests/assets/app.css +1 -1
- package/docs/tests/assets/app.js +2 -2
- package/docs/tests/assets/app.js.LICENSE.txt +1 -1
- package/docs/tests/index.html +1 -1
- package/docs/tests/mochawesome.json +611 -611
- package/package.json +10 -10
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NodePyATVDeviceEvent | node-pyatv - v4.3.1</title><meta name="description" content="Documentation for node-pyatv - v4.3.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">node-pyatv - v4.3.1</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">node-pyatv - v4.3.1</a></li><li><a href="NodePyATVDeviceEvent.html">NodePyATVDeviceEvent</a></li></ul><h1>Class NodePyATVDeviceEvent</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">NodePyATVDeviceEvent</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDeviceEvent.html#device" class="tsd-kind-icon">device</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDeviceEvent.html#key" class="tsd-kind-icon">key</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDeviceEvent.html#newValue" class="tsd-kind-icon">new<wbr/>Value</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDeviceEvent.html#oldValue" class="tsd-kind-icon">old<wbr/>Value</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDeviceEvent.html#value" class="tsd-kind-icon">value</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="device" class="tsd-anchor"></a><h3 class="tsd-anchor-link">device<a href="#device" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> device<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NodePyATVDeviceEvent | node-pyatv - v4.3.3-develop.1</title><meta name="description" content="Documentation for node-pyatv - v4.3.3-develop.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">node-pyatv - v4.3.3-develop.1</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">node-pyatv - v4.3.3-develop.1</a></li><li><a href="NodePyATVDeviceEvent.html">NodePyATVDeviceEvent</a></li></ul><h1>Class NodePyATVDeviceEvent </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">NodePyATVDeviceEvent</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDeviceEvent.html#device" class="tsd-kind-icon">device</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDeviceEvent.html#key" class="tsd-kind-icon">key</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDeviceEvent.html#newValue" class="tsd-kind-icon">new<wbr/>Value</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDeviceEvent.html#oldValue" class="tsd-kind-icon">old<wbr/>Value</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDeviceEvent.html#value" class="tsd-kind-icon">value</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="device" class="tsd-anchor"></a><h3 class="tsd-anchor-link">device<a href="#device" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> device<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/device-event.ts#L54">src/lib/device-event.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
2
|
<p>References the device instance this
|
|
3
3
|
event originates from</p>
|
|
4
|
-
</div></div><h4 class="tsd-returns-title">Returns <a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="key" class="tsd-anchor"></a><h3 class="tsd-anchor-link">key<a href="#key" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> key<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../interfaces/NodePyATVState.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVState</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/
|
|
4
|
+
</div></div><h4 class="tsd-returns-title">Returns <a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="key" class="tsd-anchor"></a><h3 class="tsd-anchor-link">key<a href="#key" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> key<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../interfaces/NodePyATVState.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVState</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/device-event.ts#L24">src/lib/device-event.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
5
5
|
<p>References the attribute name which was changed. So if the
|
|
6
6
|
title has been updated, this would be <code>title</code>.</p>
|
|
7
|
-
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">keyof </span><a href="../interfaces/NodePyATVState.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVState</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="newValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link">new<wbr/>Value<a href="#newValue" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> newValue<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#NodePyATVEventValueType" class="tsd-signature-type" data-tsd-kind="Type alias">NodePyATVEventValueType</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/
|
|
8
|
-
</dd></dl></div><h4 class="tsd-returns-title">Returns <a href="../modules.html#NodePyATVEventValueType" class="tsd-signature-type" data-tsd-kind="Type alias">NodePyATVEventValueType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="oldValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link">old<wbr/>Value<a href="#oldValue" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> oldValue<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#NodePyATVEventValueType" class="tsd-signature-type" data-tsd-kind="Type alias">NodePyATVEventValueType</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/
|
|
7
|
+
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">keyof </span><a href="../interfaces/NodePyATVState.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVState</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="newValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link">new<wbr/>Value<a href="#newValue" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> newValue<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#NodePyATVEventValueType" class="tsd-signature-type" data-tsd-kind="Type alias">NodePyATVEventValueType</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/device-event.ts#L39">src/lib/device-event.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>alias</dt><dd><p>value</p>
|
|
8
|
+
</dd></dl></div><h4 class="tsd-returns-title">Returns <a href="../modules.html#NodePyATVEventValueType" class="tsd-signature-type" data-tsd-kind="Type alias">NodePyATVEventValueType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="oldValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link">old<wbr/>Value<a href="#oldValue" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> oldValue<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#NodePyATVEventValueType" class="tsd-signature-type" data-tsd-kind="Type alias">NodePyATVEventValueType</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/device-event.ts#L32">src/lib/device-event.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
9
9
|
<p>Holds the old value which was there
|
|
10
10
|
before the value was changed.</p>
|
|
11
|
-
</div></div><h4 class="tsd-returns-title">Returns <a href="../modules.html#NodePyATVEventValueType" class="tsd-signature-type" data-tsd-kind="Type alias">NodePyATVEventValueType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link">value<a href="#value" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> value<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#NodePyATVEventValueType" class="tsd-signature-type" data-tsd-kind="Type alias">NodePyATVEventValueType</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/
|
|
11
|
+
</div></div><h4 class="tsd-returns-title">Returns <a href="../modules.html#NodePyATVEventValueType" class="tsd-signature-type" data-tsd-kind="Type alias">NodePyATVEventValueType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link">value<a href="#value" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> value<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#NodePyATVEventValueType" class="tsd-signature-type" data-tsd-kind="Type alias">NodePyATVEventValueType</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/device-event.ts#L46">src/lib/device-event.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
12
12
|
<p>New, current value for <code>key</code></p>
|
|
13
13
|
</div></div><h4 class="tsd-returns-title">Returns <a href="../modules.html#NodePyATVEventValueType" class="tsd-signature-type" data-tsd-kind="Type alias">NodePyATVEventValueType</a></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="NodePyATVDeviceEvent.html" class="tsd-kind-icon">Node<wbr/>PyATVDevice<wbr/>Event</a><ul><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDeviceEvent.html#device" class="tsd-kind-icon">device</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDeviceEvent.html#key" class="tsd-kind-icon">key</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDeviceEvent.html#newValue" class="tsd-kind-icon">new<wbr/>Value</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDeviceEvent.html#oldValue" class="tsd-kind-icon">old<wbr/>Value</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDeviceEvent.html#value" class="tsd-kind-icon">value</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
|
@@ -1,49 +1,49 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>default | node-pyatv - v4.3.1</title><meta name="description" content="Documentation for node-pyatv - v4.3.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">node-pyatv - v4.3.1</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">node-pyatv - v4.3.1</a></li><li><a href="default.html">default</a></li></ul><h1>Class default</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>default | node-pyatv - v4.3.3-develop.1</title><meta name="description" content="Documentation for node-pyatv - v4.3.3-develop.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">node-pyatv - v4.3.3-develop.1</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">node-pyatv - v4.3.3-develop.1</a></li><li><a href="default.html">default</a></li></ul><h1>Class default </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
2
|
<p>Default class exported by <code>@sebbo2002/node-pyatv</code>. Use <a href="default.html#find">find</a> to scan for devices in your local network. Use
|
|
3
3
|
<a href="default.html#device">device</a> to connect to a known device by passing (at least) it's name and IP.</p>
|
|
4
4
|
</div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> </span><span class="hl-0">pyatv</span><span class="hl-1"> </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">'@sebbo2002/node-pyatv'</span><span class="hl-1">;</span>
|
|
5
5
|
</code></pre>
|
|
6
|
-
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">default</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="default.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="default.html#check" class="tsd-kind-icon">check</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="default.html#device" class="tsd-kind-icon">device</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="default.html#find" class="tsd-kind-icon">find</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="default.html#version" class="tsd-kind-icon">version</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="default.html#check-1" class="tsd-kind-icon">check</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="default.html#device-1" class="tsd-kind-icon">device</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="default.html#find-1" class="tsd-kind-icon">find</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="default.html#version-1" class="tsd-kind-icon">version</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new default<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/
|
|
6
|
+
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">default</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="default.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="default.html#check" class="tsd-kind-icon">check</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="default.html#device" class="tsd-kind-icon">device</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="default.html#find" class="tsd-kind-icon">find</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="default.html#version" class="tsd-kind-icon">version</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="default.html#check-1" class="tsd-kind-icon">check</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="default.html#device-1" class="tsd-kind-icon">device</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="default.html#find-1" class="tsd-kind-icon">find</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="default.html#version-1" class="tsd-kind-icon">version</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new default<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/instance.ts#L151">src/lib/instance.ts:151</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
7
7
|
<p>Use this to apply <a href="../interfaces/NodePyATVInstanceOptions.html">NodePyATVInstanceOptions</a>
|
|
8
8
|
(e.g. debug log method) to all further requests</p>
|
|
9
9
|
</div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> </span><span class="hl-0">pyatv</span><span class="hl-1"> </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">'@sebbo2002/node-pyatv'</span><span class="hl-1">;</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">myPyatv</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">pyatv</span><span class="hl-1">({</span><span class="hl-0">debug:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1">});</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">devices</span><span class="hl-1"> = </span><span class="hl-0">myPyatv</span><span class="hl-1">.</span><span class="hl-6">find</span><span class="hl-1">();</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-0">devices</span><span class="hl-1">);</span>
|
|
10
10
|
</code></pre>
|
|
11
11
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
12
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="check" class="tsd-anchor"></a><h3 class="tsd-anchor-link">check<a href="#check" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">check<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/
|
|
12
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="check" class="tsd-anchor"></a><h3 class="tsd-anchor-link">check<a href="#check" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">check<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/instance.ts#L161">src/lib/instance.ts:161</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
13
13
|
<p>Checks if pyatv is installed and ready to be used.
|
|
14
14
|
Will throw an error if not.</p>
|
|
15
15
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
16
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="device" class="tsd-anchor"></a><h3 class="tsd-anchor-link">device<a href="#device" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">device<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/NodePyATVDeviceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVDeviceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/
|
|
16
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="device" class="tsd-anchor"></a><h3 class="tsd-anchor-link">device<a href="#device" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">device<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/NodePyATVDeviceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVDeviceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/instance.ts#L199">src/lib/instance.ts:199</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
17
17
|
<p>Create a <a href="NodePyATVDevice.html">NodePyATVDevice</a> to query the state and control it.
|
|
18
18
|
At least <code>host</code> and <code>name</code> are required.</p>
|
|
19
19
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVDeviceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVDeviceOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
20
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="find" class="tsd-anchor"></a><h3 class="tsd-anchor-link">find<a href="#find" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">find<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVFindAndInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVFindAndInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/
|
|
20
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="find" class="tsd-anchor"></a><h3 class="tsd-anchor-link">find<a href="#find" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">find<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVFindAndInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVFindAndInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/instance.ts#L189">src/lib/instance.ts:189</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
21
21
|
<p>Scan the network for Apple TVs by using pyatv's atvscript. See <a href="../interfaces/NodePyATVFindAndInstanceOptions.html">NodePyATVFindAndInstanceOptions</a>
|
|
22
22
|
for the options allowed. Use the <code>host</code> / <code>hosts</code> attribute to filter by IP addresses. Resolves with
|
|
23
23
|
an array of <a href="NodePyATVDevice.html">NodePyATVDevice</a>.</p>
|
|
24
24
|
</div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> </span><span class="hl-0">pyatv</span><span class="hl-1"> </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">'@sebbo2002/node-pyatv'</span><span class="hl-1">;</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">myPyATV</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">pyatv</span><span class="hl-1">({</span><span class="hl-0">debug:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1">});</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">devices</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">myPyATV</span><span class="hl-1">.</span><span class="hl-6">find</span><span class="hl-1">();</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-0">devices</span><span class="hl-1">);</span>
|
|
25
25
|
</code></pre>
|
|
26
26
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVFindAndInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVFindAndInstanceOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
27
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="version" class="tsd-anchor"></a><h3 class="tsd-anchor-link">version<a href="#version" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NodePyATVVersionResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVVersionResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/
|
|
27
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="version" class="tsd-anchor"></a><h3 class="tsd-anchor-link">version<a href="#version" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NodePyATVVersionResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVVersionResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/instance.ts#L171">src/lib/instance.ts:171</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
28
28
|
<p>Resolves with the version of pyatv and of the module itself.
|
|
29
29
|
If a value can't be found, null is returned instead.</p>
|
|
30
30
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
31
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NodePyATVVersionResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVVersionResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="check-1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> check<a href="#check-1" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">check<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/
|
|
31
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NodePyATVVersionResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVVersionResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="check-1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> check<a href="#check-1" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">check<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/instance.ts#L33">src/lib/instance.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
32
32
|
<p>Checks if pyatv is installed and ready to be used.
|
|
33
33
|
Will throw an error if not.</p>
|
|
34
34
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
35
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="device-1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> device<a href="#device-1" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">device<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/NodePyATVDeviceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVDeviceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/
|
|
35
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="device-1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> device<a href="#device-1" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">device<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/NodePyATVDeviceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVDeviceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/instance.ts#L135">src/lib/instance.ts:135</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
36
36
|
<p>Create a <a href="NodePyATVDevice.html">NodePyATVDevice</a> to query the state and control it.
|
|
37
37
|
At least <code>host</code> and <code>name</code> are required.</p>
|
|
38
38
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVDeviceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVDeviceOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
39
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="find-1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> find<a href="#find-1" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">find<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVFindAndInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVFindAndInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/
|
|
39
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="find-1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> find<a href="#find-1" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">find<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVFindAndInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVFindAndInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/instance.ts#L108">src/lib/instance.ts:108</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
40
40
|
<p>Scan the network for Apple TVs by using pyatv's atvscript. See <a href="../interfaces/NodePyATVFindAndInstanceOptions.html">NodePyATVFindAndInstanceOptions</a>
|
|
41
41
|
for the options allowed. Use the <code>host</code> / <code>hosts</code> attribute to filter by IP addresses. Resolves with
|
|
42
42
|
an array of <a href="NodePyATVDevice.html">NodePyATVDevice</a>.</p>
|
|
43
43
|
</div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> </span><span class="hl-0">pyatv</span><span class="hl-1"> </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">'@sebbo2002/node-pyatv'</span><span class="hl-1">;</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">devices</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">pyatv</span><span class="hl-1">.</span><span class="hl-6">find</span><span class="hl-1">();</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-0">devices</span><span class="hl-1">);</span>
|
|
44
44
|
</code></pre>
|
|
45
45
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVFindAndInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVFindAndInstanceOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
46
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="version-1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> version<a href="#version-1" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NodePyATVVersionResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVVersionResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/
|
|
46
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="version-1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> version<a href="#version-1" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/NodePyATVVersionResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVVersionResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/instance.ts#L56">src/lib/instance.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
47
47
|
<p>Resolves with the version of pyatv and of the module itself.
|
|
48
48
|
If a value can't be found, null is returned instead.</p>
|
|
49
49
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
@@ -1 +1 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NodePyATVDeviceState | node-pyatv - v4.3.1</title><meta name="description" content="Documentation for node-pyatv - v4.3.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">node-pyatv - v4.3.1</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">node-pyatv - v4.3.1</a></li><li><a href="NodePyATVDeviceState.html">NodePyATVDeviceState</a></li></ul><h1>Enumeration NodePyATVDeviceState</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#idle" class="tsd-kind-icon">idle</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#loading" class="tsd-kind-icon">loading</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#paused" class="tsd-kind-icon">paused</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#playing" class="tsd-kind-icon">playing</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#seeking" class="tsd-kind-icon">seeking</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#stopped" class="tsd-kind-icon">stopped</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="idle" class="tsd-anchor"></a><h3 class="tsd-anchor-link">idle<a href="#idle" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">idle<span class="tsd-signature-symbol"> = "idle"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/1f99981/src/lib/types.ts#L24">src/lib/types.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="loading" class="tsd-anchor"></a><h3 class="tsd-anchor-link">loading<a href="#loading" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">loading<span class="tsd-signature-symbol"> = "loading"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/1f99981/src/lib/types.ts#L25">src/lib/types.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="paused" class="tsd-anchor"></a><h3 class="tsd-anchor-link">paused<a href="#paused" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">paused<span class="tsd-signature-symbol"> = "paused"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/1f99981/src/lib/types.ts#L26">src/lib/types.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="playing" class="tsd-anchor"></a><h3 class="tsd-anchor-link">playing<a href="#playing" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">playing<span class="tsd-signature-symbol"> = "playing"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/1f99981/src/lib/types.ts#L27">src/lib/types.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="seeking" class="tsd-anchor"></a><h3 class="tsd-anchor-link">seeking<a href="#seeking" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">seeking<span class="tsd-signature-symbol"> = "seeking"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/1f99981/src/lib/types.ts#L28">src/lib/types.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="stopped" class="tsd-anchor"></a><h3 class="tsd-anchor-link">stopped<a href="#stopped" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">stopped<span class="tsd-signature-symbol"> = "stopped"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/1f99981/src/lib/types.ts#L29">src/lib/types.ts:29</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum"><a href="NodePyATVDeviceState.html" class="tsd-kind-icon">Node<wbr/>PyATVDevice<wbr/>State</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#idle" class="tsd-kind-icon">idle</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#loading" class="tsd-kind-icon">loading</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#paused" class="tsd-kind-icon">paused</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#playing" class="tsd-kind-icon">playing</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#seeking" class="tsd-kind-icon">seeking</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#stopped" class="tsd-kind-icon">stopped</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NodePyATVDeviceState | node-pyatv - v4.3.3-develop.1</title><meta name="description" content="Documentation for node-pyatv - v4.3.3-develop.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">node-pyatv - v4.3.3-develop.1</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">node-pyatv - v4.3.3-develop.1</a></li><li><a href="NodePyATVDeviceState.html">NodePyATVDeviceState</a></li></ul><h1>Enumeration NodePyATVDeviceState </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#idle" class="tsd-kind-icon">idle</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#loading" class="tsd-kind-icon">loading</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#paused" class="tsd-kind-icon">paused</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#playing" class="tsd-kind-icon">playing</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#seeking" class="tsd-kind-icon">seeking</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#stopped" class="tsd-kind-icon">stopped</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="idle" class="tsd-anchor"></a><h3 class="tsd-anchor-link">idle<a href="#idle" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">idle<span class="tsd-signature-symbol"> = "idle"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/types.ts#L24">src/lib/types.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="loading" class="tsd-anchor"></a><h3 class="tsd-anchor-link">loading<a href="#loading" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">loading<span class="tsd-signature-symbol"> = "loading"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/types.ts#L25">src/lib/types.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="paused" class="tsd-anchor"></a><h3 class="tsd-anchor-link">paused<a href="#paused" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">paused<span class="tsd-signature-symbol"> = "paused"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/types.ts#L26">src/lib/types.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="playing" class="tsd-anchor"></a><h3 class="tsd-anchor-link">playing<a href="#playing" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">playing<span class="tsd-signature-symbol"> = "playing"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/types.ts#L27">src/lib/types.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="seeking" class="tsd-anchor"></a><h3 class="tsd-anchor-link">seeking<a href="#seeking" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">seeking<span class="tsd-signature-symbol"> = "seeking"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/types.ts#L28">src/lib/types.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="stopped" class="tsd-anchor"></a><h3 class="tsd-anchor-link">stopped<a href="#stopped" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">stopped<span class="tsd-signature-symbol"> = "stopped"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/aa893fd/src/lib/types.ts#L29">src/lib/types.ts:29</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum"><a href="NodePyATVDeviceState.html" class="tsd-kind-icon">Node<wbr/>PyATVDevice<wbr/>State</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#idle" class="tsd-kind-icon">idle</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#loading" class="tsd-kind-icon">loading</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#paused" class="tsd-kind-icon">paused</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#playing" class="tsd-kind-icon">playing</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#seeking" class="tsd-kind-icon">seeking</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NodePyATVDeviceState.html#stopped" class="tsd-kind-icon">stopped</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|