chore: release 2.4.1

livekit · Aug 21, 2024 · 15bcd36 · 15bcd36
1 parent 793ae2e
commit 15bcd36
Show file tree

Hide file tree

Showing 33 changed files with 84 additions and 74 deletions.
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -25,10 +25,12 @@
  --dark-hl-11: #D4D4D4;
  --light-hl-12: #098658;
  --dark-hl-12: #B5CEA8;
- --light-hl-13: #800000;
- --dark-hl-13: #569CD6;
- --light-hl-14: #0000FF;
- --dark-hl-14: #CE9178;
+ --light-hl-13: #000000;
+ --dark-hl-13: #C8C8C8;
+ --light-hl-14: #800000;
+ --dark-hl-14: #569CD6;
+ --light-hl-15: #0000FF;
+ --dark-hl-15: #CE9178;
  --light-code-background: #FFFFFF;
  --dark-code-background: #1E1E1E;
 }
@@ -49,6 +51,7 @@
  --hl-12: var(--light-hl-12);
  --hl-13: var(--light-hl-13);
  --hl-14: var(--light-hl-14);
+ --hl-15: var(--light-hl-15);
  --code-background: var(--light-code-background);
 } }
 
@@ -68,6 +71,7 @@
  --hl-12: var(--dark-hl-12);
  --hl-13: var(--dark-hl-13);
  --hl-14: var(--dark-hl-14);
+ --hl-15: var(--dark-hl-15);
  --code-background: var(--dark-code-background);
 } }
 
@@ -87,6 +91,7 @@
  --hl-12: var(--light-hl-12);
  --hl-13: var(--light-hl-13);
  --hl-14: var(--light-hl-14);
+ --hl-15: var(--light-hl-15);
  --code-background: var(--light-code-background);
 }
 
@@ -106,6 +111,7 @@
  --hl-12: var(--dark-hl-12);
  --hl-13: var(--dark-hl-13);
  --hl-14: var(--dark-hl-14);
+ --hl-15: var(--dark-hl-15);
  --code-background: var(--dark-code-background);
 }
 
@@ -124,4 +130,5 @@
 .hl-12 { color: var(--hl-12); }
 .hl-13 { color: var(--hl-13); }
 .hl-14 { color: var(--hl-14); }
+.hl-15 { color: var(--hl-15); }
 pre, code { background: var(--code-background); }
diff --git a/docs/classes/AudioSession.html b/docs/classes/AudioSession.html
diff --git a/docs/functions/LiveKitRoom.html b/docs/functions/LiveKitRoom.html
@@ -1,6 +1,6 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LiveKitRoom | LiveKit React Native Client SDK - v2.4.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.4.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="LiveKitRoom.html">LiveKitRoom</a></li></ul><h1>Function LiveKitRoom</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="LiveKitRoom" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Live<wbr/>Kit<wbr/>Room</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span><a href="#LiveKitRoom" 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-comment tsd-typography"><p>The <code>LiveKitRoom</code> component provides the room context to all its child components.
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LiveKitRoom | LiveKit React Native Client SDK - v2.4.1</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.4.1</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="LiveKitRoom.html">LiveKitRoom</a></li></ul><h1>Function LiveKitRoom</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="LiveKitRoom" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Live<wbr/>Kit<wbr/>Room</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span><a href="#LiveKitRoom" 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-comment tsd-typography"><p>The <code>LiveKitRoom</code> component provides the room context to all its child components.
 It is generally the starting point of your LiveKit app and the root of the LiveKit component tree.
 It provides the room state as a React context to all child components, so you don&#39;t have to pass it yourself.</p>
 </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">PropsWithChildren</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/LiveKitRoomProps.html" class="tsd-signature-type tsd-kind-interface">LiveKitRoomProps</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-tsx"><span class="hl-9">&lt;</span><span class="hl-4">LiveKitRoom</span><br/><span class="hl-1"> </span><span class="hl-10">token</span><span class="hl-1">=</span><span class="hl-2">&#39;&lt;livekit-token&gt;&#39;</span><br/><span class="hl-1"> </span><span class="hl-10">serverUrl</span><span class="hl-1">=</span><span class="hl-2">&#39;&lt;url-to-livekit-server&gt;&#39;</span><br/><span class="hl-1"> </span><span class="hl-10">connect</span><span class="hl-1">=</span><span class="hl-3">{true}</span><br/><span class="hl-9">&gt;</span><br/><span class="hl-1"> ...</span><br/><span class="hl-9">&lt;/</span><span class="hl-4">LiveKitRoom</span><span class="hl-9">&gt;</span>
 </code><button>Copy</button></pre>
-</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/8929ba072fc2660731f57daa4bde31a6fd4a0e03/src/components/LiveKitRoom.tsx#L105">components/LiveKitRoom.tsx:105</a></li></ul></aside></li></ul></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></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.4.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>
+</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/793ae2e9dc521e2cc0037d154d17d3ebdac049dc/src/components/LiveKitRoom.tsx#L105">components/LiveKitRoom.tsx:105</a></li></ul></aside></li></ul></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></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.4.1</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>