Skip to content

Commit 0075f2d

Browse files
committed
chore: release 1.4.1
1 parent dea542b commit 0075f2d

26 files changed

+51
-48
lines changed

docs/classes/AudioSession.html

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ <h4>Hierarchy</h4>
1818
<ul class="tsd-hierarchy">
1919
<li><span class="target">AudioSession</span></li></ul></section><aside class="tsd-sources">
2020
<ul>
21-
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/b582082/src/audio/AudioSession.ts#L246">audio/AudioSession.ts:246</a></li></ul></aside>
21+
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/dea542b/src/audio/AudioSession.ts#L246">audio/AudioSession.ts:246</a></li></ul></aside>
2222
<section class="tsd-panel-group tsd-index-group">
2323
<section class="tsd-panel tsd-index-panel">
2424
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -55,6 +55,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <s
5555
<li class="tsd-description">
5656
<div class="tsd-comment tsd-typography"><p>Applies the provided audio configuration to the underlying AudioSession.</p>
5757
<p>Must be called prior to connecting to a Room for the configuration to apply correctly.</p>
58+
<p>See also useIOSAudioManagement for automatic configuration of iOS audio options.</p>
5859
</div>
5960
<div class="tsd-parameters">
6061
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -63,7 +64,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
6364
<h5>config: <a href="../types/AudioConfiguration.html" class="tsd-signature-type" data-tsd-kind="Type alias">AudioConfiguration</a></h5></li></ul></div>
6465
<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><aside class="tsd-sources">
6566
<ul>
66-
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/b582082/src/audio/AudioSession.ts#L252">audio/AudioSession.ts:252</a></li></ul></aside></li></ul></section>
67+
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/dea542b/src/audio/AudioSession.ts#L254">audio/AudioSession.ts:254</a></li></ul></aside></li></ul></section>
6768
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAudioOutputs" class="tsd-anchor"></a>
6869
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Audio<wbr/>Outputs</span><a href="#getAudioOutputs" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
6970
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -93,7 +94,7 @@ <h3>Returns</h3><p>the available audio output types</p>
9394
</div>
9495
<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">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
9596
<ul>
96-
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/b582082/src/audio/AudioSession.ts#L294">audio/AudioSession.ts:294</a></li></ul></aside></li></ul></section>
97+
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/dea542b/src/audio/AudioSession.ts#L296">audio/AudioSession.ts:296</a></li></ul></aside></li></ul></section>
9798
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="selectAudioOutput" class="tsd-anchor"></a>
9899
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>select<wbr/>Audio<wbr/>Output</span><a href="#selectAudioOutput" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
99100
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -111,7 +112,7 @@ <h5>deviceId: <span class="tsd-signature-type">string</span></h5>
111112
</div></li></ul></div>
112113
<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><aside class="tsd-sources">
113114
<ul>
114-
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/b582082/src/audio/AudioSession.ts#L311">audio/AudioSession.ts:311</a></li></ul></aside></li></ul></section>
115+
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/dea542b/src/audio/AudioSession.ts#L313">audio/AudioSession.ts:313</a></li></ul></aside></li></ul></section>
115116
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setAppleAudioConfiguration" class="tsd-anchor"></a>
116117
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>set<wbr/>Apple<wbr/>Audio<wbr/>Configuration</span><a href="#setAppleAudioConfiguration" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
117118
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -124,7 +125,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
124125
<h5>config: <a href="../types/AppleAudioConfiguration.html" class="tsd-signature-type" data-tsd-kind="Type alias">AppleAudioConfiguration</a></h5></li></ul></div>
125126
<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><aside class="tsd-sources">
126127
<ul>
127-
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/b582082/src/audio/AudioSession.ts#L326">audio/AudioSession.ts:326</a></li></ul></aside></li></ul></section>
128+
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/dea542b/src/audio/AudioSession.ts#L328">audio/AudioSession.ts:328</a></li></ul></aside></li></ul></section>
128129
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="showAudioRoutePicker" class="tsd-anchor"></a>
129130
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>show<wbr/>Audio<wbr/>Route<wbr/>Picker</span><a href="#showAudioRoutePicker" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
130131
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -135,7 +136,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <s
135136
</div>
136137
<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><aside class="tsd-sources">
137138
<ul>
138-
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/b582082/src/audio/AudioSession.ts#L320">audio/AudioSession.ts:320</a></li></ul></aside></li></ul></section>
139+
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/dea542b/src/audio/AudioSession.ts#L322">audio/AudioSession.ts:322</a></li></ul></aside></li></ul></section>
139140
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="startAudioSession" class="tsd-anchor"></a>
140141
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>start<wbr/>Audio<wbr/>Session</span><a href="#startAudioSession" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
141142
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -145,7 +146,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <s
145146
</div>
146147
<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><aside class="tsd-sources">
147148
<ul>
148-
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/b582082/src/audio/AudioSession.ts#L259">audio/AudioSession.ts:259</a></li></ul></aside></li></ul></section>
149+
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/dea542b/src/audio/AudioSession.ts#L261">audio/AudioSession.ts:261</a></li></ul></aside></li></ul></section>
149150
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="stopAudioSession" class="tsd-anchor"></a>
150151
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>stop<wbr/>Audio<wbr/>Session</span><a href="#stopAudioSession" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
151152
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -155,7 +156,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <s
155156
</div>
156157
<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><aside class="tsd-sources">
157158
<ul>
158-
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/b582082/src/audio/AudioSession.ts#L266">audio/AudioSession.ts:266</a></li></ul></aside></li></ul></section></section></div>
159+
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/dea542b/src/audio/AudioSession.ts#L268">audio/AudioSession.ts:268</a></li></ul></aside></li></ul></section></section></div>
159160
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
160161
<div class="tsd-navigation settings">
161162
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/functions/VideoView.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
2424
<h5>__namedParameters: <a href="../types/Props.html" class="tsd-signature-type" data-tsd-kind="Type alias">Props</a></h5></li></ul></div>
2525
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4><aside class="tsd-sources">
2626
<ul>
27-
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/b582082/src/components/VideoView.tsx#L24">components/VideoView.tsx:24</a></li></ul></aside></li></ul></section></div>
27+
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/dea542b/src/components/VideoView.tsx#L24">components/VideoView.tsx:24</a></li></ul></aside></li></ul></section></div>
2828
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
2929
<div class="tsd-navigation settings">
3030
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/functions/getDefaultAppleAudioConfigurationForMode.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ <h5>mode: <a href="../types/AudioTrackState.html" class="tsd-signature-type" dat
2626
<h5>preferSpeakerOutput: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5></li></ul></div>
2727
<h4 class="tsd-returns-title">Returns <a href="../types/AppleAudioConfiguration.html" class="tsd-signature-type" data-tsd-kind="Type alias">AppleAudioConfiguration</a></h4><aside class="tsd-sources">
2828
<ul>
29-
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/b582082/src/audio/AudioSession.ts#L221">audio/AudioSession.ts:221</a></li></ul></aside></li></ul></section></div>
29+
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/dea542b/src/audio/AudioSession.ts#L221">audio/AudioSession.ts:221</a></li></ul></aside></li></ul></section></div>
3030
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
3131
<div class="tsd-navigation settings">
3232
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/functions/registerGlobals.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ <h1>Function registerGlobals</h1></div>
2222
</div>
2323
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
2424
<ul>
25-
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/b582082/src/index.tsx#L24">index.tsx:24</a></li></ul></aside></li></ul></section></div>
25+
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/dea542b/src/index.tsx#L24">index.tsx:24</a></li></ul></aside></li></ul></section></div>
2626
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
2727
<div class="tsd-navigation settings">
2828
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/functions/setLogLevel.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ <h5>level: <span class="tsd-signature-type">&quot;trace&quot;</span><span class=
2929
<h5>options: <a href="../types/SetLogLevelOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">SetLogLevelOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
3030
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
3131
<ul>
32-
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/b582082/src/logger.ts#L17">logger.ts:17</a></li></ul></aside></li></ul></section></div>
32+
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/dea542b/src/logger.ts#L17">logger.ts:17</a></li></ul></aside></li></ul></section></div>
3333
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
3434
<div class="tsd-navigation settings">
3535
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/functions/sortParticipants.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ <h5>participants: <span class="tsd-signature-type">default</span><span class="ts
3535
<h5><code class="tsd-tag ts-flagOptional">Optional</code> localParticipant: <span class="tsd-signature-type">default</span></h5></li></ul></div>
3636
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
3737
<ul>
38-
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/b582082/src/useRoom.ts#L111">useRoom.ts:111</a></li></ul></aside></li></ul></section></div>
38+
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/dea542b/src/useRoom.ts#L111">useRoom.ts:111</a></li></ul></aside></li></ul></section></div>
3939
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
4040
<div class="tsd-navigation settings">
4141
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/functions/useIOSAudioManagement.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ <h5>room: <span class="tsd-signature-type">Room</span></h5></li>
2929
<h5>preferSpeakerOutput: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5></li>
3030
<li>
3131
<h5><code class="tsd-tag ts-flagOptional">Optional</code> onConfigureNativeAudio: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>trackState<span class="tsd-signature-symbol">: </span><a href="../types/AudioTrackState.html" class="tsd-signature-type" data-tsd-kind="Type alias">AudioTrackState</a>, preferSpeakerOutput<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../types/AppleAudioConfiguration.html" class="tsd-signature-type" data-tsd-kind="Type alias">AppleAudioConfiguration</a><span class="tsd-signature-symbol">)</span></h5>
32+
<div class="tsd-comment tsd-typography"><p>A custom method for determining options used.</p>
33+
</div>
3234
<ul class="tsd-parameters">
3335
<li class="tsd-parameter-signature">
3436
<ul class="tsd-signatures tsd-kind-type-literal">
@@ -44,7 +46,7 @@ <h5>preferSpeakerOutput: <span class="tsd-signature-type">boolean</span></h5></l
4446
<h4 class="tsd-returns-title">Returns <a href="../types/AppleAudioConfiguration.html" class="tsd-signature-type" data-tsd-kind="Type alias">AppleAudioConfiguration</a></h4></li></ul></li></ul></li></ul></div>
4547
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
4648
<ul>
47-
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/b582082/src/audio/AudioManager.ts#L19">audio/AudioManager.ts:19</a></li></ul></aside></li></ul></section></div>
49+
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/dea542b/src/audio/AudioManager.ts#L19">audio/AudioManager.ts:19</a></li></ul></aside></li></ul></section></div>
4850
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
4951
<div class="tsd-navigation settings">
5052
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/functions/useParticipant.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
2424
<h5>participant: <span class="tsd-signature-type">default</span></h5></li></ul></div>
2525
<h4 class="tsd-returns-title">Returns <a href="../interfaces/ParticipantState.html" class="tsd-signature-type" data-tsd-kind="Interface">ParticipantState</a></h4><aside class="tsd-sources">
2626
<ul>
27-
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/b582082/src/useParticipant.ts#L23">useParticipant.ts:23</a></li></ul></aside></li></ul></section></div>
27+
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/dea542b/src/useParticipant.ts#L23">useParticipant.ts:23</a></li></ul></aside></li></ul></section></div>
2828
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
2929
<div class="tsd-navigation settings">
3030
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/functions/useRoom.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ <h5>room: <span class="tsd-signature-type">Room</span></h5></li>
2626
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/RoomOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RoomOptions</a></h5></li></ul></div>
2727
<h4 class="tsd-returns-title">Returns <a href="../interfaces/RoomState.html" class="tsd-signature-type" data-tsd-kind="Interface">RoomState</a></h4><aside class="tsd-sources">
2828
<ul>
29-
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/b582082/src/useRoom.ts#L26">useRoom.ts:26</a></li></ul></aside></li></ul></section></div>
29+
<li>Defined in <a href="https://github.com/livekit/client-sdk-react-native/blob/dea542b/src/useRoom.ts#L26">useRoom.ts:26</a></li></ul></aside></li></ul></section></div>
3030
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
3131
<div class="tsd-navigation settings">
3232
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

0 commit comments

Comments
 (0)