@applooma/rtc-react-native 0.1.0 → 0.2.0

package/README.md

@@ -0,0 +1,107 @@
+# @applooma/rtc-react-native
+
+Real-time voice, video, live streaming and audio rooms for React Native, by
+[AppLooma LLC](https://applooma.dev).
+
+Full documentation: **https://docs.applooma.dev/sdk/react-native**
+
+## Install
+
+```bash
+npm install @applooma/rtc-react-native
+cd ios && pod install
+```
+
+The native modules are ordinary dependencies of the package, so autolinking
+picks them up. Rebuild the app afterwards — reloading the JavaScript bundle is
+not enough.
+
+React Native 0.73 or newer and React 18 or newer are peer dependencies.
+
+### One call in each native project
+
+The audio engine is set up before React Native starts, so it is initialised
+from the host application rather than from JavaScript. Put the call above any
+other React Native initialisation.
+
+**Android** — `MainApplication.kt`:
+
+```kotlin
+import com.applooma.rtc.reactnative.AppLoomaRtc
+import com.applooma.rtc.reactnative.audio.AudioType
+
+class MainApplication : Application(), ReactApplication {
+  override fun onCreate() {
+    AppLoomaRtc.setup(this, AudioType.CommunicationAudioType())
+    super.onCreate()
+  }
+}
+```
+
+**iOS** — `AppDelegate.swift`:
+
+```swift
+import applooma_rtc_native_core
+
+AppLoomaRtc.setup()
+```
+
+### Permissions
+
+`Info.plist` needs `NSCameraUsageDescription` and
+`NSMicrophoneUsageDescription`; without them the app terminates the first time
+it opens a device. `AndroidManifest.xml` needs `CAMERA`, `RECORD_AUDIO`,
+`INTERNET` and `MODIFY_AUDIO_SETTINGS`, and Android 6 and later also require
+requesting camera and microphone at runtime before joining.
+
+## Quickstart
+
+Tokens come from **your** server. Your API secret must never ship inside an
+app — anyone who extracts it can issue unlimited tokens on your account.
+
+```tsx
+import { initAppLooma, useAppEngine, AppVideoView } from '@applooma/rtc-react-native';
+
+initAppLooma(); // once, at the top of your entry file
+
+function Call() {
+  const { engine, remoteUsers, join } = useAppEngine({ appId: 'YOUR_APP_ID' });
+
+  useEffect(() => {
+    // Your own endpoint, which calls POST https://api.applooma.dev/v1/token
+    // server-side with your API key and secret.
+    fetchToken('lobby').then((s) => join(s.token, s.wsUrl, { role: 'host', camera: true }));
+  }, [join]);
+
+  return (
+    <>
+      <AppVideoView engine={engine} local style={{ flex: 1 }} />
+      {remoteUsers.map((user) => (
+        <AppVideoView key={user.uid} user={user} style={{ flex: 1 }} />
+      ))}
+    </>
+  );
+}
+```
+
+## Roles
+
+The role is fixed by the token your server issues, not by the client.
+
+| Role | Publish | Subscribe | Administer the channel |
+|---|---|---|---|
+| `host` | yes | yes | yes |
+| `cohost` | yes | yes | no |
+| `audience` | no | yes | no |
+
+Use `audience` for viewers of a live stream. An audience token cannot publish,
+which is what keeps a large broadcast cheap and stable.
+
+## Support
+
+- Documentation — https://docs.applooma.dev
+- Email — support@applooma.dev
+
+## Licence
+
+MIT. See [LICENSE](LICENSE).