Update documentation adding the new mobile sdk #217

anna1901 · 2026-01-14T13:40:53Z

Description

Update documentation adding the new mobile sdk. Since the new mobile sdk is based on the web sdk, How-to-guides for mobile and web were joined together.

Copilot

Pull request overview

This PR updates the documentation to integrate the new mobile SDK (@fishjam-cloud/mobile-client) which is now based on the web SDK. The documentation for web (React) and mobile (React Native) platforms has been consolidated into unified how-to guides under a new client/ directory.

Changes:

Migrated from @fishjam-cloud/react-native-client to @fishjam-cloud/mobile-client
Consolidated web and mobile documentation into unified guides with platform-specific sections
Added CSS badge styles to distinguish between web-only and mobile-only features
Updated all code examples and API references to use the new SDK

Reviewed changes

Copilot reviewed 52 out of 53 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
package.json	Updated dependency from react-native-client to mobile-client
yarn.lock	Added mobile-client package link
docusaurus.config.ts	Updated TypeDoc entry points for mobile API
scripts/prepare.sh	Changed build path for mobile client
.gitmodules	Updated web-client-sdk branch reference
src/css/custom.css	Added platform badge styles for documentation
docs/tutorials/*.mdx	Updated quick-start guides with new SDK examples
docs/how-to/client/*.mdx	New unified guides with platform tabs
docs/how-to/react/*.mdx	Removed (consolidated into client/)
docs/how-to/react-native/*.mdx	Removed (consolidated into client/)
docs/index.mdx	Updated links to new unified documentation
docs/how-to/features/*.mdx	Updated SDK import references
docs/how-to/backend/server-setup.mdx	Updated metadata documentation link
docs/explanation/public-livestreams.mdx	Updated code examples for new SDK

Comments suppressed due to low confidence (1)

docs/how-to/client/picture-in-picture.mdx:184

The code uses type assertions with as any which bypasses TypeScript's type checking. This pattern is repeated multiple times (lines 183, 184, 328, 329). Consider defining proper types for the ref or providing a more type-safe solution in the documentation examples.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-20T13:40:56Z

docs/how-to/client/list-other-peers.mdx

+          <VideoRenderer stream={cameraTrack?.stream} /> // remember to import
+          your VideoRenderer component


The inline comments in the JSX code use double slashes "//" instead of the proper JSX comment syntax {/* ... */}. This will cause a syntax error. The comments on lines 36-37 should use JSX comment syntax.

Suggested change

<VideoRenderer stream={cameraTrack?.stream} /> // remember to import

your VideoRenderer component

<VideoRenderer stream={cameraTrack?.stream} /> {/* remember to import your VideoRenderer component */}

Copilot · 2026-01-20T13:40:56Z

docs/how-to/client/background-streaming.mdx

+} from "@fishjam-cloud/mobile-client";
+
+const { isCameraOn } = useCamera();
+const { isMicrophoneOn } = useMicrophone();
+
+


The code example for Android usage is incomplete. It imports hooks and retrieves camera/microphone state but doesn't show how to actually use useForegroundService. The example should demonstrate calling the hook with configuration options.

Suggested change

} from "@fishjam-cloud/mobile-client";

const { isCameraOn } = useCamera();

const { isMicrophoneOn } = useMicrophone();

useForegroundService,

} from "@fishjam-cloud/mobile-client";

export function CallScreen() {

const { isCameraOn } = useCamera();

const { isMicrophoneOn } = useMicrophone();

const { startForegroundService, stopForegroundService } = useForegroundService({

enableCamera: isCameraOn,

enableMicrophone: isMicrophoneOn,

notification: {

title: "Ongoing call",

text: "Your call is active",

},

});

// Call this when the call starts (e.g. after joining a room)

const handleCallStart = () => {

startForegroundService();

};

// Call this when the call ends (e.g. before leaving a room)

const handleCallEnd = () => {

stopForegroundService();

};

// Render your call UI here and wire handleCallStart/handleCallEnd

return null;

}

Copilot · 2026-01-20T13:40:57Z

docs/tutorials/react-native-quick-start.mdx

+```xml title='AndroidManifest.xml'
+<uses-permission android:name="android.permission.CAMERA"/>
+<uses-permission android:name="android.permission.RECORD_AUDIO"/>
+<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTING"/>


There's a typo in the permission name. It should be "MODIFY_AUDIO_SETTINGS" (with an 'S' at the end), not "MODIFY_AUDIO_SETTING".

Copilot · 2026-01-20T13:40:57Z

docs/how-to/client/installation.mdx

+  ...
+  <uses-permission android:name="android.permission.CAMERA"/>
+  <uses-permission android:name="android.permission.RECORD_AUDIO"/>
+  <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTING"/>


There's a typo in the permission name. It should be "MODIFY_AUDIO_SETTINGS" (with an 'S' at the end), not "MODIFY_AUDIO_SETTING".

Suggested change

<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTING"/>

<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS"/>

Copilot · 2026-01-20T13:40:57Z

docs/tutorials/react-native-quick-start.mdx

+//TODO: FCE-2487 remove it when MediaStream will be updated
+interface MediaStreamWithURL extends MediaStream {
+  toURL(): string;


The TODO comment references ticket "FCE-2487" about removing the MediaStreamWithURL interface once MediaStream is updated. This TODO appears in multiple locations throughout the documentation. Consider whether this should remain in the public-facing documentation or if it should be handled differently (e.g., via internal tracking).

Copilot · 2026-01-20T13:40:57Z

docs/tutorials/react-native-quick-start.mdx

-    // Prepare camera
-    await prepareCamera({ cameraEnabled: true });
+    // Start camera by selecting the first available camera
+    await initializeDevices({ enableAudio: false }); // or just initializeDevices(); if you want both camera and mic


The comment says "or just initializeDevices();" but this suggests calling the function without await, which could lead to issues since it's an async operation. The comment should either use await initializeDevices() or clarify the async behavior.

Copilot · 2026-01-20T13:40:58Z

docs/how-to/client/start-streaming.mdx

+          </option>
+        ))}
+      </select>
+      {cameraStream && <video ref={videoRef} autoPlay />} // [!code highlight]


The inline comment uses double slashes "//" instead of the JSX comment syntax. In JSX/TSX, comments should use {/* ... */} syntax. This appears on multiple lines in the file.

Suggested change

{cameraStream && <video ref={videoRef} autoPlay />} // [!code highlight]

{cameraStream && <video ref={videoRef} autoPlay />} {/* [!code highlight] */}

anna1901 added 7 commits January 12, 2026 17:19

Add new mobile package

8041a9b

wip

a90b941

building version

03fdef9

Merge mobile and web docs together

3425c7b

Adjust tabs positions and add note about platform exclusivity

0f628c3

Remove custom video sources information for mobile

e4ef8ec

Update react-native-quick-start.mdx

f42b7ab

MiloszFilimowski requested a review from Copilot January 20, 2026 13:37

Copilot started reviewing on behalf of MiloszFilimowski January 20, 2026 13:38 View session

Copilot AI reviewed Jan 20, 2026

View reviewed changes

bump web-client

787c70a

MiloszFilimowski force-pushed the new-mobile-package branch from 08ef0c6 to 787c70a Compare January 20, 2026 16:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update documentation adding the new mobile sdk #217

Update documentation adding the new mobile sdk #217

anna1901 commented Jan 14, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 20, 2026

Uh oh!

Copilot AI Jan 20, 2026

Uh oh!

Copilot AI Jan 20, 2026

Uh oh!

Copilot AI Jan 20, 2026

Uh oh!

Copilot AI Jan 20, 2026

Uh oh!

Copilot AI Jan 20, 2026

Uh oh!

Copilot AI Jan 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		<VideoRenderer stream={cameraTrack?.stream} /> // remember to import
		your VideoRenderer component

-} from "@fishjam-cloud/mobile-client";
-const { isCameraOn } = useCamera();
-const { isMicrophoneOn } = useMicrophone();
+  useForegroundService,
+} from "@fishjam-cloud/mobile-client";
+export function CallScreen() {
+  const { isCameraOn } = useCamera();
+  const { isMicrophoneOn } = useMicrophone();
+  const { startForegroundService, stopForegroundService } = useForegroundService({
+    enableCamera: isCameraOn,
+    enableMicrophone: isMicrophoneOn,
+    notification: {
+      title: "Ongoing call",
+      text: "Your call is active",
+    },
+  });
+  // Call this when the call starts (e.g. after joining a room)
+  const handleCallStart = () => {
+    startForegroundService();
+  };
+  // Call this when the call ends (e.g. before leaving a room)
+  const handleCallEnd = () => {
+    stopForegroundService();
+  };
+  // Render your call UI here and wire handleCallStart/handleCallEnd
+  return null;
+}

	<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTING"/>
	<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS"/>

	{cameraStream && <video ref={videoRef} autoPlay />} // [!code highlight]
	{cameraStream && <video ref={videoRef} autoPlay />} {/* [!code highlight] */}

Update documentation adding the new mobile sdk #217

Are you sure you want to change the base?

Update documentation adding the new mobile sdk #217

Conversation

anna1901 commented Jan 14, 2026

Description

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants