@octalmage/node-appletv

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>"lib/util/tlv" | node-appletv</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </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-appletv</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-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a> </li> <li> <a href="_lib_util_tlv_.html">"lib/util/tlv"</a> </li> </ul> <h1>External module "lib/util/tlv"</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section tsd-is-not-exported"> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_lib_util_tlv_.html#decode" class="tsd-kind-icon">decode</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_lib_util_tlv_.html#encode" class="tsd-kind-icon">encode</a></li> </ul> </section> <section class="tsd-index-section tsd-is-not-exported"> <h3>Object literals</h3> <ul class="tsd-index-list"> <li class="tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported"><a href="_lib_util_tlv_.html#tag" class="tsd-kind-icon">Tag</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a name="decode" class="tsd-anchor"></a> <h3>decode</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">decode<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">__type</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/util/tlv.ts#L79">lib/util/tlv.ts:79</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>data: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">__type</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a name="encode" class="tsd-anchor"></a> <h3>encode</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">encode<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/util/tlv.ts#L34">lib/util/tlv.ts:34</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>type: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>data: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> <h2>Object literals</h2> <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported"> <a name="tag" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Tag</h3> <div class="tsd-signature tsd-kind-icon">Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/util/tlv.ts#L16">lib/util/tlv.ts:16</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Type Length Value encoding/decoding, used by HAP as a wire format. <a href="https://en.wikipedia.org/wiki/Type-length-value">https://en.wikipedia.org/wiki/Type-length-value</a></p> </div> <p>Originally based on code from github:KhaosT/HAP-NodeJS@0c8fd88 used used per the terms of the Apache Software License v2.</p> <p>Original code copyright Khaos Tian <a href="mailto:khaos.tian@gmail.com">khaos.tian@gmail.com</a></p> <p>Modifications copyright Zach Bean <a href="mailto:zb@forty2.com">zb@forty2.com</a></p> <ul> <li>Reformatted for ES6-style module</li> <li>Rewrote encode() to be non-recursive; also simplified the logic</li> <li>Rewrote decode()</li> </ul> </div> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="tag.backoff" class="tsd-anchor"></a> <h3>Back<wbr>Off</h3> <div class="tsd-signature tsd-kind-icon">Back<wbr>Off<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 8</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/util/tlv.ts#L27">lib/util/tlv.ts:27</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="tag.encrypteddata" class="tsd-anchor"></a> <h3>Encrypted<wbr>Data</h3> <div class="tsd-signature tsd-kind-icon">Encrypted<wbr>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 5</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/util/tlv.ts#L24">lib/util/tlv.ts:24</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="tag.errorcode" class="tsd-anchor"></a> <h3>Error<wbr>Code</h3> <div class="tsd-signature tsd-kind-icon">Error<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 7</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/util/tlv.ts#L26">lib/util/tlv.ts:26</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="tag.mficertificate" class="tsd-anchor"></a> <h3>MFi<wbr>Certificate</h3> <div class="tsd-signature tsd-kind-icon">MFi<wbr>Certificate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 9</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/util/tlv.ts#L30">lib/util/tlv.ts:30</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="tag.mfisignature" class="tsd-anchor"></a> <h3>MFi<wbr>Signature</h3> <div class="tsd-signature tsd-kind-icon">MFi<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 10</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/util/tlv.ts#L31">lib/util/tlv.ts:31</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="tag.pairingmethod" class="tsd-anchor"></a> <h3>Pairing<wbr>Method</h3> <div class="tsd-signature tsd-kind-icon">Pairing<wbr>Method<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/util/tlv.ts#L17">lib/util/tlv.ts:17</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="tag.proof" class="tsd-anchor"></a> <h3>Proof</h3> <div class="tsd-signature tsd-kind-icon">Proof<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 4</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/util/tlv.ts#L23">lib/util/tlv.ts:23</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="tag.publickey" class="tsd-anchor"></a> <h3>Public<wbr>Key</h3> <div class="tsd-signature tsd-kind-icon">Public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 3</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/util/tlv.ts#L22">lib/util/tlv.ts:22</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="tag.salt" class="tsd-anchor"></a> <h3>Salt</h3> <div class="tsd-signature tsd-kind-icon">Salt<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 2</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/util/tlv.ts#L19">lib/util/tlv.ts:19</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="tag.sequence" class="tsd-anchor"></a> <h3>Sequence</h3> <div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 6</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/util/tlv.ts#L25">lib/util/tlv.ts:25</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="tag.signature" class="tsd-anchor"></a> <h3>Signature</h3> <div class="tsd-signature tsd-kind-icon">Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 10</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/util/tlv.ts#L28">lib/util/tlv.ts:28</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="tag.username" class="tsd-anchor"></a> <h3>Username</h3> <div class="tsd-signature tsd-kind-icon">Username<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/util/tlv.ts#L18">lib/util/tlv.ts:18</a></li> </ul> </aside> </section> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class=" tsd-kind-external-module"> <a href="_bin_index_.html">"bin/index"</a> </li> <li class=" tsd-kind-external-module"> <a href="_bin_pair_.html">"bin/pair"</a> </li> <li class=" tsd-kind-external-module"> <a href="_bin_scan_.html">"bin/scan"</a> </li> <li class=" tsd-kind-external-module"> <a href="_index_.html">"index"</a> </li> <li class=" tsd-kind-external-module"> <a href="_lib_appletv_.html">"lib/appletv"</a> </li> <li class=" tsd-kind-external-module"> <a href="_lib_browser_.html">"lib/browser"</a> </li> <li class=" tsd-kind-external-module"> <a href="_lib_connection_.html">"lib/connection"</a> </li> <li class=" tsd-kind-external-module"> <a href="_lib_credentials_.html">"lib/credentials"</a> </li> <li class=" tsd-kind-external-module"> <a href="_lib_message_.html">"lib/message"</a> </li> <li class=" tsd-kind-external-module"> <a href="_lib_now_playing_info_.html">"lib/now-<wbr>playing-<wbr>info"</a> </li> <li class=" tsd-kind-external-module"> <a href="_lib_pairing_.html">"lib/pairing"</a> </li> <li class=" tsd-kind-external-module"> <a href="_lib_supported_command_.html">"lib/supported-<wbr>command"</a> </li> <li class=" tsd-kind-external-module"> <a href="_lib_typed_events_.html">"lib/typed-<wbr>events"</a> </li> <li class=" tsd-kind-external-module"> <a href="_lib_util_encryption_.html">"lib/util/encryption"</a> </li> <li class=" tsd-kind-external-module"> <a href="_lib_util_number_.html">"lib/util/number"</a> </li> <li class="current tsd-kind-external-module"> <a href="_lib_util_tlv_.html">"lib/util/tlv"</a> </li> <li class=" tsd-kind-external-module"> <a href="_lib_verifier_.html">"lib/verifier"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_lib_util_tlv_.html#decode" class="tsd-kind-icon">decode</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_lib_util_tlv_.html#encode" class="tsd-kind-icon">encode</a> </li> <li class=" tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_lib_util_tlv_.html#tag" class="tsd-kind-icon">Tag</a> </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-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <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> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</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> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>