@fishjam-cloud/react-native-client 0.1.0

package/ios/RNFishjamClientModule.swift

@@ -0,0 +1,220 @@
+import ExpoModulesCore
+
+struct RNSimulcastConfig: Record {
+    @Field
+    var enabled: Bool = false
+
+    @Field
+    var activeEncodings: [String] = []
+}
+
+struct CameraConfig: Record {
+    @Field
+    var quality: String = "VGA169"
+
+    @Field
+    var flipVideo: Bool = false
+
+    @Field
+    var videoTrackMetadata: [String: Any] = [:]
+
+    @Field
+    var simulcastConfig: RNSimulcastConfig = RNSimulcastConfig()
+
+    @Field
+    var maxBandwidth: RNTrackBandwidthLimit = RNTrackBandwidthLimit(0)
+
+    @Field
+    var cameraEnabled: Bool = true
+
+    @Field
+    var captureDeviceId: String? = nil
+}
+
+struct MicrophoneConfig: Record {
+    @Field
+    var audioTrackMetadata: [String: Any] = [:]
+
+    @Field
+    var microphoneEnabled: Bool = true
+}
+
+struct ScreencastOptions: Record {
+    @Field
+    var quality: String = "HD15"
+
+    @Field
+    var screencastMetadata: [String: Any] = [:]
+
+    @Field
+    var simulcastConfig: RNSimulcastConfig = RNSimulcastConfig()
+
+    @Field
+    var maxBandwidth: RNTrackBandwidthLimit = RNTrackBandwidthLimit(0)
+}
+
+struct ReconnectConfig: Record {
+    @Field
+    var maxAttempts: Int = 5
+
+    @Field
+    var initialDelayMs: Int = 1000
+
+    @Field
+    var delayMs: Int = 1000
+}
+
+struct ConnectConfig: Record {
+    @Field
+    var reconnectConfig: ReconnectConfig = ReconnectConfig()
+}
+
+typealias RNTrackBandwidthLimit = Either<Int, [String: Int]>
+
+public class RNFishjamClientModule: Module {
+    public func definition() -> ModuleDefinition {
+        Name("RNFishjamClient")
+
+        Events(
+            "IsCameraOn",
+            "IsMicrophoneOn",
+            "IsScreencastOn",
+            "SimulcastConfigUpdate",
+            "PeersUpdate",
+            "AudioDeviceUpdate",
+            "SendMediaEvent",
+            "BandwidthEstimation",
+            "ReconnectionRetriesLimitReached",
+            "ReconnectionStarted",
+            "Reconnected")
+
+        let rnFishjamClient: RNFishjamClient = {
+            let client = RNFishjamClient {
+                (eventName: String, data: [String: Any]) in
+                self.sendEvent(eventName, data)
+            }
+            client.create()
+            return client
+        }()
+
+        AsyncFunction("connect") {
+            (url: String, peerToken: String, peerMetadata: [String: Any], config: ConnectConfig, promise: Promise) in
+            rnFishjamClient.connect(
+                url: url, peerToken: peerToken, peerMetadata: peerMetadata, config: config, promise: promise)
+        }
+
+        AsyncFunction("leaveRoom") {
+            rnFishjamClient.leaveRoom()
+        }
+
+        AsyncFunction("startCamera") { (config: CameraConfig) in
+            try rnFishjamClient.startCamera(config: config)
+        }
+
+        Property("isMicrophoneOn") {
+            return rnFishjamClient.isMicrophoneOn
+        }
+
+        AsyncFunction("toggleMicrophone") {
+            try rnFishjamClient.toggleMicrophone()
+        }
+
+        Property("isCameraOn") {
+            return rnFishjamClient.isCameraOn
+        }
+
+        AsyncFunction("toggleCamera") {
+            try rnFishjamClient.toggleCamera()
+        }
+
+        AsyncFunction("flipCamera") {
+            try rnFishjamClient.flipCamera()
+        }
+
+        AsyncFunction("switchCamera") { (captureDeviceId: String) in
+            try rnFishjamClient.switchCamera(captureDeviceId: captureDeviceId)
+        }
+
+        AsyncFunction("getCaptureDevices") {
+            rnFishjamClient.getCaptureDevices()
+        }
+
+        AsyncFunction("toggleScreencast") { (screencastOptions: ScreencastOptions) in
+            try rnFishjamClient.toggleScreencast(screencastOptions: screencastOptions)
+        }
+
+        Property("isScreencastOn") {
+            return rnFishjamClient.isScreencastOn
+        }
+
+        AsyncFunction("getPeers") {
+            try rnFishjamClient.getPeers()
+        }
+
+        AsyncFunction("updatePeerMetadata") { (metadata: [String: Any]) in
+            try rnFishjamClient.updatePeerMetadata(metadata: metadata)
+        }
+
+        AsyncFunction("updateVideoTrackMetadata") { (metadata: [String: Any]) in
+            try rnFishjamClient.updateLocalVideoTrackMetadata(metadata: metadata)
+        }
+
+        AsyncFunction("updateAudioTrackMetadata") { (metadata: [String: Any]) in
+            try rnFishjamClient.updateLocalAudioTrackMetadata(metadata: metadata)
+        }
+
+        AsyncFunction("updateScreencastTrackMetadata") { (metadata: [String: Any]) in
+            try rnFishjamClient.updateLocalScreencastTrackMetadata(metadata: metadata)
+        }
+
+        AsyncFunction("toggleScreencastTrackEncoding") { (encoding: String) in
+            try rnFishjamClient.toggleScreencastTrackEncoding(encoding: encoding)
+        }
+
+        AsyncFunction("setScreencastTrackBandwidth") { (bandwidth: Int) in
+            try rnFishjamClient.setScreencastTrackBandwidth(bandwidth: bandwidth)
+        }
+
+        AsyncFunction("setScreencastTrackEncodingBandwidth") { (encoding: String, bandwidth: Int) in
+            try rnFishjamClient.setScreencastTrackEncodingBandwidth(
+                encoding: encoding, bandwidth: bandwidth)
+        }
+
+        AsyncFunction("setTargetTrackEncoding") { (trackId: String, encoding: String) in
+            try rnFishjamClient.setTargetTrackEncoding(trackId: trackId, encoding: encoding)
+        }
+
+        AsyncFunction("toggleVideoTrackEncoding") { (encoding: String) in
+            try rnFishjamClient.toggleVideoTrackEncoding(encoding: encoding)
+        }
+
+        AsyncFunction("setVideoTrackEncodingBandwidth") { (encoding: String, bandwidth: Int) in
+            try rnFishjamClient.setVideoTrackEncodingBandwidth(
+                encoding: encoding, bandwidth: bandwidth)
+        }
+
+        AsyncFunction("setVideoTrackBandwidth") { (bandwidth: Int) in
+            try rnFishjamClient.setVideoTrackBandwidth(bandwidth: bandwidth)
+        }
+
+        AsyncFunction("changeWebRTCLoggingSeverity") { (severity: String) in
+            try rnFishjamClient.changeWebRTCLoggingSeverity(severity: severity)
+        }
+
+        AsyncFunction("getStatistics") {
+            try rnFishjamClient.getStatistics()
+        }
+
+        AsyncFunction("selectAudioSessionMode") { (sessionMode: String) in
+            try rnFishjamClient.selectAudioSessionMode(sessionMode: sessionMode)
+        }
+
+        AsyncFunction("showAudioRoutePicker") {
+            rnFishjamClient.showAudioRoutePicker()
+        }
+
+        AsyncFunction("startAudioSwitcher") {
+            rnFishjamClient.startAudioSwitcher()
+        }
+    }
+}

package/ios/Utils.swift

@@ -0,0 +1,43 @@
+import FishjamCloudClient
+import ReplayKit
+import os.log
+
+let log = OSLog(subsystem: "com.fishjamcloud.react-native-client", category: "ErrorHandling")
+
+#if os(iOS)
+    @available(iOS 12, *)
+    extension RPSystemBroadcastPickerView {
+        public static func show(
+            for preferredExtension: String? = nil, showsMicrophoneButton: Bool = false
+        ) {
+            let view = RPSystemBroadcastPickerView()
+            view.preferredExtension = preferredExtension
+            view.showsMicrophoneButton = showsMicrophoneButton
+
+            let selector = NSSelectorFromString("buttonPressed:")
+            if view.responds(to: selector) {
+                view.perform(selector, with: nil)
+            }
+        }
+    }
+#endif
+
+extension [String: Any] {
+    public func toMetadata() -> Metadata {
+        var res: Metadata = .init()
+        self.forEach { entry in
+            res[entry.key] = entry.value
+        }
+        return res
+    }
+}
+
+extension AnyJson {
+    public func toDict() -> [String: Any] {
+        var res: [String: Any] = [:]
+        self.keys.forEach { key in
+            res[key] = self[key]
+        }
+        return res
+    }
+}

package/ios/VideoPreviewView.swift

@@ -0,0 +1,64 @@
+import ExpoModulesCore
+import FishjamCloudClient
+
+class VideoPreviewView: ExpoView {
+    var videoView: VideoView? = nil
+    private var localVideoTrack: LocalVideoTrack? = nil
+
+    required init(appContext: AppContext? = nil) {
+        super.init(appContext: appContext)
+        videoView = VideoView()
+        videoView?.autoresizingMask = [.flexibleWidth, .flexibleHeight]
+        videoView?.clipsToBounds = true
+        addSubview(videoView!)
+    }
+
+    override func willMove(toSuperview newSuperview: UIView?) {
+        super.willMove(toSuperview: newSuperview)
+        if newSuperview == nil {
+            localVideoTrack?.stop()
+        } else {
+            guard let tracks = RNFishjamClient.fishjamClient?.getLocalEndpoint().tracks else {
+                os_log(
+                    "Error moving VideoPreviewView: %{public}s", log: log, type: .error,
+                    String(describing: "No tracks available")
+                )
+                return
+            }
+
+            localVideoTrack =
+                tracks.first(where: { (key, track) in
+                    track is LocalVideoTrack
+                })?.value as? LocalVideoTrack
+            localVideoTrack?.start()
+            videoView?.track = localVideoTrack
+        }
+    }
+
+    var videoLayout: String = "FILL" {
+        didSet {
+            switch videoLayout {
+            case "FIT":
+                self.videoView?.layout = .fit
+            case "FILL":
+                self.videoView?.layout = .fill
+            default:
+                self.videoView?.layout = .fill
+            }
+        }
+    }
+
+    var mirrorVideo: Bool = false {
+        didSet {
+            self.videoView?.mirror = mirrorVideo
+        }
+    }
+
+    var captureDeviceId: String? = nil {
+        didSet {
+            if let captureDeviceId = captureDeviceId {
+                localVideoTrack?.switchCamera(deviceId: captureDeviceId)
+            }
+        }
+    }
+}

package/ios/VideoPreviewViewModule.swift

@@ -0,0 +1,21 @@
+import ExpoModulesCore
+
+public class VideoPreviewViewModule: Module {
+    public func definition() -> ModuleDefinition {
+        Name("VideoPreviewViewModule")
+
+        View(VideoPreviewView.self) {
+            Prop("captureDeviceId") { (view: VideoPreviewView, prop: String) in
+                view.captureDeviceId = prop
+            }
+
+            Prop("mirrorVideo") { (view: VideoPreviewView, prop: Bool) in
+                view.mirrorVideo = prop
+            }
+
+            Prop("videoLayout") { (view: VideoPreviewView, prop: String) in
+                view.videoLayout = prop
+            }
+        }
+    }
+}

package/ios/VideoRendererView.swift

@@ -0,0 +1,84 @@
+import Combine
+import ExpoModulesCore
+import FishjamCloudClient
+
+protocol OnTrackUpdateListener {
+    func onTrackUpdate()
+}
+
+class VideoRendererView: ExpoView, OnTrackUpdateListener {
+    var videoView: VideoView? = nil
+    var cancellableEndpoints: Cancellable? = nil
+
+    required init(appContext: AppContext? = nil) {
+        super.init(appContext: appContext)
+        RNFishjamClient.onTracksUpdateListeners.append(self)
+        videoView = VideoView()
+        videoView?.autoresizingMask = [.flexibleWidth, .flexibleHeight]
+        videoView?.clipsToBounds = true
+        addSubview(videoView!)
+    }
+
+    deinit {
+        RNFishjamClient.onTracksUpdateListeners.removeAll(where: {
+            if let view = $0 as? VideoRendererView {
+                return view === self
+            }
+            return false
+        })
+    }
+
+    override func willMove(toSuperview newSuperview: UIView?) {
+        super.willMove(toSuperview: newSuperview)
+
+        if newSuperview != nil {
+            updateVideoTrack()
+        }
+    }
+
+    func updateVideoTrack() {
+        DispatchQueue.main.async {
+            if self.superview != nil {
+                for endpoint in RNFishjamClient.getLocalAndRemoteEndpoints() {
+                    if let track = endpoint.tracks[self.trackId] as? VideoTrack {
+                        if let track = track as? LocalVideoTrack {
+                            self.mirrorVideo = track.isFrontCamera
+                        }
+                        self.videoView?.track = track
+                        return
+                    }
+                }
+            }
+        }
+    }
+
+    func onTrackUpdate() {
+        updateVideoTrack()
+    }
+
+    var trackId: String = "" {
+        didSet {
+            updateVideoTrack()
+        }
+    }
+
+    var videoLayout: String = "FILL" {
+        didSet {
+            switch videoLayout {
+            case "FIT":
+                self.videoView?.layout = .fit
+            case "FILL":
+                self.videoView?.layout = .fill
+            default:
+                self.videoView?.layout = .fill
+            }
+
+        }
+    }
+
+    var mirrorVideo: Bool = false {
+        didSet {
+            self.videoView?.mirror = mirrorVideo
+        }
+    }
+}

package/ios/VideoRendererViewModule.swift

@@ -0,0 +1,17 @@
+import ExpoModulesCore
+
+public class VideoRendererViewModule: Module {
+    public func definition() -> ModuleDefinition {
+        Name("VideoRendererViewModule")
+
+        View(VideoRendererView.self) {
+            Prop("trackId") { (view: VideoRendererView, prop: String) in
+                view.trackId = prop
+            }
+
+            Prop("videoLayout") { (view: VideoRendererView, prop: String) in
+                view.videoLayout = prop
+            }
+        }
+    }
+}

package/ios/swift-format-config.json

@@ -0,0 +1,56 @@
+{
+  "fileScopedDeclarationPrivacy": {
+    "accessLevel": "private"
+  },
+  "indentation": {
+    "spaces": 4
+  },
+  "indentConditionalCompilationBlocks": true,
+  "indentSwitchCaseLabels": false,
+  "lineBreakAroundMultilineExpressionChainComponents": false,
+  "lineBreakBeforeControlFlowKeywords": false,
+  "lineBreakBeforeEachArgument": false,
+  "lineBreakBeforeEachGenericRequirement": false,
+  "lineLength": 120,
+  "maximumBlankLines": 1,
+  "prioritizeKeepingFunctionOutputTogether": false,
+  "respectsExistingLineBreaks": true,
+  "rules": {
+    "AllPublicDeclarationsHaveDocumentation": false,
+    "AlwaysUseLowerCamelCase": false,
+    "AmbiguousTrailingClosureOverload": true,
+    "BeginDocumentationCommentWithOneLineSummary": false,
+    "DoNotUseSemicolons": true,
+    "DontRepeatTypeInStaticProperties": true,
+    "FileScopedDeclarationPrivacy": true,
+    "FullyIndirectEnum": true,
+    "GroupNumericLiterals": true,
+    "IdentifiersMustBeASCII": true,
+    "NeverForceUnwrap": false,
+    "NeverUseForceTry": false,
+    "NeverUseImplicitlyUnwrappedOptionals": false,
+    "NoAccessLevelOnExtensionDeclaration": true,
+    "NoBlockComments": false,
+    "NoCasesWithOnlyFallthrough": true,
+    "NoEmptyTrailingClosureParentheses": true,
+    "NoLabelsInCasePatterns": true,
+    "NoLeadingUnderscores": false,
+    "NoParensAroundConditions": true,
+    "NoVoidReturnOnFunctionSignature": true,
+    "OneCasePerLine": true,
+    "OneVariableDeclarationPerLine": true,
+    "OnlyOneTrailingClosureArgument": false,
+    "OrderedImports": true,
+    "ReturnVoidInsteadOfEmptyTuple": true,
+    "UseEarlyExits": false,
+    "UseLetInEveryBoundCaseVariable": true,
+    "UseShorthandTypeNames": true,
+    "UseSingleLinePropertyGetter": true,
+    "UseSynthesizedInitializer": true,
+    "UseTripleSlashForDocumentationComments": false,
+    "UseWhereClausesInForLoops": false,
+    "ValidateDocumentationComments": false
+  },
+  "tabWidth": 8,
+  "version": 1
+}

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@fishjam-cloud/react-native-client",
+  "version": "0.1.0",
+  "description": "A React Native client for Fishjam Cloud",
+  "author": "Fishjam Cloud Team",
+  "license": "Apache-2.0",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "scripts": {
+    "build": "expo-module build",
+    "clean": "expo-module clean",
+    "lint": "sh ./scripts/lint.sh",
+    "lint:check": "sh ./scripts/lint_check.sh",
+    "test": "expo-module test",
+    "prepare": "expo-module prepare",
+    "prepublishOnly": "expo-module prepublishOnly",
+    "expo-module": "expo-module",
+    "release": "release-it",
+    "releaseAppAndroid": "cd examples/video-chat/android && fastlane deploy",
+    "releaseAppIos": "cd example/ios && fastlane deploy",
+    "docs": "sed 's/\\.github\\/images/media/g' README.md > README_docs.md && typedoc src/index.tsx --media ./.github/images --readme README_docs.md && rm README_docs.md",
+    "typecheck": "yarn tsc --noEmit && cd example && yarn tsc --noEmit"
+  },
+  "keywords": [
+    "react-native",
+    "expo",
+    "@fishjam-cloud/react-native-client",
+    "fishjam-cloud",
+    "MembraneWebRTC",
+    "fishjam"
+  ],
+  "repository": "https://github.com/fishjam-cloud/mobile-client-sdk",
+  "bugs": {
+    "url": "https://github.com/fishjam-cloud/mobile-client-sdk/issues"
+  },
+  "homepage": "https://github.com/fishjam-cloud/mobile-client-sdk#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "dependencies": {
+    "phoenix": "^1.7.6",
+    "promise-fs": "^2.1.1",
+    "protobufjs": "^7.4.0"
+  },
+  "devDependencies": {
+    "@testing-library/react": "^15.0.7",
+    "@types/lodash": "^4.17.7",
+    "@types/phoenix": "^1.6.5",
+    "@types/promise-fs": "^2.1.2",
+    "@types/react": "^18.3.5",
+    "expo": "^50.0.20",
+    "expo-module-scripts": "^3.0.4",
+    "expo-modules-core": "~1.11.8",
+    "husky": "^9.1.5",
+    "jest": "^29.6.1",
+    "jest-environment-jsdom": "^29.6.1",
+    "jest-expo": "^50.0.2",
+    "jest-websocket-mock": "^2.4.0",
+    "lint-staged": "^15.2.10",
+    "pod-install": "^0.2.0",
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
+    "react-native": "0.73.4",
+    "release-it": "^17.6.0",
+    "ts-proto": "^2.1.0",
+    "typedoc": "^0.26.6",
+    "typedoc-plugin-mark-react-functional-components": "^0.2.2",
+    "typescript": "^5.5.4"
+  },
+  "peerDependencies": {
+    "expo": "*",
+    "react": "*",
+    "react-native": "*"
+  },
+  "jest": {
+    "preset": "jest-expo",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ],
+    "testEnvironment": "jsdom"
+  },
+  "lint-staged": {
+    "*.(js|ts|tsx)": [
+      "yarn lint:check"
+    ]
+  }
+}

package/plugin/broadcastExtensionFiles/Info.plist

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDisplayName</key>
+	<string>MembraneScreenBroadcast</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>$(PRODUCT_BUNDLE_PACKAGE_TYPE)</string>
+	<key>CFBundleVersion</key>
+	<string>$(CURRENT_PROJECT_VERSION)</string>
+	<key>NSExtension</key>
+	<dict>
+		<key>NSExtensionPointIdentifier</key>
+		<string>com.apple.broadcast-services-upload</string>
+		<key>NSExtensionPrincipalClass</key>
+		<string>$(PRODUCT_MODULE_NAME).MembraneBroadcastSampleHandler</string>
+		<key>RPBroadcastProcessMode</key>
+		<string>RPBroadcastProcessModeSampleBuffer</string>
+	</dict>
+</dict>
+</plist>

package/plugin/broadcastExtensionFiles/MembraneBroadcastSampleHandler.swift

@@ -0,0 +1,50 @@
+import FishjamClient
+import Foundation
+import ReplayKit
+import WebRTC
+import os.log
+
+/// 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)
+    }
+}

package/plugin/broadcastExtensionFiles/MembraneScreenBroadcastExtension.entitlements

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>com.apple.security.application-groups</key>
+	<array>
+		<string>{{GROUP_IDENTIFIER}}</string>
+	</array>
+</dict>
+</plist>