Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fishjam-dev/react-native-client-sdk
React Native client library for Fishjam.
https://github.com/fishjam-dev/react-native-client-sdk
android fishjam ios react-native video webrtc
Last synced: 3 months ago
JSON representation
React Native client library for Fishjam.
- Host: GitHub
- URL: https://github.com/fishjam-dev/react-native-client-sdk
- Owner: fishjam-dev
- License: apache-2.0
- Created: 2023-05-12T05:55:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-20T12:44:05.000Z (9 months ago)
- Last Synced: 2024-05-20T14:42:23.972Z (9 months ago)
- Topics: android, fishjam, ios, react-native, video, webrtc
- Language: TypeScript
- Homepage: https://github.com/fishjam-dev/fishjam
- Size: 8.11 MB
- Stars: 5
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# react-native-client
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.
# Documentation
API documentation is available
[here](https://fishjam-dev.github.io/react-native-client-sdk/)
# Installation
Firstly install `react-native-client` with `yarn` or `npm`
```
yarn add @fishjam-dev/react-native-client
```
or
```
npm install @fishjam-dev/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-dev/react-native-client
```
Add plugin to your `app.json` if it's not already added:
```json
{
"expo": {
"name": "example",
...
"plugins": [
"@fishjam-dev/react-native-client"
]
}
}
```
If you want to use screensharing feature, enable the following flag:
```json
{
"expo": {
"name": "example",
...
"plugins": [
[
"@fishjam-dev/react-native-client",
{
"setUpScreensharing": 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`.
2. Rebuild the app. That's it!
### iOS
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
NSCameraUsageDescription
Allow $(PRODUCT_NAME) to use the camera
NSMicrophoneUsageDescription
Allow $(PRODUCT_NAME) to use the microphone
```
2. We recommend adding `audio` background mode in `Info.plist` so that the app
doesn't disconnect when it's in background:
```xml
UIBackgroundModes
audio
```
2. Open your `.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".
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".
Then in the "App Groups" add a new group or select existing. Usually group
name has format `group.`. 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:
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()
}
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
AppGroupName
{{GROUP_IDENTIFIER}}
ScreencastExtensionBundleId
{{BUNDLE_IDENTIFIER}}.MembraneBroadcastSampleHandler
```
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://github.com/fishjam-dev/fishjam-videoroom. Follow instructions there
to setup and run demo server.
2. Clone the repo
3. ```
cd example
yarn
```
4. In App.ts replace server url with your server's url.
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
> [!IMPORTANT] Since version 7.4.0, you need to call function
> `initializeWebRTC()` once in your app before using any other functionality.
Start with connecting to the membrane webrtc server. Use `useWebRTC()` hook to
manage connection:
```ts
const { connect, disconnect, error } = useWebRTC();
```
Connect to the server and join the room using the `connect` function. Use user
metadata to pass things like usernames etc. to the server. You can also pass
connection params that will be sent to the socket when establishing the
connection tries.
```ts
const startServerConnection = () => {
try {
await connect('https://example.com', "Annie's room", {
endpointMetadata: {
displayName: 'Annie',
},
connectionParams: {
token: 'TOKEN',
},
});
} catch (e) {
console.log('error!');
}
};
```
Remember to gracefully disconnect from the server using the `disconnect()`
function:
```ts
const stopServerConnection = () => {
await disconnect();
};
```
Also handle errors properly, for example when internet connection fails or
server is down:
```ts
useEffect(() => {
if (error) console.log('error: ', e);
}, [error]);
```
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 `useEndpoints()` hook to track the
other endpoints in the room. One of the endpoints will be a local participant
(the one who's using the device). When endpoints is added or removed because an
user joins or leaves the room, the endpoints will be updated automatically.
Simply call the hook like this:
```ts
const endpoints = useEndpoints();
```
When you have the endpoints all that's left is to render their video tracks. Use
`` component like this:
```ts
{
endpoint.videoTracks.map((track) => (
));
}
```
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
:
```ts
const { isScreencastOn, toggleScreencast } = useScreencast();
...
toggleScreencast({screencastMetadata: { displayName: "Annie's desktop" }});
```
Use track metadata to differentiate between video and screencast tracks.
### Android foreground service
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
```
And add foreground service:
```xml
...
```
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,
});
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',
},
},
});
}
};
```
Don't forget to also stop the service when the call has ended:
```ts
notifee.stopForegroundService();
```
Also add this code in your `index.js` to register the service:
```js
notifee.registerForegroundService((notification) => {
return new Promise(() => {});
});
```
### Developing
Run `./scripts/init.sh` in the main directory to install swift-format and set up
git hooks.
To release a new version of the lib just run `yarn release`, follow the prompts
to bump version, make tags, commits and upload to npm. To release a new version
of the example app on Android install fastlane, get upload key password and
firebase auth json from the devs, update `~/.gradle/gradle.properties` like
this:
```
MEMBRANE_UPLOAD_STORE_FILE=my-upload-key.keystore
MEMBRANE_UPLOAD_KEY_ALIAS=my-key-alias
MEMBRANE_UPLOAD_STORE_PASSWORD=********
MEMBRANE_UPLOAD_KEY_PASSWORD=********
```
and run `yarn releaseAppAndroid` from the main directory.
To release a new version of the example app on iOS install fastlane, get added
to swmansion app store account and run `yarn releaseAppIos` from the main
directory.
Pro tip: when developing, set the backend url in `.env.development`.
## Credits
This project has been built and is maintained thanks to the support from
[dscout](https://dscout.com/) and [Software Mansion](https://swmansion.com).
