docs: add api docs for E2EE

livekit · Dec 18, 2024 · a49fff6 · a49fff6
1 parent 6886876
commit a49fff6
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 0 deletions.
diff --git a/docs/classes/RNE2EEManager.html b/docs/classes/RNE2EEManager.html
@@ -0,0 +1,6 @@
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RNE2EEManager | LiveKit React Native Client SDK - v2.5.0</title><meta name="description" content="Documentation for LiveKit React Native Client SDK"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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">LiveKit React Native Client SDK - v2.5.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">LiveKit React Native Client SDK</a></li><li><a href="RNE2EEManager.html">RNE2EEManager</a></li></ul><h1>Class RNE2EEManager<code class="tsd-tag ts-flagExperimental">Experimental</code> </h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">TypedEventEmitter</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">E2EEManagerCallbacks</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">RNE2EEManager</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseE2EEManager</span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/6886876cfde73bc4a838ed4dd19f71ad7b807408/src/e2ee/RNE2EEManager.ts#L28">e2ee/RNE2EEManager.ts:28</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="RNE2EEManager.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
+</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="RNE2EEManager.html#setParticipantCryptorEnabled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Participant<wbr/>Cryptor<wbr/>Enabled</span></a>
+<a href="RNE2EEManager.html#setSifTrailer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Sif<wbr/>Trailer</span></a>
+<a href="RNE2EEManager.html#setup" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>setup</span></a>
+<a href="RNE2EEManager.html#setupEngine" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>setup<wbr/>Engine</span></a>
+</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_RNE2EEManager" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new RNE2EEManager</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyProvider</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="RNE2EEManager.html" class="tsd-signature-type tsd-kind-class">RNE2EEManager</a><a href="#constructor.new_RNE2EEManager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">keyProvider</span>: <a href="RNKeyProvider.html" class="tsd-signature-type tsd-kind-class">RNKeyProvider</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="RNE2EEManager.html" class="tsd-signature-type tsd-kind-class">RNE2EEManager</a></h4><aside class="tsd-sources"><p>Overrides (EventEmitter as new () =&gt; TypedEventEmitter&lt;E2EEManagerCallbacks&gt;).constructor</p><ul><li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/6886876cfde73bc4a838ed4dd19f71ad7b807408/src/e2ee/RNE2EEManager.ts#L40">e2ee/RNE2EEManager.ts:40</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="setParticipantCryptorEnabled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Participant<wbr/>Cryptor<wbr/>Enabled</span><a href="#setParticipantCryptorEnabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setParticipantCryptorEnabled.setParticipantCryptorEnabled-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Participant<wbr/>Cryptor<wbr/>Enabled</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">enabled</span>, <span class="tsd-kind-parameter">participantIdentity</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setParticipantCryptorEnabled.setParticipantCryptorEnabled-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">enabled</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">participantIdentity</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Implementation of BaseE2EEManager.setParticipantCryptorEnabled</p><ul><li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/6886876cfde73bc4a838ed4dd19f71ad7b807408/src/e2ee/RNE2EEManager.ts#L170">e2ee/RNE2EEManager.ts:170</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setSifTrailer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Sif<wbr/>Trailer</span><a href="#setSifTrailer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setSifTrailer.setSifTrailer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Sif<wbr/>Trailer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">trailer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setSifTrailer.setSifTrailer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">trailer</span>: <span class="tsd-signature-type">Uint8Array</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Implementation of BaseE2EEManager.setSifTrailer</p><ul><li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/6886876cfde73bc4a838ed4dd19f71ad7b807408/src/e2ee/RNE2EEManager.ts#L132">e2ee/RNE2EEManager.ts:132</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setup" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>setup</span><a href="#setup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setup.setup-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">room</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setup.setup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">room</span>: <span class="tsd-signature-type">Room</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Implementation of BaseE2EEManager.setup</p><ul><li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/6886876cfde73bc4a838ed4dd19f71ad7b807408/src/e2ee/RNE2EEManager.ts#L46">e2ee/RNE2EEManager.ts:46</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setupEngine" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>setup<wbr/>Engine</span><a href="#setupEngine" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setupEngine.setupEngine-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setup<wbr/>Engine</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">_engine</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setupEngine.setupEngine-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">_engine</span>: <span class="tsd-signature-type">default</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Implementation of BaseE2EEManager.setupEngine</p><ul><li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/6886876cfde73bc4a838ed4dd19f71ad7b807408/src/e2ee/RNE2EEManager.ts#L167">e2ee/RNE2EEManager.ts:167</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#setParticipantCryptorEnabled" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Participant<wbr/>Cryptor<wbr/>Enabled</span></a><a href="#setSifTrailer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Sif<wbr/>Trailer</span></a><a href="#setup" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>setup</span></a><a href="#setupEngine" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>setup<wbr/>Engine</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>LiveKit React Native Client SDK - v2.5.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>