@cometchat/skills 4.4.2 → 5.0.0

package/skills/cometchat-android-v6-calls/references/advanced-features.md

@@ -1,87 +0,0 @@
-# Android V6 — advanced in-call features (Recording, PiP, Screen-share)
-
-These use the same `calls-sdk-android:5.x` the rest of V6 calls relies on (the W1 peer dep). Every symbol below is verified against the decompiled `calls-sdk-android` 5.x API. Works in both the Compose and Kotlin-Views surfaces — drive UI state from a ViewModel; the SDK calls are surface-agnostic.
-
-**Session handle:** `CallSession.getInstance()` returns the active `CallSession` singleton. Several controls also have static convenience methods directly on `CometChatCalls`.
-
----
-
-## 1. Recording
-
-Server-gated — recording must be enabled for the app in the CometChat dashboard first; otherwise the calls below no-op.
-
-```kotlin
-// Start / stop on demand (static convenience)
-CometChatCalls.startRecording()
-CometChatCalls.stopRecording()
-
-// …or on the active session
-CallSession.getInstance().startRecording()
-CallSession.getInstance().stopRecording()
-```
-
-**Auto-start + hide the default button** at session config time (both builders expose these):
-
-```kotlin
-val sessionSettings = CometChatCalls.SessionSettingsBuilder(activity)  // or no-arg SessionSettingsBuilder()
-    .enableAutoStartRecording(true)   // begin recording when the call connects
-    .hideRecordingButton(false)        // keep the kit's built-in record toggle (default UI)
-    .build()
-```
-
-**React to recording state** via `MediaEventsListener` (registered the same way as the other call event listeners in this skill):
-
-```kotlin
-object : MediaEventsListener() {
-    override fun onRecordingStarted() { /* show REC indicator */ }
-    override fun onRecordingStopped() { /* hide REC indicator */ }
-}
-```
-
-Verified: `CometChatCalls.startRecording()/stopRecording()` (static + `CallSession` instance), `SessionSettingsBuilder.enableAutoStartRecording(boolean)` + `hideRecordingButton(boolean)` (NOTE: `CallSettingsBuilder` is the deprecated v4 name, replaced by `SessionSettingsBuilder` in calls-sdk v5 — it no longer exists on android-v6), `MediaEventsListener.onRecordingStarted()/onRecordingStopped()`.
-
----
-
-## 2. Picture-in-Picture
-
-Two distinct things — don't confuse them:
-
-- **In-call compact layout** (the SDK shrinks the call grid to a floating tile *inside your app*): `CallSession.enablePictureInPictureLayout()` / `disablePictureInPictureLayout()`.
-- **System PiP** (the OS floats the call over other apps when the user leaves): static `CometChatCalls.enterPIPMode()` / `exitPIPMode()`. For OS-level PiP you must also declare the Activity `android:supportsPictureInPicture="true"` in the manifest and call `enterPIPMode()` from `onUserLeaveHint()`.
-
-```kotlin
-// in-call compact layout
-CallSession.getInstance().enablePictureInPictureLayout()
-CallSession.getInstance().disablePictureInPictureLayout()
-
-// system PiP (manifest: android:supportsPictureInPicture="true")
-override fun onUserLeaveHint() {
-    super.onUserLeaveHint()
-    CometChatCalls.enterPIPMode()
-}
-```
-
-Verified: `CallSession.enablePictureInPictureLayout()/disablePictureInPictureLayout()`, static `CometChatCalls.enterPIPMode()/exitPIPMode()`.
-
----
-
-## 3. Screen sharing — receive only
-
-**Android cannot locally INITIATE screen share** (that's a web-only capability). It *renders a remote participant's* shared screen automatically inside the call grid. You only wire a listener to react to it (e.g. switch to spotlight layout, show a banner):
-
-```kotlin
-object : ParticipantEventListener() {
-    override fun onParticipantStartedScreenShare(participant: Participant) {
-        // optional: CallSession.getInstance().setLayout(LayoutType.SPOTLIGHT)
-    }
-    override fun onParticipantStoppedScreenShare(participant: Participant) { }
-}
-```
-
-Verified: `ParticipantEventListener.onParticipantStartedScreenShare(Participant)/onParticipantStoppedScreenShare(Participant)`. There is NO local `startScreenShare` symbol in `calls-sdk-android` 5.x — do not author one.
-
----
-
-## Audio modes (cross-reference)
-
-Speaker / earpiece / Bluetooth routing is already covered in `references/device-management.md` (`setAudioMode(AudioMode.SPEAKER/EARPIECE/BLUETOOTH/HEADPHONES)` + `MediaEventsListener.onAudioModeChanged`). Virtual Background is **not supported** by `calls-sdk-android` 5.x (no symbol) — it is a web / React Native / Flutter capability only; do not author it for Android.

package/skills/cometchat-android-v6-calls/references/call-layouts.md

@@ -1,100 +0,0 @@
-# Call layouts on Android V6 (Compose)
-
-Same SDK API as V5; V6 adds Compose-native `SegmentedButton` for the switcher.
-
-**Canonical docs:** https://www.cometchat.com/docs/calls/android/call-layouts
-**Read first:** `cometchat-android-v5-calls/references/call-layouts.md` — full Java/Kotlin SDK API.
-
----
-
-## ViewModel
-
-Layout is the `LayoutType` enum (`TILE` / `SIDEBAR` / `SPOTLIGHT`) — there is no `CometChatCallsConstants.LAYOUT_*` and `setLayout` is an instance method on the `CallSession` singleton (not a static on `CometChatCalls`).
-
-```kotlin
-import com.cometchat.calls.core.CallSession
-import com.cometchat.calls.listeners.LayoutListener
-import com.cometchat.calls.model.LayoutType
-
-class CallLayoutViewModel : ViewModel() {
-  private val _layout = MutableStateFlow(LayoutType.TILE)
-  val layout: StateFlow<LayoutType> = _layout
-
-  fun set(next: LayoutType) {
-    CallSession.getInstance().setLayout(next)
-    _layout.value = next
-  }
-
-  fun onSDKChanged(next: LayoutType) {
-    _layout.value = next  // already updated by kit's switcher
-  }
-}
-
-// Register a LayoutListener via CallSession.addLayoutListener(lifecycleOwner, ...).
-// onCallLayoutChanged is a LayoutListener member (NOT a CometChatCallsEventsListener one).
-CallSession.getInstance().addLayoutListener(lifecycleOwner, object : LayoutListener() {
-  override fun onCallLayoutChanged(layout: LayoutType) {
-    Handler(Looper.getMainLooper()).post {
-      callLayoutViewModel.onSDKChanged(layout)
-    }
-  }
-})
-```
-
----
-
-## Compose switcher (SingleChoiceSegmentedButtonRow)
-
-```kotlin
-@OptIn(ExperimentalMaterial3Api::class)
-@Composable
-fun LayoutSwitcher(viewModel: CallLayoutViewModel = viewModel()) {
-  val layout by viewModel.layout.collectAsStateWithLifecycle()
-
-  val options = listOf(
-    LayoutType.TILE to "Tile",
-    LayoutType.SIDEBAR to "Sidebar",
-    LayoutType.SPOTLIGHT to "Spotlight",
-  )
-
-  SingleChoiceSegmentedButtonRow {
-    options.forEachIndexed { index, (value, label) ->
-      SegmentedButton(
-        selected = layout == value,
-        onClick = { viewModel.set(value) },
-        shape = SegmentedButtonDefaults.itemShape(index = index, count = options.size),
-      ) {
-        Text(label)
-      }
-    }
-  }
-}
-```
-
----
-
-## Anti-patterns
-
-V5 sister rules apply, plus Compose-specific:
-
-1. **`collectAsState()` instead of `collectAsStateWithLifecycle()`.** State updates while paused → wasted work.
-2. **`Row` of `OutlinedButton`s instead of `SegmentedButton`.** Visually similar but missing the radio-group accessibility semantics; TalkBack announces it as 3 separate buttons.
-3. **Calling `setLayout` directly from the composable.** Move it to ViewModel — survives config changes.
-
----
-
-## Verification checklist
-
-- [ ] `CallLayoutViewModel` exposes `StateFlow<LayoutType>`
-- [ ] `SingleChoiceSegmentedButtonRow` wraps the layout options
-- [ ] `collectAsStateWithLifecycle` (not `collectAsState`)
-- [ ] `LayoutListener.onCallLayoutChanged` (registered via `addLayoutListener`) syncs the ViewModel on main thread
-- [ ] Real-device smoke: cycles all 3, survives rotation
-
----
-
-## Pointers
-
-- `cometchat-android-v5-calls/references/call-layouts.md` — V5 sister (Views patterns)
-- `cometchat-android-v6-calls` SKILL.md
-- Canonical docs: https://www.cometchat.com/docs/calls/android/call-layouts

package/skills/cometchat-android-v6-calls/references/call-session.md

@@ -1,163 +0,0 @@
-# Call session — joinSession with no ringing (Android V6 / Compose)
-
-V6 uses the same SDK (`com.cometchat.calls-sdk-android`) as V5. The canonical SDK API surface is documented in the V5 sister; this file documents only the Compose-specific delta (bridging `AndroidView` to the SDK's `RelativeLayout` container).
-
-**Read first:**
-- `cometchat-android-v5-calls/references/call-session.md` — canonical SDK API (single-call `joinSession`, `SessionSettingsBuilder`, `SessionStatusListener`, `CometChatOngoingCallService`)
-- `cometchat-react-calls/references/call-session.md` — cross-platform architecture
-
-**Source of truth:** `calls-sdk-android-5/samples/sample-app/src/main/kotlin/com/cometchat/samplecalls/ui/activity/CallActivity.kt` (no Compose-specific upstream sample exists; the SDK surface is identical).
-
----
-
-## Hard rules
-
-All V5 rules apply (single-call `joinSession(sessionId, settings, container, callback)`, `CometChatCalls.SessionSettingsBuilder()`, `SessionStatusListener` on the `CallSession` instance, `CometChatOngoingCallService.launch/abort`, runtime permissions, no Chat SDK for session-only). The V6 Compose-specific deltas:
-
-1. **`AndroidView` with `remember`-stable factory** to host the SDK's `RelativeLayout` container. The factory MUST be wrapped in `remember { }` — re-creating the layout on every recomposition flickers / re-joins the session.
-2. **`LaunchedEffect(sessionId)` to fire `joinSession` once**, not in a Composable body. Composable bodies re-run on recomposition; the SDK would join multiple times.
-3. **`DisposableEffect` for cleanup**, NOT `LaunchedEffect`'s cleanup lambda. `LaunchedEffect`'s cleanup fires on key change too, not just final dispose. `DisposableEffect.onDispose` is the correct teardown hook.
-4. **State observation via `mutableStateOf` set from listener callbacks** — the listener callbacks must hop to `Main` dispatcher (or use `runOnUiThread` from a hosting activity ref) before touching Compose state.
-
----
-
-## Compose CallRoom
-
-```kotlin
-@Composable
-fun CallRoom(sessionId: String, onLeft: () -> Unit) {
-  val context = LocalContext.current
-  val activity = context as Activity
-  val containerRef = remember { mutableStateOf<RelativeLayout?>(null) }
-  val joined = remember { mutableStateOf(false) }
-  val callSession = remember { mutableStateOf<CallSession?>(null) }
-
-  AndroidView(
-    factory = { ctx ->
-      RelativeLayout(ctx).apply {
-        layoutParams = ViewGroup.LayoutParams(MATCH_PARENT, MATCH_PARENT)
-        setBackgroundColor(android.graphics.Color.BLACK)
-        containerRef.value = this
-      }
-    },
-    modifier = Modifier.fillMaxSize(),
-  )
-
-  LaunchedEffect(sessionId) {
-    if (joined.value) return@LaunchedEffect
-    val container = containerRef.value ?: return@LaunchedEffect
-    joined.value = true
-
-    val sessionSettings = CometChatCalls.SessionSettingsBuilder()
-      .setTitle("CometChat Meeting")
-      .startVideoPaused(false)
-      .startAudioMuted(false)
-      .build()
-
-    CometChatCalls.joinSession(
-      sessionId,
-      sessionSettings,
-      container,
-      object : CometChatCalls.CallbackListener<CallSession>() {
-        override fun onSuccess(session: CallSession) {
-          callSession.value = session
-
-          // Single guarded termination handler — the v5 Calls SDK fires
-          // onSessionLeft + onConnectionClosed in sequence on every hangup.
-          // Without the guard, abort() + onLeft() fire 3 times (wasteful;
-          // can race the composable's exit transition).
-          val isTerminating = mutableStateOf(false)
-          fun handleTermination() {
-            if (isTerminating.value) return
-            isTerminating.value = true
-            activity.runOnUiThread {
-              CometChatOngoingCallService.abort(activity)
-              onLeft()
-            }
-          }
-
-          session.addSessionStatusListener(activity, object : SessionStatusListener() {
-            override fun onSessionJoined() {
-              CometChatOngoingCallService.launch(activity)
-            }
-
-            override fun onSessionLeft() = handleTermination()
-            override fun onConnectionClosed() = handleTermination()
-            override fun onSessionTimedOut() = handleTermination()
-
-            override fun onConnectionLost() {}
-            override fun onConnectionRestored() {}
-          })
-
-          session.addButtonClickListener(activity, object : ButtonClickListener() {
-            override fun onLeaveSessionButtonClicked() {
-              val active = CallSession.getInstance()
-              if (active.isSessionActive) active.leaveSession()
-              // The listener chain calls handleTermination().
-            }
-          })
-        }
-
-        override fun onError(e: CometChatException) {
-          activity.runOnUiThread {
-            Toast.makeText(activity, "Failed to join: ${e.message}", Toast.LENGTH_LONG).show()
-            onLeft()
-          }
-        }
-      }
-    )
-  }
-
-  DisposableEffect(sessionId) {
-    onDispose {
-      val active = CallSession.getInstance()
-      if (active.isSessionActive) active.leaveSession()
-      CometChatOngoingCallService.abort(activity)
-    }
-  }
-}
-```
-
-**Why this shape:**
-
-- **`AndroidView` factory wrapped in `remember`** — Compose otherwise re-creates the `RelativeLayout` on every recomposition; the SDK's video tile dies along with it.
-- **`LaunchedEffect(sessionId)` for the join call** — Composable body re-runs on every recomposition; `LaunchedEffect` runs once per key. The `joined` guard handles configuration changes (rotation re-keys the effect).
-- **`runOnUiThread` inside listener callbacks** — SDK callbacks fire on background threads; touching Compose state from them throws without the dispatcher hop.
-- **`DisposableEffect.onDispose` for `leaveSession`** — `LaunchedEffect`'s cleanup runs on key change too. `DisposableEffect.onDispose` only runs when the composable actually leaves composition.
-
----
-
-## Anti-patterns
-
-V5 sister rules apply, plus V6 Compose-specific:
-
-1. **`AndroidView` without `remember { }` around the layout reference.** Each recomposition creates a new layout → call surface flickers, joinSession orphans previous container.
-2. **`leaveSession()` in `LaunchedEffect`'s cleanup lambda.** Fires on every key change, not just dispose. Use `DisposableEffect.onDispose`.
-3. **Skipping the `joined` guard.** Configuration changes (rotation) re-run `LaunchedEffect` with the same key (StrictMode-like behavior in dev); guard prevents double-join.
-4. **Touching `mutableStateOf` from listener callbacks without `runOnUiThread`.** Compose state isn't thread-safe; race conditions corrupt state.
-5. **Putting `joinSession` directly in the Composable body** (not in `LaunchedEffect`). Recomposition re-runs the call → multiple sessions.
-
----
-
-## Verification checklist
-
-V5 checklist applies, plus Compose-specific:
-
-- [ ] `AndroidView` factory creates `RelativeLayout` once, stored via `remember { mutableStateOf<RelativeLayout?>(null) }`
-- [ ] `joinSession` fired inside `LaunchedEffect(sessionId)`, NOT in Composable body
-- [ ] `joined` flag guards re-entry on rotation / key re-trigger
-- [ ] `DisposableEffect.onDispose` calls `leaveSession` + `CometChatOngoingCallService.abort`
-- [ ] Listener callbacks use `activity.runOnUiThread { ... }` before touching Compose state
-- [ ] `onSessionLeft`, `onConnectionClosed`, `onSessionTimedOut` ALL fire the `onLeft` callback
-- [ ] **Standalone session-only:** no chat-sdk-android dependency
-- [ ] Real-device smoke: rotation doesn't double-join, dispose tears down cleanly, foreground-service notification clears
-
----
-
-## Pointers
-
-- `cometchat-android-v5-calls/references/call-session.md` — canonical SDK API + Views patterns
-- `cometchat-android-v6-calls/SKILL.md` — V6 Compose architecture (W1–W5 workarounds for the kit)
-- `cometchat-android-v6-calls/references/share-invite.md` — App Links config
-- Upstream Android sample — `calls-sdk-android-5/samples/sample-app/src/main/kotlin/com/cometchat/samplecalls/ui/activity/CallActivity.kt`
-- Canonical docs: https://www.cometchat.com/docs/calls/android/join-session

package/skills/cometchat-android-v6-calls/references/device-management.md

@@ -1,172 +0,0 @@
-# Device management on Android V6
-
-V6 inherits the V5 SDK API for device management — `CallSession.muteAudio()` / `pauseVideo()` / `setAudioMode()` / camera flip. V5 has detailed audio-controls + video-controls references; this V6 reference covers the Compose-specific UI patterns.
-
-**Canonical docs:** https://www.cometchat.com/docs/calls/android/device-management
-**Read first:**
-- `cometchat-android-v5-calls/references/audio-controls.md` — full audio control SDK API (carries over)
-- `cometchat-android-v5-calls/references/video-controls.md` — camera flip + pause/resume
-
----
-
-## Compose toggle controls
-
-```kotlin
-@Composable
-fun CallControls(viewModel: CallControlsViewModel = viewModel()) {
-  val state by viewModel.state.collectAsStateWithLifecycle()
-
-  Row(horizontalArrangement = Arrangement.spacedBy(16.dp)) {
-    IconButton(onClick = { viewModel.toggleMic() }) {
-      Icon(
-        imageVector = if (state.micMuted) Icons.Filled.MicOff else Icons.Filled.Mic,
-        contentDescription = if (state.micMuted) "Unmute microphone" else "Mute microphone",
-        tint = if (state.micMuted) Color.Red else Color.White,
-      )
-    }
-
-    IconButton(onClick = { viewModel.toggleCamera() }) {
-      Icon(
-        imageVector = if (state.cameraOff) Icons.Filled.VideocamOff else Icons.Filled.Videocam,
-        contentDescription = if (state.cameraOff) "Turn on camera" else "Turn off camera",
-        tint = if (state.cameraOff) Color.Red else Color.White,
-      )
-    }
-
-    IconButton(onClick = { viewModel.flipCamera() }) {
-      Icon(
-        imageVector = Icons.Filled.FlipCameraIos,
-        contentDescription = "Flip camera",
-        tint = Color.White,
-      )
-    }
-
-    IconButton(onClick = { viewModel.toggleSpeaker() }) {
-      Icon(
-        imageVector = when (state.audioMode) {
-          AudioMode.SPEAKER -> Icons.Filled.VolumeUp
-          AudioMode.EARPIECE -> Icons.Filled.PhoneInTalk
-          AudioMode.BLUETOOTH -> Icons.Filled.Bluetooth
-        },
-        contentDescription = "Audio output: ${state.audioMode.name}",
-        tint = Color.White,
-      )
-    }
-  }
-}
-```
-
----
-
-## ViewModel
-
-```kotlin
-data class CallControlsState(
-  val micMuted: Boolean = false,
-  val cameraOff: Boolean = false,
-  val audioMode: AudioMode = AudioMode.SPEAKER,
-)
-
-class CallControlsViewModel : ViewModel() {
-  private val _state = MutableStateFlow(CallControlsState())
-  val state: StateFlow<CallControlsState> = _state
-
-  fun toggleMic() {
-    val callSession = CallSession.getInstance()
-    if (_state.value.micMuted) {
-      callSession.unmuteAudio()
-    } else {
-      callSession.muteAudio()
-    }
-    _state.update { it.copy(micMuted = !it.micMuted) }
-  }
-
-  fun toggleCamera() {
-    val callSession = CallSession.getInstance()
-    if (_state.value.cameraOff) {
-      callSession.resumeVideo()
-    } else {
-      callSession.pauseVideo()
-    }
-    _state.update { it.copy(cameraOff = !it.cameraOff) }
-  }
-
-  fun flipCamera() {
-    // switchCamera() takes NO argument — it toggles front/rear internally.
-    // (The enum, when you need it, is CameraFacing.{FRONT,REAR} — there is no BACK,
-    //  and CallSession has no currentCameraFacing getter.)
-    CallSession.getInstance().switchCamera()
-  }
-
-  fun toggleSpeaker() {
-    val callSession = CallSession.getInstance()
-    val nextMode = when (_state.value.audioMode) {
-      AudioMode.SPEAKER -> AudioMode.EARPIECE
-      AudioMode.EARPIECE -> AudioMode.SPEAKER
-      AudioMode.BLUETOOTH -> AudioMode.SPEAKER
-    }
-    callSession.setAudioMode(nextMode)
-    _state.update { it.copy(audioMode = nextMode) }
-  }
-}
-```
-
----
-
-## Bluetooth audio routing
-
-V6 still uses the V5 SDK's `MediaEventsListener` for audio mode change detection:
-
-```kotlin
-class CallControlsViewModel(
-  lifecycleOwner: LifecycleOwner,
-) : ViewModel(), MediaEventsListener {
-  init {
-    // addMediaEventsListener takes (LifecycleOwner, MediaEventsListener) — there is no String-keyed overload.
-    CallSession.getInstance().addMediaEventsListener(lifecycleOwner, this)
-  }
-
-  override fun onAudioModeChanged(mode: AudioMode) {
-    _state.update { it.copy(audioMode = mode) }
-  }
-
-  override fun onCleared() {
-    // There is no removeMediaEventsListener — clear all listeners on teardown.
-    CallSession.getInstance().clearAllListeners()
-  }
-  // ... other MediaEventsListener methods
-}
-```
-
-When the user connects Bluetooth headphones mid-call, `onAudioModeChanged(BLUETOOTH)` fires. Update the UI button accordingly. (Lifecycle-scoped registration auto-removes when the owner is destroyed; `clearAllListeners()` is the explicit teardown.)
-
----
-
-## Anti-patterns
-
-V5 audio-controls + video-controls references list the SDK-level anti-patterns; V6 Compose-specific:
-
-1. **`Icons.Filled.MicOff` without `tint`.** Default tint is theme-dependent; on dark call surfaces, the icon may be invisible.
-2. **`collectAsState()` instead of `collectAsStateWithLifecycle()`.** State updates run while paused; CPU waste.
-3. **Calling `switchCamera(CameraFacing)` with an argument.** No such overload exists — `switchCamera()` takes no arg and toggles front/rear internally. There is also no `currentCameraFacing` getter, and the enum is `CameraFacing.{FRONT,REAR}` (no `BACK`).
-
----
-
-## Verification checklist
-
-- [ ] ViewModel uses `StateFlow` + `collectAsStateWithLifecycle()`
-- [ ] All toggle buttons have `contentDescription` (a11y)
-- [ ] `MediaEventsListener` registered via `addMediaEventsListener(lifecycleOwner, this)`
-- [ ] Listeners cleared in `onCleared()` via `clearAllListeners()`
-- [ ] Real-device smoke: mute / camera / flip / speaker all work
-- [ ] Bluetooth smoke: connect headphones → audio mode icon updates
-
----
-
-## Pointers
-
-- `cometchat-android-v5-calls/references/audio-controls.md` — full audio SDK API (mute/audio mode)
-- `cometchat-android-v5-calls/references/video-controls.md` — camera pause/resume/flip
-- `cometchat-android-v6-calls` SKILL.md
-- `cometchat-android-v6-calls/references/raise-hand.md` — Compose pattern sibling
-- Canonical docs: https://www.cometchat.com/docs/calls/android/device-management