@cometchat/skills 4.2.1 → 4.4.0

package/skills/cometchat-native-calls/references/recording-screen-share.md

@@ -15,30 +15,30 @@ Recording is a paid feature on most CometChat plans. Enable in **Dashboard → C
 ```ts
 import { CometChatCalls } from "@cometchat/calls-sdk-react-native";
 
-const settings = new CometChatCalls.CallSettingsBuilder()
-  .setSessionID(sessionId)
-  .setIsAudioOnly(false)
-  .enableRecording(true)              // server starts recording when session begins
-  .setShowRecordingButton(true)       // user can toggle mid-call (with kit's default UI)
-  .build();
+// Audio vs video + recording are SessionSettings OBJECT fields (v5), not builder methods.
+// enableRecording()/setShowRecordingButton() do not exist on the v5 RN SDK.
+const sessionSettings = {
+  sessionType: "VIDEO",       // "VIDEO" | "AUDIO" — replaces the v4 setIsAudioOnlyCall builder
+  autoStartRecording: true,   // server starts recording when the session begins
+  hideRecordingButton: false, // show the in-call recording toggle (kit's default UI)
+};
 ```
 
 ### Recording lifecycle events
 
+`CometChatCalls.OngoingCallListener` is still re-exported but is the v4-era path — **@deprecated, prefer `CometChatCalls.addEventListener(...)`** (which returns an unsubscribe fn). Only `onRecordingStarted` / `onRecordingStopped` exist; there is no `onRecordingFailed`.
+
 ```ts
-const listener = new CometChatCalls.OngoingCallListener({
-  onRecordingStarted: () => {
-    // Update UI — show a "REC" indicator (compliance requirement in some jurisdictions)
-    setRecording(true);
-  },
-  onRecordingStopped: () => {
-    setRecording(false);
-  },
-  onRecordingFailed: (error) => {
-    // Surface to UI — usually plan limits or storage quota
-    Alert.alert("Recording failed", error.message);
-  },
+// Preferred (v5): addEventListener returns the unsubscribe fn.
+const offStarted = CometChatCalls.addEventListener("onRecordingStarted", () => {
+  // Update UI — show a "REC" indicator (compliance requirement in some jurisdictions)
+  setRecording(true);
+});
+const offStopped = CometChatCalls.addEventListener("onRecordingStopped", () => {
+  setRecording(false);
 });
+// cleanup: offStarted(); offStopped();
+// NOTE: there is no onRecordingFailed event in the v5 RN SDK — do not listen for it.
 ```
 
 ### REC indicator (compliance)
@@ -77,101 +77,27 @@ The skill points users at this REST endpoint; it doesn't generate client code (r
 
 ## Screen sharing
 
-Screen capture on RN is platform-specific. iOS uses an iOS Broadcast Extension (separate target); Android uses MediaProjection. Both are exposed by `react-native-webrtc` ≥ 119, which is a peer of the Calls SDK.
-
-### Presenter — start sharing
-
-```ts
-import { CometChatCalls } from "@cometchat/calls-sdk-react-native";
-
-async function startScreenShare() {
-  try {
-    await CometChatCalls.startScreenShare();
-  } catch (err) {
-    if ((err as Error).message.includes("permission")) {
-      Alert.alert("Screen recording permission denied");
-      return;
-    }
-    Alert.alert("Couldn't start screen share");
-  }
-}
-
-async function endScreenShare() {
-  await CometChatCalls.endScreenShare();
-}
-```
-
-### iOS — Broadcast Extension target setup
-
-iOS screen capture requires a separate target in Xcode (a "Broadcast Upload Extension"). The skill walks the user through this manual setup:
-
-1. Xcode → File → New → Target → **Broadcast Upload Extension**
-2. Name: `YourAppBroadcastExtension`
-3. Bundle ID: `com.yourapp.YourAppBroadcastExtension`
-4. Group: `group.com.yourapp.broadcast` (App Group — both targets must opt into this)
-5. Add the App Group capability to BOTH the main target AND the extension
-6. Replace the extension's `SampleHandler.swift` with the WebRTC bridge stub `react-native-webrtc` provides
-7. Add `RPSystemBroadcastPickerView` to your call screen so the user can start/stop sharing via the system UI
-
-The Broadcast Extension picker UI:
-
-```tsx
-// CallScreen.tsx
-import { Platform, requireNativeComponent } from "react-native";
-
-const BroadcastPickerView = Platform.OS === "ios"
-  ? requireNativeComponent<{ preferredExtension: string }>("RPSystemBroadcastPickerView")
-  : null;
-
-export function CallScreen() {
-  return (
-    <View>
-      {/* ... call UI ... */}
-      {Platform.OS === "ios" && BroadcastPickerView && (
-        <BroadcastPickerView preferredExtension="com.yourapp.YourAppBroadcastExtension" />
-      )}
-    </View>
-  );
-}
-```
+**Initiating a screen share from React Native is NOT supported.** Per the docs (`docs/calls/react-native/screen-sharing.mdx`): RN devices can only **view** screen shares started by participants on other platforms (web/desktop). There is no `startScreenSharing()` / `stopScreenSharing()` / `CometChatCalls.startScreenShare()` API on RN, no iOS Broadcast Extension flow, and no Android MediaProjection flow exposed by this SDK. Do not write screen-share-initiation code for RN.
 
-The picker renders as a small system-styled button. iOS doesn't allow custom UI for screen-share initiation — must use this picker.
+### Viewer — receive / view a screen share
 
-### Android — MediaProjection setup
+When a participant shares their screen from another platform, the kit's default `CometChatOngoingCall` UI auto-renders the screen-share tile (it switches to Sidebar layout automatically). Listen for screen-share events only to drive custom UI.
 
-Android is simpler. Add the permission to `AndroidManifest.xml`:
-
-```xml
-<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
-<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" />   <!-- Android 14+ -->
-```
-
-The screen-share service needs `foregroundServiceType="mediaProjection"`:
-
-```xml
-<service
-  android:name="com.cometchat.calls.ScreenShareService"
-  android:foregroundServiceType="mediaProjection"
-  android:exported="false" />
-```
-
-`react-native-webrtc` registers this internally; verify it's in the merged manifest.
-
-The MediaProjection consent prompt is system-rendered — when `startScreenShare()` is called, Android shows "Start recording or casting with YourApp?". User accepts → screen share begins.
-
-### Viewer — receive screen share
+Two receive-path event channels exist (verified against the calls-sdk-react-native clone `skills/event-listeners/SKILL.md`):
 
 ```ts
-const listener = new CometChatCalls.OngoingCallListener({
-  onScreenShareStarted: (presenterUid: string) => {
-    // The kit's default UI auto-renders the screen-share tile.
-    // Custom UI: query the SDK for the screen-share track and pipe into <RTCView />
-    setScreenSharePresenter(presenterUid);
-  },
-  onScreenShareEnded: () => {
-    setScreenSharePresenter(null);
-  },
+// Participant events — fire with the remote participant who shared:
+const offStart = CometChatCalls.addEventListener("onParticipantStartedScreenShare", (participant) => {
+  setScreenSharePresenter(participant.name);
+});
+const offStop = CometChatCalls.addEventListener("onParticipantStoppedScreenShare", () => {
+  setScreenSharePresenter(null);
 });
+// cleanup: offStart(); offStop();
+
+// Media-event channel (received from a web participant), no payload:
+CometChatCalls.addEventListener("onScreenShareStarted", () => { /* show screen-share tile */ });
+CometChatCalls.addEventListener("onScreenShareStopped", () => { /* restore prior layout */ });
 ```
 
 Custom-UI viewer composition:
@@ -197,61 +123,21 @@ When someone shares their screen, switch the layout to "screen share + participa
 
 ---
 
-## Combining recording + screen-share
-
-Server-side recording captures whatever video composition the SFU is forwarding. When a participant is screen-sharing, the recording shows their screen. When they stop, it switches back to the camera composition.
-
-You don't compose this client-side — the server handles it. Custom UI just needs to render the screen-share track when present.
-
----
-
-## iOS App Group setup (Broadcast Extension data passing)
-
-The iOS Broadcast Extension runs in a separate process from your main app. To share state (the call's session ID, auth context, etc.):
-
-```
-Both targets in Xcode:
-  Signing & Capabilities → + Capability → App Groups
-  Add: group.com.yourapp.broadcast
-```
-
-In the main app, write to the shared group container:
-
-```swift
-// AppDelegate or CometChat init code (RN bridges this)
-let userDefaults = UserDefaults(suiteName: "group.com.yourapp.broadcast")
-userDefaults?.set(currentSessionID, forKey: "cometchat.sessionID")
-userDefaults?.set(currentAuthToken, forKey: "cometchat.authToken")
-```
+## Recording + screen-share together
 
-In the Broadcast Extension (`SampleHandler.swift`):
-
-```swift
-override func broadcastStarted(withSetupInfo setupInfo: [String : NSObject]?) {
-  let userDefaults = UserDefaults(suiteName: "group.com.yourapp.broadcast")
-  guard let sessionID = userDefaults?.string(forKey: "cometchat.sessionID"),
-        let authToken = userDefaults?.string(forKey: "cometchat.authToken") else {
-    finishBroadcastWithError(NSError(domain: "CometChat", code: 1, userInfo: nil))
-    return
-  }
-  // Initialize the WebRTC bridge with these credentials
-  // (react-native-webrtc handles the heavy lifting)
-}
-```
+Server-side recording captures whatever video composition the SFU is forwarding. When a (web/desktop) participant is screen-sharing, the recording shows their screen. When they stop, it switches back to the camera composition.
 
-Without the App Group, the extension can't see the main app's CometChat state — screen capture starts but can't deliver to the call session.
+You don't compose this client-side — the server handles it. Custom UI just needs to render the screen-share track when present (receive path).
 
 ---
 
 ## Anti-patterns
 
-1. **iOS without Broadcast Extension** target. Compiles and runs, but `startScreenShare()` returns a "no broadcast extension found" error. Manual Xcode step is required.
-2. **Mismatched App Group identifiers** between targets. Extension can't read the session ID; screen share fails silently.
-3. **Android without `FOREGROUND_SERVICE_MEDIA_PROJECTION` permission** on Android 14+. Service starts → silent crash → screen share dies.
-4. **No "REC" indicator in custom UI.** Compliance violation in two-party-consent jurisdictions.
-5. **Trying to download recordings from the device.** They live on CometChat's servers. Use the dashboard or REST API.
-6. **`enableRecording(true)` without dashboard gate.** Client flag silently no-ops; user thinks recording is active when it isn't.
-7. **Not handling `onScreenShareEnded` in custom UI.** Layout doesn't switch back; viewer sees the last screen-share frame frozen.
+1. **Trying to INITIATE a screen share from RN.** Not supported — there is no `startScreenSharing()`, iOS Broadcast Extension flow, or Android MediaProjection flow on this SDK. RN can only view shares from other platforms.
+2. **No "REC" indicator in custom UI.** Compliance violation in two-party-consent jurisdictions.
+3. **Trying to download recordings from the device.** They live on CometChat's servers. Use the dashboard or REST API.
+4. **`autoStartRecording: true` without dashboard gate.** SessionSettings flag silently no-ops; user thinks recording is active when it isn't.
+5. **Not handling the screen-share-stopped event in custom UI.** Layout doesn't switch back; viewer sees the last screen-share frame frozen.
 
 ---
 
@@ -259,25 +145,18 @@ Without the App Group, the extension can't see the main app's CometChat state
 
 **Recording:**
 - [ ] Dashboard gate enabled (Recording feature on the plan)
-- [ ] `enableRecording(true)` on `CallSettingsBuilder`
-- [ ] `onRecordingStarted` / `onRecordingStopped` listeners wired
+- [ ] `autoStartRecording: true` in the SessionSettings object (NOT a builder method)
+- [ ] `onRecordingStarted` / `onRecordingStopped` listeners wired via `addEventListener`
 - [ ] "REC" indicator visible to all participants when active
-- [ ] `onRecordingFailed` surfaces to UI
 
-**Screen share:**
-- [ ] iOS: Broadcast Extension target created in Xcode
-- [ ] iOS: App Group capability on BOTH main + extension targets, matching identifiers
-- [ ] iOS: `RPSystemBroadcastPickerView` rendered in call screen
-- [ ] Android: `FOREGROUND_SERVICE_MEDIA_PROJECTION` permission in manifest
-- [ ] Android: ScreenShareService registered with `foregroundServiceType="mediaProjection"`
-- [ ] Custom UI: layout switches to screen-share view on `onScreenShareStarted`
-- [ ] Custom UI: layout switches back on `onScreenShareEnded`
+**Screen share (RN = VIEW-only; initiation not supported):**
+- [ ] Custom UI: layout switches to screen-share view on `onParticipantStartedScreenShare` / `onScreenShareStarted`
+- [ ] Custom UI: layout switches back on `onParticipantStoppedScreenShare` / `onScreenShareStopped`
 
 **Real-device smoke:**
-- [ ] iOS: tap broadcast picker → consent → screen share visible to other participants
-- [ ] Android: tap "Share screen" → MediaProjection prompt → screen share begins
-- [ ] Both: end screen share returns to camera view smoothly
-- [ ] Both: recording starts, "REC" shows, recording appears in dashboard within ~30 seconds
+- [ ] A web/desktop participant starts a screen share → it renders on the RN device
+- [ ] That participant stops sharing → RN view returns to camera composition smoothly
+- [ ] Recording starts, "REC" shows, recording appears in dashboard within ~30 seconds
 
 ---
 

package/skills/cometchat-native-calls/references/share-invite.md

@@ -39,14 +39,16 @@ Without these, share-invite URLs land in browser, not the app.
 ```ts
 import { CometChatCalls } from "@cometchat/calls-sdk-react-native";
 
-const callSettings = new CallSettingsBuilder()
-  .setHideShareInviteButton(false)
-  .build();
+// SessionSettings OBJECT field — there is NO setHideShareInviteButton builder method:
+const callSettings = {
+  hideShareInviteButton: false,
+};
 
 useEffect(() => {
   const handler = () => shareCallInvite(sessionId);
-  CometChatCalls.addEventListener("onShareInviteButtonClicked", handler);
-  return () => CometChatCalls.removeEventListener("onShareInviteButtonClicked", handler);
+  // addEventListener returns the unsubscribe fn — call it on cleanup.
+  const off = CometChatCalls.addEventListener("onShareInviteButtonClicked", handler);
+  return () => off();
 }, [sessionId]);
 ```
 

package/skills/cometchat-native-calls/references/voip-push-end-to-end.md

@@ -114,8 +114,10 @@ export function App() {
   // CallKit answer/end events — wire them to CometChat Calls SDK
   useEffect(() => {
     RNCallKeep.addEventListener("answerCall", async ({ callUUID }) => {
-      // sessionId === callUUID we passed to displayIncomingCall
-      await CometChatCalls.acceptCall(callUUID);
+      // sessionId === callUUID we passed to displayIncomingCall.
+      // Accept lives on the CHAT SDK (CometChat.acceptCall), NOT CometChatCalls —
+      // the Calls SDK has no acceptCall; calling it crashes at answer time.
+      await CometChat.acceptCall(callUUID);
       navigate("OngoingCall", { sessionId: callUUID });
     });