@sebbo2002/node-pyatv 4.1.1-develop.1 → 4.2.1-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.
Files changed (68) hide show
  1. package/CHANGELOG.md +29 -0
  2. package/dist/lib/device-event.d.ts +1 -1
  3. package/dist/lib/device-events.d.ts +1 -2
  4. package/dist/lib/device-events.js +9 -7
  5. package/dist/lib/device-events.js.map +1 -1
  6. package/dist/lib/device.d.ts +1 -1
  7. package/dist/lib/device.js +12 -11
  8. package/dist/lib/device.js.map +1 -1
  9. package/dist/lib/index.d.ts +3 -1
  10. package/dist/lib/index.js +7 -1
  11. package/dist/lib/index.js.map +1 -1
  12. package/dist/lib/instance.d.ts +1 -1
  13. package/dist/lib/instance.js +2 -2
  14. package/dist/lib/instance.js.map +1 -1
  15. package/dist/lib/tools.js +7 -0
  16. package/dist/lib/tools.js.map +1 -1
  17. package/dist/lib/types.d.ts +1 -0
  18. package/docs/coverage/cobertura-coverage.xml +665 -633
  19. package/docs/coverage/device-event.ts.html +2 -2
  20. package/docs/coverage/device-events.ts.html +99 -87
  21. package/docs/coverage/device.ts.html +38 -26
  22. package/docs/coverage/fake-spawn.ts.html +25 -25
  23. package/docs/coverage/index.html +29 -29
  24. package/docs/coverage/index.ts.html +22 -7
  25. package/docs/coverage/instance.ts.html +2 -2
  26. package/docs/coverage/tools.ts.html +133 -109
  27. package/docs/coverage/types.ts.html +5 -2
  28. package/docs/reference/assets/main.js +1 -1
  29. package/docs/reference/assets/search.js +1 -1
  30. package/docs/reference/assets/style.css +4 -0
  31. package/docs/reference/classes/NodePyATVDevice.html +147 -0
  32. package/docs/reference/classes/NodePyATVDeviceEvent.html +6 -6
  33. package/docs/reference/classes/default.html +15 -15
  34. package/docs/reference/enums/NodePyATVDeviceState.html +1 -1
  35. package/docs/reference/enums/NodePyATVKeys.html +1 -1
  36. package/docs/reference/enums/NodePyATVListenerState.html +1 -0
  37. package/docs/reference/enums/NodePyATVMediaType.html +1 -1
  38. package/docs/reference/enums/NodePyATVPowerState.html +1 -0
  39. package/docs/reference/enums/NodePyATVProtocol.html +1 -1
  40. package/docs/reference/enums/NodePyATVRepeatState.html +1 -1
  41. package/docs/reference/enums/NodePyATVShuffleState.html +1 -1
  42. package/docs/reference/index.html +2 -2
  43. package/docs/reference/interfaces/NodePyATVDeviceOptions.html +1 -1
  44. package/docs/reference/interfaces/NodePyATVFindAndInstanceOptions.html +1 -1
  45. package/docs/reference/interfaces/NodePyATVFindOptions.html +1 -1
  46. package/docs/reference/interfaces/NodePyATVGetStateOptions.html +1 -1
  47. package/docs/reference/interfaces/NodePyATVInstanceOptions.html +1 -1
  48. package/docs/reference/interfaces/NodePyATVState.html +1 -1
  49. package/docs/reference/interfaces/NodePyATVVersionResponse.html +1 -1
  50. package/docs/reference/modules.html +1 -1
  51. package/docs/tests/assets/app.css +1 -1
  52. package/docs/tests/assets/app.js +2 -2
  53. package/docs/tests/assets/app.js.LICENSE.txt +1 -1
  54. package/docs/tests/index.html +1 -1
  55. package/docs/tests/mochawesome.json +700 -605
  56. package/package.json +17 -17
  57. package/src/lib/device-event.ts +1 -1
  58. package/src/lib/device-events.ts +8 -4
  59. package/src/lib/device.ts +12 -8
  60. package/src/lib/index.ts +6 -1
  61. package/src/lib/instance.ts +1 -1
  62. package/src/lib/tools.ts +8 -0
  63. package/src/lib/types.ts +1 -0
  64. package/test/device-events.ts +24 -3
  65. package/test/device.ts +18 -0
  66. package/test/instance.ts +9 -1
  67. package/test/tools.ts +15 -4
  68. package/typedoc.json +1 -1
package/docs/reference/classes/NodePyATVDevice.html ADDED
@@ -0,0 +1,147 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NodePyATVDevice | node-pyatv - v4.2.1-develop.1</title><meta name="description" content="Documentation for node-pyatv - v4.2.1-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.2.1-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.2.1-develop.1</a></li><li><a href="NodePyATVDevice.html">NodePyATVDevice</a></li></ul><h1>Class NodePyATVDevice</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
+ <p>Represents an Apple TV. Use <a href="NodePyATVDevice.html#getState">getState</a> to query the current state (e.g. media
3
+ type and title). You can also use the attribute methods (e.g. <a href="NodePyATVDevice.html#getTitle">getTitle</a> to get
4
+ the state. If you want realtime updates, subscribe to it&#39;s events with an
5
+ <code>EventEmitter</code> like API, so for example by using <a href="NodePyATVDevice.html#on">on</a>, <a href="NodePyATVDevice.html#once">once</a> or <a href="NodePyATVDevice.html#addListener">addListener</a>.
6
+ It&#39;s also possible to send key commands by using <a href="NodePyATVDevice.html#pressKey">pressKey</a> or methods like <a href="NodePyATVDevice.html#pause">pause</a>.</p>
7
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">NodePyATVDevice</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">EventEmitter</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="NodePyATVDevice.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="NodePyATVDevice.html#debug" class="tsd-kind-icon">debug</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDevice.html#host" class="tsd-kind-icon">host</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDevice.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDevice.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDevice.html#protocol" class="tsd-kind-icon">protocol</a></li></ul></section><section class="tsd-index-section "><section class="tsd-index-section"><h3>Methods Basic</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#toJSON" class="tsd-kind-icon">toJSON</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li></ul></section><section class="tsd-index-section"><h3>Methods Control</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#down" class="tsd-kind-icon">down</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#home" class="tsd-kind-icon">home</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#homeHold" class="tsd-kind-icon">home<wbr/>Hold</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#left" class="tsd-kind-icon">left</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#menu" class="tsd-kind-icon">menu</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#next" class="tsd-kind-icon">next</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#pause" class="tsd-kind-icon">pause</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#play" class="tsd-kind-icon">play</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#playPause" class="tsd-kind-icon">play<wbr/>Pause</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#pressKey" class="tsd-kind-icon">press<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#previous" class="tsd-kind-icon">previous</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#right" class="tsd-kind-icon">right</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#select" class="tsd-kind-icon">select</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#skipBackward" class="tsd-kind-icon">skip<wbr/>Backward</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#skipForward" class="tsd-kind-icon">skip<wbr/>Forward</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#stop" class="tsd-kind-icon">stop</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#suspend" class="tsd-kind-icon">suspend</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#topMenu" class="tsd-kind-icon">top<wbr/>Menu</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#up" class="tsd-kind-icon">up</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#volumeDown" class="tsd-kind-icon">volume<wbr/>Down</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#volumeUp" class="tsd-kind-icon">volume<wbr/>Up</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#wakeup" class="tsd-kind-icon">wakeup</a></li></ul></section><section class="tsd-index-section"><h3>Methods Event</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#addListener" class="tsd-kind-icon">add<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#eventNames" class="tsd-kind-icon">event<wbr/>Names</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getMaxListeners" class="tsd-kind-icon">get<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#listenerCount" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#listeners" class="tsd-kind-icon">listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#once" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#prependListener" class="tsd-kind-icon">prepend<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#prependOnceListener" class="tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#rawListeners" class="tsd-kind-icon">raw<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#removeAllListeners" class="tsd-kind-icon">remove<wbr/>All<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#removeListener" class="tsd-kind-icon">remove<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#setMaxListeners" class="tsd-kind-icon">set<wbr/>Max<wbr/>Listeners</a></li></ul></section><section class="tsd-index-section"><h3>Methods State</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#clearState" class="tsd-kind-icon">clear<wbr/>State</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getAlbum" class="tsd-kind-icon">get<wbr/>Album</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getApp" class="tsd-kind-icon">get<wbr/>App</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getAppId" class="tsd-kind-icon">get<wbr/>App<wbr/>Id</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getArtist" class="tsd-kind-icon">get<wbr/>Artist</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getDateTime" class="tsd-kind-icon">get<wbr/>Date<wbr/>Time</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getDeviceState" class="tsd-kind-icon">get<wbr/>Device<wbr/>State</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getGenre" class="tsd-kind-icon">get<wbr/>Genre</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getHash" class="tsd-kind-icon">get<wbr/>Hash</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getMediaType" class="tsd-kind-icon">get<wbr/>Media<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getPosition" class="tsd-kind-icon">get<wbr/>Position</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getRepeat" class="tsd-kind-icon">get<wbr/>Repeat</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getShuffle" class="tsd-kind-icon">get<wbr/>Shuffle</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getState" class="tsd-kind-icon">get<wbr/>State</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getTitle" class="tsd-kind-icon">get<wbr/>Title</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getTotalTime" class="tsd-kind-icon">get<wbr/>Total<wbr/>Time</a></li></ul></section></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>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Node<wbr/>PyATVDevice<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/5758afd/src/lib/device.ts#L32">src/lib/device.ts:32</a></li></ul></aside><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></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><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="debug" class="tsd-anchor"></a><h3>debug</h3><ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> debug<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>msg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></li><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> debug<span class="tsd-signature-symbol">(</span>debug<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>msg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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/5758afd/src/lib/device.ts#L81">src/lib/device.ts:81</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
8
+ <p>Returns true, if debugging is enabled. Returns the custom
9
+ logging method, if one was specified. Otherwise, if debug
10
+ log is disabled, returns undefined.</p>
11
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>msg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/5758afd/src/lib/device.ts#L91">src/lib/device.ts:91</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
12
+ <p>Enable or disable debugging or set a custom
13
+ debugging method to use.</p>
14
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>debug: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>msg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
15
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="host" class="tsd-anchor"></a><h3>host</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> host<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/5758afd/src/lib/device.ts#L58">src/lib/device.ts:58</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
16
+ <p>Get the IP address of the Apple TV.</p>
17
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="id" class="tsd-anchor"></a><h3>id</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> id<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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/5758afd/src/lib/device.ts#L65">src/lib/device.ts:65</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
18
+ <p>Get the ID of the Apple TV.</p>
19
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a><h3>name</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> name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/5758afd/src/lib/device.ts#L51">src/lib/device.ts:51</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
20
+ <p>Get the name of the Apple TV.</p>
21
+ </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">&#39;@sebbo2002/node-pyatv&#39;</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">devices</span><span class="hl-1">.</span><span class="hl-6">forEach</span><span class="hl-1">(</span><span class="hl-0">device</span><span class="hl-1"> </span><span class="hl-4">=&gt;</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-0">device</span><span class="hl-1">.</span><span class="hl-0">name</span><span class="hl-1">)</span><br/><span class="hl-1">);</span>
22
+ </code></pre>
23
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="protocol" class="tsd-anchor"></a><h3>protocol</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> protocol<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/NodePyATVProtocol.html" class="tsd-signature-type" data-tsd-kind="Enumeration">NodePyATVProtocol</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/5758afd/src/lib/device.ts#L72">src/lib/device.ts:72</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
24
+ <p>Get the used protocol to connect to the Apple TV.</p>
25
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/NodePyATVProtocol.html" class="tsd-signature-type" data-tsd-kind="Enumeration">NodePyATVProtocol</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Basic Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toJSON" class="tsd-anchor"></a><h3>toJSON</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">toJSON<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/NodePyATVProtocol.html" class="tsd-signature-type" data-tsd-kind="Enumeration">NodePyATVProtocol</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/5758afd/src/lib/device.ts#L106">src/lib/device.ts:106</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
26
+ <p>Returns an object with <code>name</code>, <code>host</code>, <code>id</code> and <code>protocol</code>.
27
+ Can be used to initiate a new device instance.</p>
28
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/NodePyATVProtocol.html" class="tsd-signature-type" data-tsd-kind="Enumeration">NodePyATVProtocol</a><span class="tsd-signature-symbol"> }</span></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/NodePyATVProtocol.html" class="tsd-signature-type" data-tsd-kind="Enumeration">NodePyATVProtocol</a></h5></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/5758afd/src/lib/device.ts#L120">src/lib/device.ts:120</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
29
+ <p>Returns a string. Just for debugging, etc.</p>
30
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Control Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="down" class="tsd-anchor"></a><h3>down</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">down<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L362">src/lib/device.ts:362</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
31
+ <p>Send the &quot;down&quot; command</p>
32
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="home" class="tsd-anchor"></a><h3>home</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">home<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L370">src/lib/device.ts:370</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
33
+ <p>Send the &quot;home&quot; command</p>
34
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="homeHold" class="tsd-anchor"></a><h3>home<wbr/>Hold</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">home<wbr/>Hold<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L378">src/lib/device.ts:378</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
35
+ <p>Send the &quot;homeHold&quot; command</p>
36
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="left" class="tsd-anchor"></a><h3>left</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">left<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L386">src/lib/device.ts:386</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
37
+ <p>Send the &quot;left&quot; command</p>
38
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="menu" class="tsd-anchor"></a><h3>menu</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">menu<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L394">src/lib/device.ts:394</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
39
+ <p>Send the &quot;menu&quot; command</p>
40
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="next" class="tsd-anchor"></a><h3>next</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">next<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L402">src/lib/device.ts:402</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
41
+ <p>Send the &quot;next&quot; command</p>
42
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="pause" class="tsd-anchor"></a><h3>pause</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">pause<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L410">src/lib/device.ts:410</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
43
+ <p>Send the &quot;pause&quot; command</p>
44
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="play" class="tsd-anchor"></a><h3>play</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">play<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L418">src/lib/device.ts:418</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
45
+ <p>Send the &quot;play&quot; command</p>
46
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="playPause" class="tsd-anchor"></a><h3>play<wbr/>Pause</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">play<wbr/>Pause<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L426">src/lib/device.ts:426</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
47
+ <p>Send the &quot;playPause&quot; command</p>
48
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="pressKey" class="tsd-anchor"></a><h3>press<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">press<wbr/>Key<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><a href="../enums/NodePyATVKeys.html" class="tsd-signature-type" data-tsd-kind="Enumeration">NodePyATVKeys</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L346">src/lib/device.ts:346</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
49
+ <p>Send a key press to the Apple TV</p>
50
+ </div><div><pre><code class="language-typescript"><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">pressKey</span><span class="hl-1">(</span><span class="hl-0">NodePyATVKeys</span><span class="hl-1">.</span><span class="hl-0">home</span><span class="hl-1">);</span>
51
+ </code></pre>
52
+ <br />
53
+
54
+ <pre><code class="language-javascript"><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">pressKey</span><span class="hl-1">(</span><span class="hl-3">&#39;home&#39;</span><span class="hl-1">);</span>
55
+ </code></pre>
56
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <a href="../enums/NodePyATVKeys.html" class="tsd-signature-type" data-tsd-kind="Enumeration">NodePyATVKeys</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="previous" class="tsd-anchor"></a><h3>previous</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">previous<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L434">src/lib/device.ts:434</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
57
+ <p>Send the &quot;previous&quot; command</p>
58
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="right" class="tsd-anchor"></a><h3>right</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">right<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L442">src/lib/device.ts:442</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
59
+ <p>Send the &quot;right&quot; command</p>
60
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="select" class="tsd-anchor"></a><h3>select</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">select<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L450">src/lib/device.ts:450</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
61
+ <p>Send the &quot;select&quot; command</p>
62
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="skipBackward" class="tsd-anchor"></a><h3>skip<wbr/>Backward</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">skip<wbr/>Backward<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L458">src/lib/device.ts:458</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
63
+ <p>Send the &quot;skipBackward&quot; command</p>
64
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="skipForward" class="tsd-anchor"></a><h3>skip<wbr/>Forward</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">skip<wbr/>Forward<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L466">src/lib/device.ts:466</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
65
+ <p>Send the &quot;skipForward&quot; command</p>
66
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="stop" class="tsd-anchor"></a><h3>stop</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">stop<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L474">src/lib/device.ts:474</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
67
+ <p>Send the &quot;stop&quot; command</p>
68
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="suspend" class="tsd-anchor"></a><h3>suspend</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">suspend<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L482">src/lib/device.ts:482</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
69
+ <p>Send the &quot;suspend&quot; command</p>
70
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="topMenu" class="tsd-anchor"></a><h3>top<wbr/>Menu</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">top<wbr/>Menu<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L490">src/lib/device.ts:490</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
71
+ <p>Send the &quot;topMenu&quot; command</p>
72
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="up" class="tsd-anchor"></a><h3>up</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">up<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L498">src/lib/device.ts:498</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
73
+ <p>Send the &quot;up&quot; command</p>
74
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="volumeDown" class="tsd-anchor"></a><h3>volume<wbr/>Down</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">volume<wbr/>Down<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L506">src/lib/device.ts:506</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
75
+ <p>Send the &quot;volumeDown&quot; command</p>
76
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="volumeUp" class="tsd-anchor"></a><h3>volume<wbr/>Up</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">volume<wbr/>Up<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L514">src/lib/device.ts:514</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
77
+ <p>Send the &quot;volumeUp&quot; command</p>
78
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="wakeup" class="tsd-anchor"></a><h3>wakeup</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">wakeup<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L522">src/lib/device.ts:522</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
79
+ <p>Send the &quot;wakeup&quot; command</p>
80
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Event Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addListener" class="tsd-anchor"></a><h3>add<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</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"><p>Implementation of EventEmitter.addListener</p><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/5758afd/src/lib/device.ts#L533">src/lib/device.ts:533</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
81
+ <p>Add an event listener. Will start the event subscription with the
82
+ Apple TV as long as there are listeners for any event registered.</p>
83
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></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="emit" class="tsd-anchor"></a><h3>emit</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, payload<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of EventEmitter.emit</p><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/5758afd/src/lib/device.ts#L544">src/lib/device.ts:544</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
84
+ <p>Emit an event.</p>
85
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>payload: <a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="eventNames" class="tsd-anchor"></a><h3>event<wbr/>Names</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">event<wbr/>Names<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><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"><p>Implementation of EventEmitter.eventNames</p><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/5758afd/src/lib/device.ts#L552">src/lib/device.ts:552</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
86
+ <p>Get all event names which are currently known.</p>
87
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><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="getMaxListeners" class="tsd-anchor"></a><h3>get<wbr/>Max<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Max<wbr/>Listeners<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of EventEmitter.getMaxListeners</p><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/5758afd/src/lib/device.ts#L560">src/lib/device.ts:560</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
88
+ <p>Get max number of listeners allowed</p>
89
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="listenerCount" class="tsd-anchor"></a><h3>listener<wbr/>Count</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">listener<wbr/>Count<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of EventEmitter.listenerCount</p><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/5758afd/src/lib/device.ts#L569">src/lib/device.ts:569</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
90
+ <p>Get number of listeners for event</p>
91
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="listeners" class="tsd-anchor"></a><h3>listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">listeners<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of EventEmitter.listeners</p><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/5758afd/src/lib/device.ts#L581">src/lib/device.ts:581</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
92
+ <p>Get listeners for event. Will also return
93
+ node-pyatv wrappers (e.g. once)</p>
94
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</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="off" class="tsd-anchor"></a><h3>off</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">off<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</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"><p>Implementation of EventEmitter.off</p><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/5758afd/src/lib/device.ts#L592">src/lib/device.ts:592</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
95
+ <p>Remove an event listener. Will stop the event subscription with the
96
+ Apple TV if this was the last event listener.</p>
97
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></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="on" class="tsd-anchor"></a><h3>on</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</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"><p>Implementation of EventEmitter.on</p><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/5758afd/src/lib/device.ts#L604">src/lib/device.ts:604</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
98
+ <p>Add an event listener. Will start the event subscription with the
99
+ Apple TV as long as there are listeners for any event registered.</p>
100
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></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="once" class="tsd-anchor"></a><h3>once</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</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"><p>Implementation of EventEmitter.once</p><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/5758afd/src/lib/device.ts#L617">src/lib/device.ts:617</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
101
+ <p>Add an event listener. Will start the event subscription with the
102
+ Apple TV as long as there are listeners for any event registered.
103
+ Removes the listener automatically after the first occurrence.</p>
104
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></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="prependListener" class="tsd-anchor"></a><h3>prepend<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</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"><p>Implementation of EventEmitter.prependListener</p><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/5758afd/src/lib/device.ts#L627">src/lib/device.ts:627</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></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="prependOnceListener" class="tsd-anchor"></a><h3>prepend<wbr/>Once<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</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"><p>Implementation of EventEmitter.prependOnceListener</p><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/5758afd/src/lib/device.ts#L637">src/lib/device.ts:637</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></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="rawListeners" class="tsd-anchor"></a><h3>raw<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">raw<wbr/>Listeners<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of EventEmitter.rawListeners</p><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/5758afd/src/lib/device.ts#L647">src/lib/device.ts:647</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</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="removeAllListeners" class="tsd-anchor"></a><h3>remove<wbr/>All<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">remove<wbr/>All<wbr/>Listeners<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">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"><p>Implementation of EventEmitter.removeAllListeners</p><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/5758afd/src/lib/device.ts#L659">src/lib/device.ts:659</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
105
+ <p>Removes all listeners, either for the given event or
106
+ for every event. Will stop the event subscription with
107
+ the Apple TV if this was the last event listener.</p>
108
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></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="removeListener" class="tsd-anchor"></a><h3>remove<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">remove<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</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"><p>Implementation of EventEmitter.removeListener</p><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/5758afd/src/lib/device.ts#L671">src/lib/device.ts:671</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
109
+ <p>Remove an event listener. Will stop the event subscription with the
110
+ Apple TV if this was the last event listener.</p>
111
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <a href="NodePyATVDeviceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDeviceEvent</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></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="setMaxListeners" class="tsd-anchor"></a><h3>set<wbr/>Max<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Max<wbr/>Listeners<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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"><p>Implementation of EventEmitter.setMaxListeners</p><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/5758afd/src/lib/device.ts#L680">src/lib/device.ts:680</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>n: <span class="tsd-signature-type">number</span></h5></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><section class="tsd-panel-group tsd-member-group "><h2>State Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="clearState" class="tsd-anchor"></a><h3>clear<wbr/>State</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">clear<wbr/>State<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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/5758afd/src/lib/device.ts#L170">src/lib/device.ts:170</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
112
+ <p>Removes the state node-pyatv cached for this device.</p>
113
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAlbum" class="tsd-anchor"></a><h3>get<wbr/>Album</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Album<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</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">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L243">src/lib/device.ts:243</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
114
+ <p>Returns the album of the current playing media</p>
115
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getApp" class="tsd-anchor"></a><h3>get<wbr/>App</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>App<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</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">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L303">src/lib/device.ts:303</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
116
+ <p>Returns the currently used app</p>
117
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAppId" class="tsd-anchor"></a><h3>get<wbr/>App<wbr/>Id</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>App<wbr/>Id<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</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">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L313">src/lib/device.ts:313</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
118
+ <p>Returns the id of the currently used app</p>
119
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getArtist" class="tsd-anchor"></a><h3>get<wbr/>Artist</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Artist<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</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">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L233">src/lib/device.ts:233</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
120
+ <p>Returns the artist of the current playing media</p>
121
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getDateTime" class="tsd-anchor"></a><h3>get<wbr/>Date<wbr/>Time</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Date<wbr/>Time<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</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">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L183">src/lib/device.ts:183</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
122
+ <p>Get the date and time when the state was last updated.</p>
123
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getDeviceState" class="tsd-anchor"></a><h3>get<wbr/>Device<wbr/>State</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Device<wbr/>State<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</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">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/NodePyATVDeviceState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">NodePyATVDeviceState</a><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L213">src/lib/device.ts:213</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
124
+ <p>Get the state of this device (e.g. playing, etc.)</p>
125
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/NodePyATVDeviceState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">NodePyATVDeviceState</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getGenre" class="tsd-anchor"></a><h3>get<wbr/>Genre</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Genre<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</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">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L253">src/lib/device.ts:253</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
126
+ <p>Returns the genre of the current playing media</p>
127
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getHash" class="tsd-anchor"></a><h3>get<wbr/>Hash</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Hash<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</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">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L193">src/lib/device.ts:193</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
128
+ <p>Get the hash of the current media</p>
129
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getMediaType" class="tsd-anchor"></a><h3>get<wbr/>Media<wbr/>Type</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Media<wbr/>Type<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</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">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/NodePyATVMediaType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">NodePyATVMediaType</a><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L203">src/lib/device.ts:203</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
130
+ <p>Get the media type of the current media</p>
131
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/NodePyATVMediaType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">NodePyATVMediaType</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getPosition" class="tsd-anchor"></a><h3>get<wbr/>Position</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Position<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</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">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L273">src/lib/device.ts:273</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
132
+ <p>Returns the title of the current playing media</p>
133
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getRepeat" class="tsd-anchor"></a><h3>get<wbr/>Repeat</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Repeat<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</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">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/NodePyATVRepeatState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">NodePyATVRepeatState</a><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L293">src/lib/device.ts:293</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
134
+ <p>Returns the repeat state</p>
135
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/NodePyATVRepeatState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">NodePyATVRepeatState</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getShuffle" class="tsd-anchor"></a><h3>get<wbr/>Shuffle</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Shuffle<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</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">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/NodePyATVShuffleState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">NodePyATVShuffleState</a><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L283">src/lib/device.ts:283</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
136
+ <p>Returns the shuffle state</p>
137
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/NodePyATVShuffleState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">NodePyATVShuffleState</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getState" class="tsd-anchor"></a><h3>get<wbr/>State</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>State<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</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">&lt;</span><a href="../interfaces/NodePyATVState.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVState</a><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L136">src/lib/device.ts:136</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
138
+ <p>Returns an <a href="../interfaces/NodePyATVState.html">NodePyATVState</a> object representing the current state
139
+ of the device. Has an internal cache, which has a default TTL of 5s.
140
+ You can change this default value by passing the <code>maxAge</code> option.</p>
141
+ </div><div><pre><code class="language-typescript"><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><span class="hl-0">maxAge:</span><span class="hl-1"> </span><span class="hl-9">10000</span><span class="hl-1">}); </span><span class="hl-7">// cache TTL: 10s</span>
142
+ </code></pre>
143
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/NodePyATVState.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVState</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getTitle" class="tsd-anchor"></a><h3>get<wbr/>Title</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Title<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</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">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L223">src/lib/device.ts:223</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
144
+ <p>Returns the title of the current playing media</p>
145
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getTotalTime" class="tsd-anchor"></a><h3>get<wbr/>Total<wbr/>Time</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Total<wbr/>Time<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</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">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</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/5758afd/src/lib/device.ts#L263">src/lib/device.ts:263</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
146
+ <p>Returns the media length of the current playing media</p>
147
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVGetStateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVGetStateOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></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="NodePyATVDevice.html" class="tsd-kind-icon">Node<wbr/>PyATVDevice</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="NodePyATVDevice.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="NodePyATVDevice.html#debug" class="tsd-kind-icon">debug</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDevice.html#host" class="tsd-kind-icon">host</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDevice.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDevice.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="NodePyATVDevice.html#protocol" class="tsd-kind-icon">protocol</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#addListener" class="tsd-kind-icon">add<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#clearState" class="tsd-kind-icon">clear<wbr/>State</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#down" class="tsd-kind-icon">down</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#eventNames" class="tsd-kind-icon">event<wbr/>Names</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getAlbum" class="tsd-kind-icon">get<wbr/>Album</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getApp" class="tsd-kind-icon">get<wbr/>App</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getAppId" class="tsd-kind-icon">get<wbr/>App<wbr/>Id</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getArtist" class="tsd-kind-icon">get<wbr/>Artist</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getDateTime" class="tsd-kind-icon">get<wbr/>Date<wbr/>Time</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getDeviceState" class="tsd-kind-icon">get<wbr/>Device<wbr/>State</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getGenre" class="tsd-kind-icon">get<wbr/>Genre</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getHash" class="tsd-kind-icon">get<wbr/>Hash</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getMaxListeners" class="tsd-kind-icon">get<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getMediaType" class="tsd-kind-icon">get<wbr/>Media<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getPosition" class="tsd-kind-icon">get<wbr/>Position</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getRepeat" class="tsd-kind-icon">get<wbr/>Repeat</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getShuffle" class="tsd-kind-icon">get<wbr/>Shuffle</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getState" class="tsd-kind-icon">get<wbr/>State</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getTitle" class="tsd-kind-icon">get<wbr/>Title</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#getTotalTime" class="tsd-kind-icon">get<wbr/>Total<wbr/>Time</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#home" class="tsd-kind-icon">home</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#homeHold" class="tsd-kind-icon">home<wbr/>Hold</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#left" class="tsd-kind-icon">left</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#listenerCount" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#listeners" class="tsd-kind-icon">listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#menu" class="tsd-kind-icon">menu</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#next" class="tsd-kind-icon">next</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#once" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#pause" class="tsd-kind-icon">pause</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#play" class="tsd-kind-icon">play</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#playPause" class="tsd-kind-icon">play<wbr/>Pause</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#prependListener" class="tsd-kind-icon">prepend<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#prependOnceListener" class="tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#pressKey" class="tsd-kind-icon">press<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#previous" class="tsd-kind-icon">previous</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#rawListeners" class="tsd-kind-icon">raw<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#removeAllListeners" class="tsd-kind-icon">remove<wbr/>All<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#removeListener" class="tsd-kind-icon">remove<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#right" class="tsd-kind-icon">right</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#select" class="tsd-kind-icon">select</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#setMaxListeners" class="tsd-kind-icon">set<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#skipBackward" class="tsd-kind-icon">skip<wbr/>Backward</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#skipForward" class="tsd-kind-icon">skip<wbr/>Forward</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#stop" class="tsd-kind-icon">stop</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#suspend" class="tsd-kind-icon">suspend</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#toJSON" class="tsd-kind-icon">toJSON</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#topMenu" class="tsd-kind-icon">top<wbr/>Menu</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#up" class="tsd-kind-icon">up</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#volumeDown" class="tsd-kind-icon">volume<wbr/>Down</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#volumeUp" class="tsd-kind-icon">volume<wbr/>Up</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="NodePyATVDevice.html#wakeup" class="tsd-kind-icon">wakeup</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>