Skip to content

Commit

Permalink
Fix broken links in README
Browse files Browse the repository at this point in the history
  • Loading branch information
davidzhao committed Nov 22, 2024
1 parent 00bfdf3 commit a31016c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Use this SDK to add realtime video, audio and data features to your React Native

> [!NOTE]
> This is v2 of the React-Native SDK. When migrating from v1.x to v2.x you might encounter a small set of breaking changes.
> Read the [migration guide](https://docs.livekit.io/guides/migrate-from-v1/) for a detailed overview of what has changed.
> Read the [migration guide](https://docs.livekit.io/recipes/migrate-from-v1/) for a detailed overview of what has changed.
## Installation

Expand Down Expand Up @@ -295,7 +295,7 @@ Enabling screenshare requires extra installation steps:

Android screenshare requires a foreground service with type `mediaProjection` to be present.

From version 2.4.0 onwards, the foreground service is handled internally,
From version 2.4.0 onwards, the foreground service is handled internally,
but you must declare the permission yourself in your app's AndroidManifest.xml file.

```
Expand Down Expand Up @@ -375,15 +375,15 @@ Once setup, [start the foreground service](https://github.com/livekit/client-sdk

### iOS

By default, simple background processing can be enabled by selecting the `audio` and `voip`
[UIBackgroundModes](https://developer.apple.com/documentation/bundleresources/information_property_list/uibackgroundmodes)
By default, simple background processing can be enabled by selecting the `audio` and `voip`
[UIBackgroundModes](https://developer.apple.com/documentation/bundleresources/information_property_list/uibackgroundmodes)
in your XCode project. In your project, select your app target -> Signing & Capabilities -> Add Capability -> Background Modes.

These background modes will keep the app alive in the background as long as a mic or audio track is playing.

For a more robust background that isn't sensitive to the above conditions, we suggest using
[CallKit](https://developer.apple.com/documentation/callkit/) to maintain the
connection while in the background. The example uses
For a more robust background that isn't sensitive to the above conditions, we suggest using
[CallKit](https://developer.apple.com/documentation/callkit/) to maintain the
connection while in the background. The example uses
[react-native-callkeep](https://github.com/react-native-webrtc/react-native-callkeep)
for simple integration with CallKit.

Expand Down
14 changes: 7 additions & 7 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<blockquote>
<p>[!NOTE]
This is v2 of the React-Native SDK. When migrating from v1.x to v2.x you might encounter a small set of breaking changes.
Read the <a href="https://docs.livekit.io/guides/migrate-from-v1/">migration guide</a> for a detailed overview of what has changed.</p>
Read the <a href="https://docs.livekit.io/recipes/migrate-from-v1/">migration guide</a> for a detailed overview of what has changed.</p>
</blockquote>
<a id="md:installation" class="tsd-anchor"></a><h2><a href="#md:installation">Installation</a></h2><a id="md:npm" class="tsd-anchor"></a><h3><a href="#md:npm">NPM</a></h3><pre><code class="language-sh"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">@livekit/react-native</span><span class="hl-1"> </span><span class="hl-2">@livekit/react-native-webrtc</span>
</code><button>Copy</button></pre>
Expand Down Expand Up @@ -70,7 +70,7 @@
hook is advised over just configuring the audio session once for the entire audio session.</p>
<a id="md:screenshare" class="tsd-anchor"></a><h2><a href="#md:screenshare">Screenshare</a></h2><p>Enabling screenshare requires extra installation steps:</p>
<a id="md:android-2" class="tsd-anchor"></a><h3><a href="#md:android-2">Android</a></h3><p>Android screenshare requires a foreground service with type <code>mediaProjection</code> to be present.</p>
<p>From version 2.4.0 onwards, the foreground service is handled internally,
<p>From version 2.4.0 onwards, the foreground service is handled internally,
but you must declare the permission yourself in your app&#39;s AndroidManifest.xml file.</p>
<pre><code><span class="hl-1">&lt;</span><span class="hl-6">uses</span><span class="hl-1">-</span><span class="hl-6">permission</span><span class="hl-1"> </span><span class="hl-13">android</span><span class="hl-1">:</span><span class="hl-6">name</span><span class="hl-1">=</span><span class="hl-2">&quot;android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION&quot;</span><span class="hl-1"> /&gt;</span>
</code><button>Copy</button></pre>
Expand All @@ -96,13 +96,13 @@
</code><button>Copy</button></pre>
<p>The camera and microphone permissions/foreground service types can be omitted if you are not using those.</p>
<p>Once setup, <a href="https://github.com/livekit/client-sdk-react-native/blob/main/example/src/callservice/CallService.android.ts">start the foreground service</a> to keep the app alive in the background.</p>
<a id="md:ios-3" class="tsd-anchor"></a><h3><a href="#md:ios-3">iOS</a></h3><p>By default, simple background processing can be enabled by selecting the <code>audio</code> and <code>voip</code>
<a href="https://developer.apple.com/documentation/bundleresources/information_property_list/uibackgroundmodes">UIBackgroundModes</a>
<a id="md:ios-3" class="tsd-anchor"></a><h3><a href="#md:ios-3">iOS</a></h3><p>By default, simple background processing can be enabled by selecting the <code>audio</code> and <code>voip</code>
<a href="https://developer.apple.com/documentation/bundleresources/information_property_list/uibackgroundmodes">UIBackgroundModes</a>
in your XCode project. In your project, select your app target -&gt; Signing &amp; Capabilities -&gt; Add Capability -&gt; Background Modes.</p>
<p>These background modes will keep the app alive in the background as long as a mic or audio track is playing.</p>
<p>For a more robust background that isn&#39;t sensitive to the above conditions, we suggest using
<a href="https://developer.apple.com/documentation/callkit/">CallKit</a> to maintain the
connection while in the background. The example uses
<p>For a more robust background that isn&#39;t sensitive to the above conditions, we suggest using
<a href="https://developer.apple.com/documentation/callkit/">CallKit</a> to maintain the
connection while in the background. The example uses
<a href="https://github.com/react-native-webrtc/react-native-callkeep">react-native-callkeep</a>
for simple integration with CallKit.</p>
<p>Our example code can be found <a href="https://github.com/livekit/client-sdk-react-native/blob/main/example/src/callservice/CallService.ios.ts">here</a>.</p>
Expand Down

0 comments on commit a31016c

Please sign in to comment.