Add support for individual, raw, and composite call recordings (#1610)

* feature: Introduce new recording types raw and individual, the existing default one is now named as composite. Details: https://linear.app/stream/issue/AND-1028/add-support-for-new-call-recording-types-individual-raw-composite-in

* chore: Improve menu items for demo-app

* chore: fix breaking changes

* chore: update tests

* chore: revert commit

* chore: revert ui changes

* fix: recording state only false when all recordings inactive

Previously, stopping any recording type would set recording=false even
if other recording types were still active. Now recording remains true
as long as any recording type (composite, individual, or raw) is active.

* test: cleanup recording state to prevent test pollution

The 'test recording types are independent' test was leaving
individualRecording and rawRecording as true, which polluted
subsequent tests that share the same call object.

---------

Co-authored-by: Aleksandar Apostolov <apostolov.alexandar@gmail.com>

Author: rahul-lohra

demo-app/src/main/kotlin/io/getstream/video/android/ui/call/CallScreen.kt

@@ -54,6 +54,7 @@ import androidx.compose.material.rememberModalBottomSheetState
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.collectAsState
+import androidx.compose.runtime.derivedStateOf
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableIntStateOf
 import androidx.compose.runtime.mutableStateListOf
@@ -118,6 +119,7 @@ import io.getstream.video.android.core.RealtimeConnection
 import io.getstream.video.android.core.call.state.ChooseLayout
 import io.getstream.video.android.core.model.PreferredVideoResolution
 import io.getstream.video.android.core.pip.PictureInPictureConfiguration
+import io.getstream.video.android.core.recording.RecordingType
 import io.getstream.video.android.core.utils.isEnabled
 import io.getstream.video.android.filters.video.BlurredBackgroundVideoFilter
 import io.getstream.video.android.filters.video.VirtualBackgroundVideoFilter
@@ -174,7 +176,9 @@ fun CallScreen(
     val orientation = LocalConfiguration.current.orientation
     var showEndRecordingDialog by remember { mutableStateOf(false) }
     var acceptedCallRecording by remember { mutableStateOf(false) }
-    val isRecording by call.state.recording.collectAsStateWithLifecycle()
+    val compositeRecording by call.state.recording.collectAsStateWithLifecycle()
+    val rawRecording by call.state.rawRecording.collectAsStateWithLifecycle()
+    val individualRecording by call.state.individualRecording.collectAsStateWithLifecycle()
     val participantsSize by call.state.participants.collectAsStateWithLifecycle()
     val messages: MutableList<MessageItemState> = remember { mutableStateListOf() }
     var messagesVisibility by remember { mutableStateOf(false) }
@@ -789,7 +793,15 @@ fun CallScreen(
                 onDismissed = { isShowingAvailableDeviceMenu = false },
             )
         }
-
+        val isRecording by remember {
+            derivedStateOf {
+                buildSet {
+                    if (compositeRecording) add(RecordingType.Composite)
+                    if (individualRecording) add(RecordingType.Individual)
+                    if (rawRecording) add(RecordingType.Raw)
+                }.isNotEmpty()
+            }
+        }
         // TODO: AAP, move recording and actions in separate composables.
         if (isRecording && !showRecordingWarning) {
             StreamDialogPositiveNegative(

demo-app/src/main/kotlin/io/getstream/video/android/ui/menu/MenuDefinitions.kt

@@ -31,7 +31,10 @@ import androidx.compose.material.icons.filled.ClosedCaptionOff
 import androidx.compose.material.icons.filled.Crop
 import androidx.compose.material.icons.filled.CropFree
 import androidx.compose.material.icons.filled.Feedback
+import androidx.compose.material.icons.filled.Person
 import androidx.compose.material.icons.filled.RadioButtonChecked
+import androidx.compose.material.icons.filled.RawOff
+import androidx.compose.material.icons.filled.RawOn
 import androidx.compose.material.icons.filled.Replay
 import androidx.compose.material.icons.filled.RestartAlt
 import androidx.compose.material.icons.filled.SettingsBackupRestore
@@ -46,6 +49,7 @@ import androidx.compose.material.icons.filled.VideocamOff
 import io.getstream.video.android.compose.ui.components.video.VideoScalingType
 import io.getstream.video.android.core.audio.StreamAudioDevice
 import io.getstream.video.android.core.model.PreferredVideoResolution
+import io.getstream.video.android.core.recording.RecordingType
 import io.getstream.video.android.ui.closedcaptions.ClosedCaptionUiState
 import io.getstream.video.android.ui.menu.base.ActionMenuItem
 import io.getstream.video.android.ui.menu.base.DynamicSubMenuItem
@@ -89,6 +93,8 @@ fun defaultStreamMenu(
     audioDeviceUiStateList: List<AudioDeviceUiState> = emptyList(),
     audioUsageUiState: AudioUsageUiState = AudioUsageVoiceCommunicationUiState,
     onToggleAudioUsage: () -> Unit = {},
+    selectedRecordingTypes: Set<RecordingType> = emptySet(),
+    onSelectRecordingType: (RecordingType) -> Unit = {},
 ) = buildList<MenuItem> {
     if (noiseCancellationFeatureEnabled) {
         add(
@@ -165,6 +171,8 @@ fun defaultStreamMenu(
                     loadTranscriptions,
                     audioUsageUiState,
                     onToggleAudioUsage,
+                    selectedRecordingTypes,
+                    onSelectRecordingType,
                 ),
             ),
         )
@@ -272,6 +280,51 @@ fun scaleTypeMenu(onSelectScaleType: (VideoScalingType) -> Unit): List<MenuItem>
     ),
 )
 
+fun recordingTypeMenu(onSelectRecording: (RecordingType) -> Unit, selectedRecordingTypes: Set<RecordingType>): List<MenuItem> {
+    return arrayListOf(
+        ActionMenuItem(
+            title = if (selectedRecordingTypes.contains(RecordingType.Raw)) {
+                "Stop raw recording"
+            } else {
+                "Start raw recording"
+            },
+            icon = if (selectedRecordingTypes.contains(RecordingType.Raw)) {
+                Icons.Default.RawOn
+            } else {
+                Icons.Default.RawOff
+            },
+            highlight = selectedRecordingTypes.contains(RecordingType.Raw),
+            action = { onSelectRecording(RecordingType.Raw) },
+        ),
+        ActionMenuItem(
+            title = if (selectedRecordingTypes.contains(
+                    RecordingType.Individual,
+                )
+            ) {
+                "Stop individual recording"
+            } else {
+                "Start individual recording"
+            },
+            icon = Icons.Default.Person,
+            highlight = selectedRecordingTypes.contains(RecordingType.Individual),
+            action = { onSelectRecording(RecordingType.Individual) },
+        ),
+        ActionMenuItem(
+            title = if (selectedRecordingTypes.contains(
+                    RecordingType.Composite,
+                )
+            ) {
+                "Stop composite recording"
+            } else {
+                "Start composite recording"
+            },
+            icon = Icons.Default.CropFree,
+            highlight = selectedRecordingTypes.contains(RecordingType.Composite),
+            action = { onSelectRecording(RecordingType.Composite) },
+        ),
+    )
+}
+
 /**
  * Optionally defines the debug sub-menu of the demo app.
  */
@@ -294,6 +347,8 @@ fun debugSubmenu(
     loadTranscriptions: suspend () -> List<MenuItem>,
     audioUsageUiState: AudioUsageUiState,
     onToggleAudioUsage: () -> Unit,
+    selectedRecordingTypes: Set<RecordingType>,
+    onSelectRecordingType: (RecordingType) -> Unit,
 ) = listOf(
     DynamicSubMenuItem(
         title = "List Transcriptions",
@@ -380,18 +435,10 @@ fun debugSubmenu(
         highlight = audioUsageUiState.highlight,
         action = onToggleAudioUsage,
     ),
-    ActionMenuItem(
+    SubMenuItem(
         title = "Start/stop recording",
         icon = Icons.Default.RadioButtonChecked,
-        action = {
-//                scope.launch {
-//                    if (isRecording) {
-//                        showEndRecordingDialog = true
-//                    } else {
-//                        call.startRecording()
-//                    }
-//                }
-        },
+        items = recordingTypeMenu(onSelectRecordingType, selectedRecordingTypes),
     ),
     DynamicSubMenuItem(
         title = "Recordings",

demo-app/src/main/kotlin/io/getstream/video/android/ui/menu/SettingsMenu.kt

@@ -40,8 +40,10 @@ import androidx.compose.material.icons.filled.SpeakerPhone
 import androidx.compose.material.icons.filled.VideoFile
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.LaunchedEffect
+import androidx.compose.runtime.derivedStateOf
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.remember
+import androidx.compose.runtime.rememberCoroutineScope
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.graphics.Color
@@ -62,6 +64,7 @@ import io.getstream.video.android.core.audio.StreamAudioDevice
 import io.getstream.video.android.core.call.audio.InputAudioFilter
 import io.getstream.video.android.core.mapper.ReactionMapper
 import io.getstream.video.android.core.model.PreferredVideoResolution
+import io.getstream.video.android.core.recording.RecordingType
 import io.getstream.video.android.tooling.extensions.toPx
 import io.getstream.video.android.ui.call.ReactionsMenu
 import io.getstream.video.android.ui.closedcaptions.ClosedCaptionUiState
@@ -70,6 +73,7 @@ import io.getstream.video.android.ui.menu.base.DynamicMenu
 import io.getstream.video.android.ui.menu.base.MenuItem
 import io.getstream.video.android.ui.menu.transcriptions.TranscriptionUiStateManager
 import io.getstream.video.android.util.filters.SampleAudioFilter
+import kotlinx.coroutines.launch
 import java.nio.ByteBuffer
 
 @OptIn(ExperimentalPermissionsApi::class)
@@ -94,6 +98,7 @@ internal fun SettingsMenu(
     onClosedCaptionsToggle: () -> Unit,
 ) {
     val context = LocalContext.current
+    val scope = rememberCoroutineScope()
     val availableDevices by call.microphone.devices.collectAsStateWithLifecycle()
     val currentAudioUsage by call.speaker.audioUsage.collectAsStateWithLifecycle()
 
@@ -245,6 +250,31 @@ internal fun SettingsMenu(
             }
         }
     }
+    val compositeRecording by call.state.compositeRecording.collectAsStateWithLifecycle()
+    val individualRecording by call.state.individualRecording.collectAsStateWithLifecycle()
+    val rawRecording by call.state.rawRecording.collectAsStateWithLifecycle()
+    val enabledRecordingTypes by remember {
+        derivedStateOf {
+            buildSet {
+                if (compositeRecording) add(RecordingType.Composite)
+                if (individualRecording) add(RecordingType.Individual)
+                if (rawRecording) add(RecordingType.Raw)
+            }
+        }
+    }
+    val onSelectRecordingType = { recordingType: RecordingType ->
+        scope.launch {
+            when (recordingType) {
+                RecordingType.Raw, RecordingType.Individual, RecordingType.Composite ->
+                    if (enabledRecordingTypes.contains(recordingType)) {
+                        call.stopRecording(recordingType)
+                    } else {
+                        call.startRecording(recordingType)
+                    }
+            }
+        }
+        Unit
+    }
 
     Popup(
         offset = IntOffset(
@@ -263,9 +293,11 @@ internal fun SettingsMenu(
                     tint = Color.White,
                     imageVector = Icons.Default.Close,
                     contentDescription = Icons.Default.Close.name,
-                    modifier = Modifier.padding(horizontal = 8.dp, vertical = 10.dp).clickable {
-                        onDismissed()
-                    },
+                    modifier = Modifier
+                        .padding(horizontal = 8.dp, vertical = 10.dp)
+                        .clickable {
+                            onDismissed()
+                        },
                 )
                 ReactionsMenu(
                     call = call,
@@ -319,6 +351,8 @@ internal fun SettingsMenu(
                 audioDeviceUiStateList = audioDeviceUiStateList,
                 audioUsageUiState = audioUsageUiState,
                 onToggleAudioUsage = onToggleAudioUsage,
+                selectedRecordingTypes = enabledRecordingTypes,
+                onSelectRecordingType = onSelectRecordingType,
             ),
         )
     }