@sebbo2002/node-pyatv 5.1.0-develop.1 → 5.1.0

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.
Files changed (40) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/docs/coverage/cobertura-coverage.xml +4 -4
  3. package/docs/coverage/device-event.ts.html +1 -1
  4. package/docs/coverage/device-events.ts.html +1 -1
  5. package/docs/coverage/device.ts.html +1 -1
  6. package/docs/coverage/fake-spawn.ts.html +1 -1
  7. package/docs/coverage/index.html +1 -1
  8. package/docs/coverage/index.ts.html +1 -1
  9. package/docs/coverage/instance.ts.html +1 -1
  10. package/docs/coverage/tools.ts.html +4 -4
  11. package/docs/coverage/types.ts.html +1 -1
  12. package/docs/reference/assets/highlight.css +22 -8
  13. package/docs/reference/assets/main.js +3 -3
  14. package/docs/reference/assets/style.css +6 -82
  15. package/docs/reference/classes/NodePyATVDevice.html +298 -233
  16. package/docs/reference/classes/NodePyATVDeviceEvent.html +27 -20
  17. package/docs/reference/classes/NodePyATVInstance.html +47 -36
  18. package/docs/reference/enums/NodePyATVDeviceState.html +13 -11
  19. package/docs/reference/enums/NodePyATVExecutableType.html +9 -7
  20. package/docs/reference/enums/NodePyATVKeys.html +30 -28
  21. package/docs/reference/enums/NodePyATVListenerState.html +11 -9
  22. package/docs/reference/enums/NodePyATVMediaType.html +11 -9
  23. package/docs/reference/enums/NodePyATVPowerState.html +9 -7
  24. package/docs/reference/enums/NodePyATVProtocol.html +11 -9
  25. package/docs/reference/enums/NodePyATVRepeatState.html +10 -8
  26. package/docs/reference/enums/NodePyATVShuffleState.html +10 -8
  27. package/docs/reference/index.html +55 -5
  28. package/docs/reference/interfaces/NodePyATVDeviceOptions.html +64 -63
  29. package/docs/reference/interfaces/NodePyATVFindAndInstanceOptions.html +50 -49
  30. package/docs/reference/interfaces/NodePyATVFindOptions.html +34 -32
  31. package/docs/reference/interfaces/NodePyATVGetStateOptions.html +10 -8
  32. package/docs/reference/interfaces/NodePyATVInstanceOptions.html +23 -22
  33. package/docs/reference/interfaces/NodePyATVService.html +9 -7
  34. package/docs/reference/interfaces/NodePyATVState.html +22 -20
  35. package/docs/reference/interfaces/NodePyATVVersionResponse.html +9 -7
  36. package/docs/reference/modules.html +4 -4
  37. package/docs/reference/types/NodePyATVEventValueType.html +5 -5
  38. package/docs/tests/index.html +1 -1
  39. package/docs/tests/mochawesome.json +650 -650
  40. package/package.json +5 -5
package/docs/reference/enums/NodePyATVProtocol.html CHANGED
@@ -1,18 +1,20 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NodePyATVProtocol | node-pyatv - v5.1.0-develop.1</title><meta name="description" content="Documentation for node-pyatv - v5.1.0-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.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NodePyATVProtocol | node-pyatv - v5.1.0</title><meta name="description" content="Documentation for node-pyatv - v5.1.0"/><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.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
5
  <ul class="results">
6
6
  <li class="state loading">Preparing search index...</li>
7
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">node-pyatv - v5.1.0-develop.1</a></div>
7
+ <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">node-pyatv - v5.1.0</a></div>
8
8
  <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
9
  <div class="container container-main">
10
10
  <div class="col-8 col-content">
11
11
  <div class="tsd-page-title">
12
12
  <ul class="tsd-breadcrumb">
13
- <li><a href="../modules.html">node-pyatv - v5.1.0-develop.1</a></li>
13
+ <li><a href="../modules.html">node-pyatv - v5.1.0</a></li>
14
14
  <li><a href="NodePyATVProtocol.html">NodePyATVProtocol</a></li></ul>
15
- <h1>Enumeration NodePyATVProtocol</h1></div>
15
+ <h1>Enumeration NodePyATVProtocol</h1></div><aside class="tsd-sources">
16
+ <ul>
17
+ <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37b5e50/src/lib/types.ts#L9">src/lib/types.ts:9</a></li></ul></aside>
16
18
  <section class="tsd-panel-group tsd-index-group">
17
19
  <section class="tsd-panel tsd-index-panel">
18
20
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -31,22 +33,22 @@
31
33
  <h3 class="tsd-anchor-link"><span>airplay</span><a href="#airplay" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
32
34
  <div class="tsd-signature">airplay<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;airplay&quot;</span></div><aside class="tsd-sources">
33
35
  <ul>
34
- <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/e58764c/src/lib/types.ts#L12">src/lib/types.ts:12</a></li></ul></aside></section>
36
+ <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37b5e50/src/lib/types.ts#L12">src/lib/types.ts:12</a></li></ul></aside></section>
35
37
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="dmap" class="tsd-anchor"></a>
36
38
  <h3 class="tsd-anchor-link"><span>dmap</span><a href="#dmap" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
37
39
  <div class="tsd-signature">dmap<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;dmap&quot;</span></div><aside class="tsd-sources">
38
40
  <ul>
39
- <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/e58764c/src/lib/types.ts#L10">src/lib/types.ts:10</a></li></ul></aside></section>
41
+ <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37b5e50/src/lib/types.ts#L10">src/lib/types.ts:10</a></li></ul></aside></section>
40
42
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="mdns" class="tsd-anchor"></a>
41
43
  <h3 class="tsd-anchor-link"><span>mdns</span><a href="#mdns" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
42
44
  <div class="tsd-signature">mdns<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;mdns&quot;</span></div><aside class="tsd-sources">
43
45
  <ul>
44
- <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/e58764c/src/lib/types.ts#L13">src/lib/types.ts:13</a></li></ul></aside></section>
46
+ <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37b5e50/src/lib/types.ts#L13">src/lib/types.ts:13</a></li></ul></aside></section>
45
47
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="mrp" class="tsd-anchor"></a>
46
48
  <h3 class="tsd-anchor-link"><span>mrp</span><a href="#mrp" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
47
49
  <div class="tsd-signature">mrp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;mrp&quot;</span></div><aside class="tsd-sources">
48
50
  <ul>
49
- <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/e58764c/src/lib/types.ts#L11">src/lib/types.ts:11</a></li></ul></aside></section></section></div>
51
+ <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37b5e50/src/lib/types.ts#L11">src/lib/types.ts:11</a></li></ul></aside></section></section></div>
50
52
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
51
53
  <div class="tsd-navigation settings">
52
54
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -64,7 +66,7 @@
64
66
  <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
65
67
  <div class="tsd-accordion-details">
66
68
  <ul>
67
- <li><a href="../modules.html">node-<wbr/>pyatv -<wbr/> v5.1.0-<wbr/>develop.1</a>
69
+ <li><a href="../modules.html">node-<wbr/>pyatv -<wbr/> v5.1.0</a>
68
70
  <ul></ul></li></ul></div></details></nav>
69
71
  <nav class="tsd-navigation secondary menu-sticky">
70
72
  <ul>
package/docs/reference/enums/NodePyATVRepeatState.html CHANGED
@@ -1,18 +1,20 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NodePyATVRepeatState | node-pyatv - v5.1.0-develop.1</title><meta name="description" content="Documentation for node-pyatv - v5.1.0-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.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NodePyATVRepeatState | node-pyatv - v5.1.0</title><meta name="description" content="Documentation for node-pyatv - v5.1.0"/><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.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
5
  <ul class="results">
6
6
  <li class="state loading">Preparing search index...</li>
7
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">node-pyatv - v5.1.0-develop.1</a></div>
7
+ <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">node-pyatv - v5.1.0</a></div>
8
8
  <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
9
  <div class="container container-main">
10
10
  <div class="col-8 col-content">
11
11
  <div class="tsd-page-title">
12
12
  <ul class="tsd-breadcrumb">
13
- <li><a href="../modules.html">node-pyatv - v5.1.0-develop.1</a></li>
13
+ <li><a href="../modules.html">node-pyatv - v5.1.0</a></li>
14
14
  <li><a href="NodePyATVRepeatState.html">NodePyATVRepeatState</a></li></ul>
15
- <h1>Enumeration NodePyATVRepeatState</h1></div>
15
+ <h1>Enumeration NodePyATVRepeatState</h1></div><aside class="tsd-sources">
16
+ <ul>
17
+ <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37b5e50/src/lib/types.ts#L32">src/lib/types.ts:32</a></li></ul></aside>
16
18
  <section class="tsd-panel-group tsd-index-group">
17
19
  <section class="tsd-panel tsd-index-panel">
18
20
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -30,17 +32,17 @@
30
32
  <h3 class="tsd-anchor-link"><span>all</span><a href="#all" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
31
33
  <div class="tsd-signature">all<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;all&quot;</span></div><aside class="tsd-sources">
32
34
  <ul>
33
- <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/e58764c/src/lib/types.ts#L33">src/lib/types.ts:33</a></li></ul></aside></section>
35
+ <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37b5e50/src/lib/types.ts#L33">src/lib/types.ts:33</a></li></ul></aside></section>
34
36
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="off" class="tsd-anchor"></a>
35
37
  <h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
36
38
  <div class="tsd-signature">off<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;off&quot;</span></div><aside class="tsd-sources">
37
39
  <ul>
38
- <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/e58764c/src/lib/types.ts#L35">src/lib/types.ts:35</a></li></ul></aside></section>
40
+ <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37b5e50/src/lib/types.ts#L35">src/lib/types.ts:35</a></li></ul></aside></section>
39
41
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="track" class="tsd-anchor"></a>
40
42
  <h3 class="tsd-anchor-link"><span>track</span><a href="#track" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
41
43
  <div class="tsd-signature">track<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;track&quot;</span></div><aside class="tsd-sources">
42
44
  <ul>
43
- <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/e58764c/src/lib/types.ts#L34">src/lib/types.ts:34</a></li></ul></aside></section></section></div>
45
+ <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37b5e50/src/lib/types.ts#L34">src/lib/types.ts:34</a></li></ul></aside></section></section></div>
44
46
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
45
47
  <div class="tsd-navigation settings">
46
48
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -58,7 +60,7 @@
58
60
  <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
59
61
  <div class="tsd-accordion-details">
60
62
  <ul>
61
- <li><a href="../modules.html">node-<wbr/>pyatv -<wbr/> v5.1.0-<wbr/>develop.1</a>
63
+ <li><a href="../modules.html">node-<wbr/>pyatv -<wbr/> v5.1.0</a>
62
64
  <ul></ul></li></ul></div></details></nav>
63
65
  <nav class="tsd-navigation secondary menu-sticky">
64
66
  <ul>
package/docs/reference/enums/NodePyATVShuffleState.html CHANGED
@@ -1,18 +1,20 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NodePyATVShuffleState | node-pyatv - v5.1.0-develop.1</title><meta name="description" content="Documentation for node-pyatv - v5.1.0-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.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NodePyATVShuffleState | node-pyatv - v5.1.0</title><meta name="description" content="Documentation for node-pyatv - v5.1.0"/><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.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
5
  <ul class="results">
6
6
  <li class="state loading">Preparing search index...</li>
7
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">node-pyatv - v5.1.0-develop.1</a></div>
7
+ <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">node-pyatv - v5.1.0</a></div>
8
8
  <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
9
  <div class="container container-main">
10
10
  <div class="col-8 col-content">
11
11
  <div class="tsd-page-title">
12
12
  <ul class="tsd-breadcrumb">
13
- <li><a href="../modules.html">node-pyatv - v5.1.0-develop.1</a></li>
13
+ <li><a href="../modules.html">node-pyatv - v5.1.0</a></li>
14
14
  <li><a href="NodePyATVShuffleState.html">NodePyATVShuffleState</a></li></ul>
15
- <h1>Enumeration NodePyATVShuffleState</h1></div>
15
+ <h1>Enumeration NodePyATVShuffleState</h1></div><aside class="tsd-sources">
16
+ <ul>
17
+ <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37b5e50/src/lib/types.ts#L38">src/lib/types.ts:38</a></li></ul></aside>
16
18
  <section class="tsd-panel-group tsd-index-group">
17
19
  <section class="tsd-panel tsd-index-panel">
18
20
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -30,17 +32,17 @@
30
32
  <h3 class="tsd-anchor-link"><span>albums</span><a href="#albums" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
31
33
  <div class="tsd-signature">albums<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;albums&quot;</span></div><aside class="tsd-sources">
32
34
  <ul>
33
- <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/e58764c/src/lib/types.ts#L39">src/lib/types.ts:39</a></li></ul></aside></section>
35
+ <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37b5e50/src/lib/types.ts#L39">src/lib/types.ts:39</a></li></ul></aside></section>
34
36
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="off" class="tsd-anchor"></a>
35
37
  <h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
36
38
  <div class="tsd-signature">off<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;off&quot;</span></div><aside class="tsd-sources">
37
39
  <ul>
38
- <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/e58764c/src/lib/types.ts#L41">src/lib/types.ts:41</a></li></ul></aside></section>
40
+ <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37b5e50/src/lib/types.ts#L41">src/lib/types.ts:41</a></li></ul></aside></section>
39
41
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="songs" class="tsd-anchor"></a>
40
42
  <h3 class="tsd-anchor-link"><span>songs</span><a href="#songs" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
41
43
  <div class="tsd-signature">songs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;songs&quot;</span></div><aside class="tsd-sources">
42
44
  <ul>
43
- <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/e58764c/src/lib/types.ts#L40">src/lib/types.ts:40</a></li></ul></aside></section></section></div>
45
+ <li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37b5e50/src/lib/types.ts#L40">src/lib/types.ts:40</a></li></ul></aside></section></section></div>
44
46
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
45
47
  <div class="tsd-navigation settings">
46
48
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -58,7 +60,7 @@
58
60
  <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
59
61
  <div class="tsd-accordion-details">
60
62
  <ul>
61
- <li><a href="../modules.html">node-<wbr/>pyatv -<wbr/> v5.1.0-<wbr/>develop.1</a>
63
+ <li><a href="../modules.html">node-<wbr/>pyatv -<wbr/> v5.1.0</a>
62
64
  <ul></ul></li></ul></div></details></nav>
63
65
  <nav class="tsd-navigation secondary menu-sticky">
64
66
  <ul>
package/docs/reference/index.html CHANGED
@@ -1,15 +1,15 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>node-pyatv - v5.1.0-develop.1</title><meta name="description" content="Documentation for node-pyatv - v5.1.0-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.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>node-pyatv - v5.1.0</title><meta name="description" content="Documentation for node-pyatv - v5.1.0"/><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.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base=".">
4
4
  <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
5
  <ul class="results">
6
6
  <li class="state loading">Preparing search index...</li>
7
- <li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">node-pyatv - v5.1.0-develop.1</a></div>
7
+ <li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">node-pyatv - v5.1.0</a></div>
8
8
  <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
9
  <div class="container container-main">
10
10
  <div class="col-8 col-content">
11
11
  <div class="tsd-page-title">
12
- <h2>node-pyatv - v5.1.0-develop.1</h2></div>
12
+ <h2>node-pyatv - v5.1.0</h2></div>
13
13
  <div class="tsd-panel tsd-typography">
14
14
  <a href="#node-pyatv" id="node-pyatv" style="color: inherit; text-decoration: none;">
15
15
  <h1>node-pyatv</h1>
@@ -36,8 +36,58 @@
36
36
  <p>Before you use <code>node-pyatv</code> you need to install pyatv. This module woun&#39;t do this for you. Run <code>atvremote --version</code> to
37
37
  double check your installation. See FAQ section for installation tips.</p>
38
38
  <p>To install the javascript module via npm just run:</p>
39
- <pre><code><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-0">install</span>
39
+ <pre><code><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-0">install</span><span class="hl-1"> @</span><span class="hl-0">sebbo2002</span><span class="hl-1">/</span><span class="hl-0">node</span><span class="hl-1">-</span><span class="hl-0">pyatv</span>
40
40
  </code></pre>
41
+
42
+ <a href="#⚒-quick-start" id="⚒-quick-start" style="color: inherit; text-decoration: none;">
43
+ <h2>⚒ Quick Start</h2>
44
+ </a>
45
+ <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-0">NodePyATVDeviceEvent</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@sebbo2002/node-pyatv&#39;</span><span class="hl-1">;</span><br/><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><span class="hl-7">/*{debug: true}*/</span><span class="hl-1">);</span><br/><span class="hl-2">if</span><span class="hl-1"> (!</span><span class="hl-0">devices</span><span class="hl-1">.</span><span class="hl-0">length</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">throw</span><span class="hl-1"> </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-8">Error</span><span class="hl-1">(</span><span class="hl-3">&#39;Oh no.&#39;</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">device</span><span class="hl-1"> = </span><span class="hl-0">devices</span><span class="hl-1">[</span><span class="hl-9">0</span><span class="hl-1">];</span><br/><br/><span class="hl-7">// request current title</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-2">await</span><span class="hl-1"> </span><span class="hl-0">device</span><span class="hl-1">.</span><span class="hl-6">getTitle</span><span class="hl-1">());</span><br/><br/><span class="hl-7">// request full state</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-2">await</span><span class="hl-1"> </span><span class="hl-0">device</span><span class="hl-1">.</span><span class="hl-6">getState</span><span class="hl-1">());</span><br/><br/><span class="hl-7">// subscribe to events</span><br/><span class="hl-0">device</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-3">&#39;update:deviceState&#39;</span><span class="hl-1">, (</span><span class="hl-0">event</span><span class="hl-1">: </span><span class="hl-8">NodePyATVDeviceEvent</span><span class="hl-1"> | </span><span class="hl-8">Error</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">if</span><span class="hl-1">(</span><span class="hl-0">event</span><span class="hl-1"> </span><span class="hl-4">instanceof</span><span class="hl-1"> </span><span class="hl-8">Error</span><span class="hl-1">) </span><span class="hl-2">return</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><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-3">`Current device state is </span><span class="hl-4">${</span><span class="hl-0">event</span><span class="hl-10">.</span><span class="hl-0">value</span><span class="hl-4">}</span><span class="hl-3">`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
46
+ </code></pre>
47
+
48
+ <a href="#📑-api-reference" id="📑-api-reference" style="color: inherit; text-decoration: none;">
49
+ <h2>📑 API Reference</h2>
50
+ </a>
51
+ <p>The API documentation is automatically generated from the code comments and can be found
52
+ <a href="https://sebbo2002.github.io/node-pyatv/main/reference/classes/default.html">here</a>.</p>
53
+
54
+ <a href="#📑-changelog" id="📑-changelog" style="color: inherit; text-decoration: none;">
55
+ <h2>📑 Changelog</h2>
56
+ </a>
57
+ <p>Please have a look at <a href="https://github.com/sebbo2002/node-pyatv/blob/main/CHANGELOG.md">CHANGELOG.md</a> to see the changelog.</p>
58
+
59
+ <a href="#🤨-faq" id="🤨-faq" style="color: inherit; text-decoration: none;">
60
+ <h2>🤨 FAQ</h2>
61
+ </a>
62
+
63
+ <a href="#how-to-install-pyatv" id="how-to-install-pyatv" style="color: inherit; text-decoration: none;">
64
+ <h4>How to install pyatv</h4>
65
+ </a>
66
+ <pre><code class="language-bash"><span class="hl-1">pip3 install pyatv</span>
67
+ </code></pre>
68
+
69
+ <a href="#how-to-debug-things" id="how-to-debug-things" style="color: inherit; text-decoration: none;">
70
+ <h4>How to debug things</h4>
71
+ </a>
72
+ <p>You can pass <code>&quot;debug&quot;: true</code> for any command called. Some debug information is then printed via console.log. Additionaly
73
+ you can pass a function to process debugs logs.</p>
74
+
75
+ <a href="#why-are-some-tests-skipped" id="why-are-some-tests-skipped" style="color: inherit; text-decoration: none;">
76
+ <h4>Why are some tests skipped?</h4>
77
+ </a>
78
+ <p>Some unit tests require a responding apple tv to pass. These tests are disabled by default. You can set the environment
79
+ variable <code>ENABLE_INTEGRATION=1</code> to enable them.</p>
80
+
81
+ <a href="#is-this-secure" id="is-this-secure" style="color: inherit; text-decoration: none;">
82
+ <h4>Is this secure?</h4>
83
+ </a>
84
+ <p>Defenitely not. For example, there&#39;s no escaping for parameters passed to pyatv. So be sure to double check the data you
85
+ pass to this library, otherwise it may be possible to run code on your machine.</p>
86
+
87
+ <a href="#copyright-and-license" id="copyright-and-license" style="color: inherit; text-decoration: none;">
88
+ <h2>Copyright and license</h2>
89
+ </a>
90
+ <p>Copyright (c) Sebastian Pekarek under the <a href="LICENSE">MIT license</a>.</p>
41
91
  </div></div>
42
92
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
43
93
  <div class="tsd-navigation settings">
@@ -56,7 +106,7 @@ double check your installation. See FAQ section for installation tips.</p>
56
106
  <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
57
107
  <div class="tsd-accordion-details">
58
108
  <ul>
59
- <li class="current selected"><a href="modules.html">node-<wbr/>pyatv -<wbr/> v5.1.0-<wbr/>develop.1</a>
109
+ <li class="current selected"><a href="modules.html">node-<wbr/>pyatv -<wbr/> v5.1.0</a>
60
110
  <ul></ul></li></ul></div></details></nav>
61
111
  <nav class="tsd-navigation secondary menu-sticky">
62
112
  <ul>