@fishjam-cloud/react-native-client 0.2.3 → 0.3.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 Software Mansion
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,416 +1,29 @@
-# Fishjam Cloud React Native client
-
-`@fishjam-cloud/react-native-client` is a React Native wrapper for
-[android-client](https://github.com/fishjam-dev/android-client-sdk) and
-[ios-client](https://github.com/fishjam-dev/ios-client-sdk). It allows you to
-quickly and easily create a mobile client app in React Native for a
-[Fishjam](https://github.com/fishjam-dev/fishjam) server.
+<img src="../../.github/images/fishjam-card.png" width="100%">
 
-# Documentation
+# Fishjam Cloud React Native client
 
-API documentation is available
-[here](https://fishjam-cloud.github.io/mobile-client-sdk/modules/_fishjam_cloud_react_native_client.html)
+`@fishjam-cloud/react-native-client` is an easiest way to add video streaming to your React Native app.
 
 # Installation
 
-Firstly install `react-native-client` with `yarn` or `npm`
-
-```
-yarn add @fishjam-cloud/react-native-client
-```
-
-or
-
-```
-npm install @fishjam-cloud/react-native-client
-```
-
-### Expo plugin
-
-If you're using development builds with `eas build` or bare workflow you can try
-using expo plugin to do the configuration below for you. Simply run:
-
-```
-expo install @fishjam-cloud/react-native-client
-```
-
-Add plugin to your `app.json` if it's not already added:
-
-```json
-{
-  "expo": {
-    "name": "example",
-    ...
-    "plugins": [
-      "@fishjam-cloud/react-native-client"
-    ]
-  }
-}
-```
-
-If you want to use screensharing feature, enable the following flags:
-
-```json
-{
-  "expo": {
-    "name": "example",
-    ...
-    "plugins": [
-      [
-        "@fishjam-cloud/react-native-client",
-        {
-          "android": {
-            "enableForegroundService": true
-          },
-          "ios": {
-            "enableScreensharing": true
-          }
-        }
-      ]
-    ]
-  }
-}
-```
-
-On bare workflow run `expo prebuild` to configure the app, then run
-`pod install`. On development build `eas build` should take care of it.
-
-### Android
-
-1. Add camera and microphone permissions to your `AndroidManifest.xml` or you app.json permissions.
-2. Rebuild the app. That's it!
-
-### iOS
-
-> [!NOTE]
-> If you're using our plugin with `enableScreensharing` set to `true`. Not further steps are required.
-
-On iOS installation is a bit more complicated, because you need to setup a
-screen broadcast app extension for screensharing.
-
-1. Add camera and microphone permissions to your main `Info.plist`.
-   ```xml
-   <key>NSCameraUsageDescription</key>
-   <string>Allow $(PRODUCT_NAME) to use the camera</string>
-   <key>NSMicrophoneUsageDescription</key>
-   <string>Allow $(PRODUCT_NAME) to use the microphone</string>
-   ```
-2. We recommend adding `audio` background mode in `Info.plist` so that the app
-   doesn't disconnect when it's in background:
-
-```xml
-  <key>UIBackgroundModes</key>
-  <array>
-    <string>audio</string>
-  </array>
-```
-
-2. Open your `<your-project>.xcworkspace` in Xcode
-3. Create new Broadcast Upload Extension. Select File → New → Target... →
-   Broadcast Upload Extension → Next. Choose the name for the new target, select
-   Swift language and deselect "Include UI Extension".
-
-   ![New target config](https://github.com/fishjam-cloud/mobile-client-sdk/blob/main/.github/images/xcode1.png)
-
-   Press Finish. In the next alert xcode will ask you if you want to activate
-   the new scheme - press Cancel.
-
-4. Configure app group. Go to "Signing & Capabilities" tab, click "+ Capability"
-   button in upper left corner and select "App Groups".
-
-   ![App groups config](https://github.com/fishjam-cloud/mobile-client-sdk/blob/main/.github/images/xcode2.png)
-
-   Then in the "App Groups" add a new group or select existing. Usually group
-   name has format `group.<your-bundle-identifier>`. Verify that both app and
-   extension targets have app group and dev team set correctly.
-
-5. A new folder with app extension should appear on the left with contents like
-   this:
-
-   ![App extension files](https://github.com/fishjam-cloud/mobile-client-sdk/blob/main/.github/images/xcode3.png)
-
-   Replace `SampleHandler.swift` with `MembraneBroadcastSampleHandler.swift` and
-   this code:
-
-   ```swift
-   import Foundation
-   import MembraneRTC
-   import os.log
-   import ReplayKit
-   import WebRTC
-
-
-   /// App Group used by the extension to exchange buffers with the target application
-   let appGroup = "{{GROUP_IDENTIFIER}}"
-
-   let logger = OSLog(subsystem: "{{BUNDLE_IDENTIFIER}}.MembraneBroadcastSampleHandler", category: "Broadcaster")
-
-   /// An example `SampleHandler` utilizing `BroadcastSampleSource` from `MembraneRTC` sending broadcast samples and necessary notification enabling device's screencast.
-   class MembraneBroadcastSampleHandler: RPBroadcastSampleHandler {
-       let broadcastSource = BroadcastSampleSource(appGroup: appGroup)
-       var started: Bool = false
-
-
-       override func broadcastStarted(withSetupInfo _: [String: NSObject]?) {
-           started = broadcastSource.connect()
-
-           guard started else {
-               os_log("failed to connect with ipc server", log: logger, type: .debug)
-
-               super.finishBroadcastWithError(NSError(domain: "", code: 0, userInfo: nil))
-
-               return
-           }
-
-           broadcastSource.started()
-       }
+Check out the [installation](https://fishjam-cloud.github.io/documentation/guide/react-native/installation) section of our docs for the detailed installation instructions.
 
-       override func broadcastPaused() {
-           broadcastSource.paused()
-       }
-
-       override func broadcastResumed() {
-           broadcastSource.resumed()
-       }
-
-       override func broadcastFinished() {
-           broadcastSource.finished()
-       }
-
-       override func processSampleBuffer(_ sampleBuffer: CMSampleBuffer, with sampleBufferType: RPSampleBufferType) {
-           guard started else {
-               return
-           }
-
-           broadcastSource.processFrame(sampleBuffer: sampleBuffer, ofType: sampleBufferType)
-       }
-   }
-   ```
-
-   Replace `{{GROUP_IDENTIFIER}}` and `{{BUNDLE_IDENTIFIER}}` with your group
-   identifier and bundle identifier respectively.
-
-6. In project's Podfile add the following code:
-   ```rb
-   target 'MembraneScreenBroadcastExtension' do
-     pod 'MembraneRTC/Broadcast'
-   end
-   ```
-   > This new dependency should be added outside of your application target.
-   > Example
-   >
-   > ```rb
-   > target 'ReactNativeMembraneExample' do
-   >  ...
-   > end
-   >
-   > target 'MembraneScreenBroadcastExtension' do
-   >  pod 'MembraneRTC/Broadcast'
-   > end
-   > ```
-7. Run `pod install` in your `ios/` directory
-8. Add the following constants in your Info.plist:
-   ```xml
-   <key>AppGroupName</key>
-   <string>{{GROUP_IDENTIFIER}}</string>
-   <key>ScreencastExtensionBundleId</key>
-   <string>{{BUNDLE_IDENTIFIER}}.MembraneBroadcastSampleHandler</string>
-   ```
-   Replace `{{GROUP_IDENTIFIER}}` and `{{BUNDLE_IDENTIFIER}}` with your group
-   identifier and bundle identifier respectively.
-9. Rebuild the app and enjoy!
-
-# Example
-
-We strongly recommend checking out our example app that implements a basic video
-room client. To run the app:
-
-1. Go to Membrane's server demo repo: https://fishjam.io/app/login Follow
-   instructions there to setup and run demo server.
-2. Clone the repo
-3. ```
-   yarn
-   yarn build
-   cd `examples/fishjam-chat`
-   npx expo prebuild --clean
-   ```
-4. Copy `.env.template` and create `.env` with proper secrets.
-5. `yarn run android` or `yarn run ios` or run project from Android Studio /
-   Xcode just like every RN project. Note that simulators won't work, you have
-   to test on real device for camera and screensharing to run.
-
-# Usage
-
-> [!CAUTION]
-> This part of documentation is out of date. It will be updated soon.
-
-Connect to the server and join the room using the `connect` function. Use user
-metadata to pass things like usernames etc. to the server.
-
-```ts
-const startServerConnection = () => {
-  try {
-    await connect('http://server_address:5002', 'peer_token', {
-      displayName: 'Annie',
-    });
-  } catch (e) {
-    console.log('error!');
-  }
-};
-```
-
-Remember to gracefully disconnect from the server using the `leaveRoom()`
-function:
-
-```ts
-const stopServerConnection = () => {
-  await leaveRoom();
-};
-```
-
-Start the device's camera and microphone using `useCamera()` and
-`useMicrophone()` hooks. Use `videoTrackMetadata` and `audioTrackMetadata`
-options to send metadata about the tracks (for example whether it's a camera or
-screencast track).
-
-```ts
-const { startCamera } = useCamera();
-const { startMicrophone } = useMicrophone();
-
-await startCamera({
-  quality: VideoQuality.HD_169,
-  videoTrackMetadata: { active: true, type: 'camera' },
-});
-await startMicrophone({ audioTrackMetadata: { active: true, type: 'audio' } });
-```
-
-For more options and functions to control the camera and microphone see the API
-documentation.
-
-If you have the connection set up, then use `useParticipants()` hook to track
-the other participants in the room. One of the participants will be a local
-participant (the one who's using the device). When participants is added or
-removed because an user joins or leaves the room, the participants will be
-updated automatically. Simply call the hook like this:
-
-```ts
-const participants = useParticipants();
-```
-
-When you have the participants all that's left is to render their video tracks.
-Use `<VideoRendererView />` component like this:
-
-```ts
-{
-  endpoint.videoTracks.map((track) => (
-    <VideoRendererView trackId={track.id} />
-  ));
-}
-```
-
-You can style the views to lay out them however you'd like, basic animations
-should work too.
-
-There are also some simple hooks for toggling camera, microphone and
-screensharing. Use them like this:
-
-```ts
-const { isCameraOn, toggleCamera } = useCameraState();
-const { isMicrophoneOn, toggleMicrophone } = useMicrophoneState();
-```
-
-For screencasting use `useScreencast()` hook. The local endpoint will have a new
-video track which you can render just like an ordinary video track with
-<VideoRendererView />:
-
-```ts
-const { isScreencastOn, toggleScreencast } = useScreencast();
-...
-toggleScreencast({screencastMetadata: { displayName: "Annie's desktop" }});
-```
-
-Use track metadata to differentiate between video and screencast tracks.
-
-### Android foreground service
-
-> [!NOTE]
-> If you're using our plugin with `enableForegroundService` set to `true`. Not further steps are required.
-
-In order for the call to continue running when app is in background, you need to
-set up and start a foreground service. You can use a 3rd party library for this,
-for example [notifee](https://notifee.app/).
-
-In `AndroidManifest.xml` specify necessary permissions:
-
-```xml
-    <uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" />
-    <uses-permission android:name="android.permission.FOREGROUND_SERVICE_CAMERA" />
-    <uses-permission android:name="android.permission.FOREGROUND_SERVICE_MICROPHONE" />
-```
-
-And add foreground service:
-
-```xml
-<application
-...
->
-  ...
-  <service
-    android:name="app.notifee.core.ForegroundService"
-    android:foregroundServiceType="mediaProjection|camera|microphone" />
-</application>
-```
-
-Then to start the foreground service:
-
-```ts
-import notifee, { AndroidImportance } from '@notifee/react-native';
-
-const startForegroundService = async () => {
-  if (Platform.OS === 'android') {
-    const channelId = await notifee.createChannel({
-      id: 'video_call',
-      name: 'Video call',
-      lights: false,
-      vibration: false,
-      importance: AndroidImportance.DEFAULT,
-    });
+# Documentation
 
-    await notifee.displayNotification({
-      title: 'Your video call is ongoing',
-      body: 'Tap to return to the call.',
-      android: {
-        channelId,
-        asForegroundService: true,
-        ongoing: true,
-        pressAction: {
-          id: 'default',
-        },
-      },
-    });
-  }
-};
-```
+Check out our [documentation](https://fishjam-cloud.github.io/documentation/) on how Fishjam Cloud work and how to integrate our service with your app.
 
-Don't forget to also stop the service when the call has ended:
+There is also [API documentation](https://fishjam-cloud.github.io/mobile-client-sdk/modules/_fishjam_cloud_react_native_client.html) available.
 
-```ts
-notifee.stopForegroundService();
-```
+# Examples
 
-Also add this code in your `index.js` to register the service:
+There is simple example app, that allows you to test our service. To run it locally, follow [instructions](https://github.com/fishjam-cloud/mobile-client-sdk/tree/main/examples/fishjam-chat#react-native-fishjam-cloud-example).
 
-```js
-notifee.registerForegroundService((notification) => {
-  return new Promise(() => {});
-});
-```
+## License
 
-## Copyright and License
+Licensed under the [Apache License, Version 2.0](LICENSE)
 
-Copyright 2024,
-[Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=react-client)
+## Fishjam Cloud is created by Software Mansion
 
-[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=react-client)](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=react-client)
+Since 2012 [Software Mansion](https://swmansion.com) is a software agency with experience in building web and mobile apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues. We can help you build your next dream product – [Hire us](https://swmansion.com/contact/projects?utm_source=fishjam&utm_medium=mobile-readme).
 
-Licensed under the [Apache License, Version 2.0](LICENSE)
+[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=react-client)](https://swmansion.com/contact/projects?utm_source=fishjam&utm_medium=mobile-readme)

package/android/build.gradle

@@ -2,7 +2,7 @@ apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
 apply plugin: 'maven-publish'
 
-def packageVersion = '0.2.3'
+def packageVersion = '0.3.0'
 
 group = 'io.fishjam.reactnative'
 version = "${packageVersion}"
@@ -55,11 +55,11 @@ afterEvaluate {
 
 android {
   namespace = "io.fishjam.reactnative"
-  compileSdk(31)
+  compileSdk(34)
 
   defaultConfig {
     minSdkVersion safeExtGet("minSdkVersion", 21)
-    targetSdkVersion safeExtGet("targetSdkVersion", 31)
+    targetSdkVersion safeExtGet("targetSdkVersion", 34)
     versionCode 1
     versionName "${packageVersion}"
   }