Add support for media recordings

README.md

@@ -84,6 +84,10 @@ If you want to edit the functions that have been deployed to Twilio Serverless,
 1. Enter passcode from the [backend deploy](#deploy-the-app-to-twilio) and tap `Continue`.
 1. Tap `Create Event` to host a new stream or `Join Event` to join a stream as a viewer or a speaker.
 
+## Recordings
+
+The event host has the option to enable recording in the app UI when they create the event. A recording will be available shortly after the event ends. To view a list of all recordings, run `npm run recordings`. 
+
 ## Reference Backend
 
 The API for the reference backend used by the clients is specified [here](ReferenceBackendAPI.md).

ReferenceBackendAPI.md

@@ -58,7 +58,8 @@ Request parameters:
 ```json
 {
   "user_identity": "Bob",
-  "stream_name": "demo"
+  "stream_name": "demo",
+  "record_stream": true
 }
 ```
 

apps/ios/LiveVideo/LiveVideo.xcodeproj/project.pbxproj

@@ -76,6 +76,8 @@
 		DCB1BE0B27581C11006CE9D1 /* Nimble in Frameworks */ = {isa = PBXBuildFile; productRef = DCB1BE0A27581C11006CE9D1 /* Nimble */; };
 		DCB4497426F5496400B52774 /* SpeakerSettingsManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = DCB4497326F5496400B52774 /* SpeakerSettingsManager.swift */; };
 		DCB4497626F65A7000B52774 /* SpeakerVideoViewModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = DCB4497526F65A7000B52774 /* SpeakerVideoViewModel.swift */; };
+		DCB8FA7B27EE17E00001EEB1 /* SyncStreamDocument.swift in Sources */ = {isa = PBXBuildFile; fileRef = DCB8FA7A27EE17DF0001EEB1 /* SyncStreamDocument.swift */; };
+		DCB8FA8127EE51630001EEB1 /* RecordingBadge.swift in Sources */ = {isa = PBXBuildFile; fileRef = DCB8FA8027EE51630001EEB1 /* RecordingBadge.swift */; };
 		DCC1D62626D9396400892038 /* StreamManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = DCC1D62526D9396400892038 /* StreamManager.swift */; };
 		DCC1D62826D9568700892038 /* StreamConfig.swift in Sources */ = {isa = PBXBuildFile; fileRef = DCC1D62726D9568700892038 /* StreamConfig.swift */; };
 		DCC1D62A26D9643400892038 /* FormStack.swift in Sources */ = {isa = PBXBuildFile; fileRef = DCC1D62926D9643400892038 /* FormStack.swift */; };
@@ -184,6 +186,8 @@
 		DCB1BE042756D954006CE9D1 /* EnterPasscodeView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EnterPasscodeView.swift; sourceTree = "<group>"; };
 		DCB4497326F5496400B52774 /* SpeakerSettingsManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SpeakerSettingsManager.swift; sourceTree = "<group>"; };
 		DCB4497526F65A7000B52774 /* SpeakerVideoViewModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SpeakerVideoViewModel.swift; sourceTree = "<group>"; };
+		DCB8FA7A27EE17DF0001EEB1 /* SyncStreamDocument.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SyncStreamDocument.swift; sourceTree = "<group>"; };
+		DCB8FA8027EE51630001EEB1 /* RecordingBadge.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RecordingBadge.swift; sourceTree = "<group>"; };
 		DCC1D62526D9396400892038 /* StreamManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StreamManager.swift; sourceTree = "<group>"; };
 		DCC1D62726D9568700892038 /* StreamConfig.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StreamConfig.swift; sourceTree = "<group>"; };
 		DCC1D62926D9643400892038 /* FormStack.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FormStack.swift; sourceTree = "<group>"; };
@@ -259,6 +263,7 @@
 			children = (
 				DC175F2C270E232F00D9D1FE /* SyncManager.swift */,
 				DC175F3D2717530D00D9D1FE /* SyncObjectConnecting.swift */,
+				DCB8FA7A27EE17DF0001EEB1 /* SyncStreamDocument.swift */,
 				DC175F31270E23F900D9D1FE /* SyncUserDocument.swift */,
 				DC175F33270E3FD200D9D1FE /* SyncUsersMap.swift */,
 			);
@@ -472,6 +477,7 @@
 				DCCA726E27B590F6006B0441 /* DisplayNameFactory.swift */,
 				DC1ED0EF26DFCD3C00FFA769 /* LiveBadge.swift */,
 				DC9E18382729DC740070F53F /* OffscreenSpeakersView.swift */,
+				DCB8FA8027EE51630001EEB1 /* RecordingBadge.swift */,
 				DC1ED12F26E960C600FFA769 /* SpeakerGridView.swift */,
 				DC504A7426F0F18600C37EC9 /* SpeakerGridViewModel.swift */,
 				DC504A7626F1468E00C37EC9 /* SpeakerVideoView.swift */,
@@ -720,11 +726,13 @@
 				DC1ED0FD26E14D0B00FFA769 /* StreamToolbar.swift in Sources */,
 				DC1ED0F926E1440200FFA769 /* StreamStatusView.swift in Sources */,
 				DC504A7726F1468E00C37EC9 /* SpeakerVideoView.swift in Sources */,
+				DCB8FA7B27EE17E00001EEB1 /* SyncStreamDocument.swift in Sources */,
 				DC175F34270E3FD200D9D1FE /* SyncUsersMap.swift in Sources */,
 				DCC48FA326D8322900EE49EF /* SwiftUIPlayerView.swift in Sources */,
 				DC4F45E92723135500BE730B /* CardButtonLabel.swift in Sources */,
 				DCADF33927FCA7780093A9FE /* TitleValueView.swift in Sources */,
 				DC1ED0F726E12C7400FFA769 /* ProgressHUD.swift in Sources */,
+				DCB8FA8127EE51630001EEB1 /* RecordingBadge.swift in Sources */,
 				DC175F32270E23F900D9D1FE /* SyncUserDocument.swift in Sources */,
 				DCC1D62626D9396400892038 /* StreamManager.swift in Sources */,
 				DCCA727127B5BFE8006B0441 /* PresentationStatusView.swift in Sources */,

apps/ios/LiveVideo/LiveVideo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -60,8 +60,8 @@
         "repositoryURL": "https://github.com/twilio/twilio-live-player-ios",
         "state": {
           "branch": null,
-          "revision": "7c4827e0bdb3b935aecdce9fa3c1b3c42ba60dd5",
-          "version": "1.0.1"
+          "revision": "97dff98041229cfe90c9d2e5b930c836279a9a48",
+          "version": "1.1.0"
         }
       },
       {

apps/ios/LiveVideo/LiveVideo/Assets.xcassets/Colors/RecordingDotBright.colorset/Contents.json

@@ -0,0 +1,38 @@
+{
+  "colors" : [
+    {
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0.000",
+          "green" : "0.000",
+          "red" : "1.000"
+        }
+      },
+      "idiom" : "universal"
+    },
+    {
+      "appearances" : [
+        {
+          "appearance" : "luminosity",
+          "value" : "dark"
+        }
+      ],
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "1.000",
+          "green" : "1.000",
+          "red" : "1.000"
+        }
+      },
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

apps/ios/LiveVideo/LiveVideo/Assets.xcassets/Colors/RecordingDotDark.colorset/Contents.json

@@ -0,0 +1,38 @@
+{
+  "colors" : [
+    {
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0.000",
+          "green" : "0.000",
+          "red" : "0.663"
+        }
+      },
+      "idiom" : "universal"
+    },
+    {
+      "appearances" : [
+        {
+          "appearance" : "luminosity",
+          "value" : "dark"
+        }
+      ],
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "1.000",
+          "green" : "1.000",
+          "red" : "1.000"
+        }
+      },
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

apps/ios/LiveVideo/LiveVideo/Helpers/LiveVideoError.swift

@@ -7,9 +7,11 @@ import Foundation
 enum LiveVideoError: Error {
     case backendError(message: String)
     case passcodeIncorrect
+    case recordError(message: String)
     case speakerMovedToViewersByHost
     case streamEndedByHost
     case syncClientConnectionFatalError
+    case syncObjectDecodeError
     case syncTokenExpired
 }
 
@@ -18,9 +20,11 @@ extension LiveVideoError: LocalizedError {
         switch self {
         case let .backendError(message): return message
         case .passcodeIncorrect: return "Passcode incorrect."
+        case let .recordError(message): return message
         case .speakerMovedToViewersByHost: return "Speaker moved to viewers by host."
         case .streamEndedByHost: return "Event ended by host."
         case .syncClientConnectionFatalError: return "Sync client connection fatal error."
+        case .syncObjectDecodeError: return "Sync object decode error."
         case .syncTokenExpired: return "Sync token expired."
         }
     }

apps/ios/LiveVideo/LiveVideo/Launch/LiveVideoApp.swift

@@ -16,6 +16,7 @@ struct LiveVideoApp: App {
     @StateObject private var speakerGridViewModel = SpeakerGridViewModel()
     @StateObject private var presentationLayoutViewModel = PresentationLayoutViewModel()
     @StateObject private var api = API()
+    @StateObject private var streamDocument = SyncStreamDocument()
     @StateObject private var appSettingsManager = AppSettingsManager()
 
     var body: some Scene {
@@ -30,22 +31,24 @@ struct LiveVideoApp: App {
                 .environmentObject(speakerSettingsManager)
                 .environmentObject(hostControlsManager)
                 .environmentObject(api)
+                .environmentObject(streamDocument)
                 .environmentObject(appSettingsManager)
                 .onAppear {
                     authManager.configure(api: api, appSettingsManager: appSettingsManager)
                     let localParticipant = LocalParticipantManager(authManager: authManager)
                     let roomManager = RoomManager()
                     roomManager.configure(localParticipant: localParticipant)
                     let userDocument = SyncUserDocument()
-                    let speakersMap = SyncUsersMap()
-                    let raisedHandsMap = SyncUsersMap()
-                    let viewersMap = SyncUsersMap()
+                    let speakersMap = SyncUsersMap(uniqueName: "speakers")
+                    let raisedHandsMap = SyncUsersMap(uniqueName: "raised_hands")
+                    let viewersMap = SyncUsersMap(uniqueName: "viewers")
                     let speakerVideoViewModelFactory = SpeakerVideoViewModelFactory()
                     let syncManager = SyncManager(
                         speakersMap: speakersMap,
                         viewersMap: viewersMap,
                         raisedHandsMap: raisedHandsMap,
                         userDocument: userDocument,
+                        streamDocument: streamDocument,
                         appSettingsManager: appSettingsManager
                     )
                     streamManager.configure(
@@ -59,7 +62,8 @@ struct LiveVideoApp: App {
                         streamManager: streamManager,
                         speakerSettingsManager: speakerSettingsManager,
                         api: api,
-                        userDocument: userDocument
+                        userDocument: userDocument,
+                        streamDocument: streamDocument
                     )
                     participantsViewModel.configure(
                         streamManager: streamManager,

apps/ios/LiveVideo/LiveVideo/Managers/API/CreateOrJoinStreamRequest.swift

@@ -8,26 +8,19 @@ struct CreateOrJoinStreamRequest: APIRequest {
     struct Parameters: Encodable {
         let userIdentity: String
         let streamName: String
+        let recordStream: Bool?
     }
 
     struct Response: Decodable {
-        struct SyncObjectNames: Decodable {
-            let speakersMap: String
-            let viewersMap: String
-            let raisedHandsMap: String
-            let userDocument: String?
-        }
-
         let token: String
-        let syncObjectNames: SyncObjectNames
     }
 
     let path: String
     let parameters: Parameters
     let responseType = Response.self
 
-    init(userIdentity: String, streamName: String, role: StreamConfig.Role) {
-        parameters = Parameters(userIdentity: userIdentity, streamName: streamName)
+    init(userIdentity: String, streamName: String, role: StreamConfig.Role, recordStream: Bool?) {
+        parameters = Parameters(userIdentity: userIdentity, streamName: streamName, recordStream: recordStream)
         path = role.path
     }
 }

apps/ios/LiveVideo/LiveVideo/Twilio/Room/LocalParticipantManager.swift

@@ -87,8 +87,8 @@ class LocalParticipantManager: NSObject {
     private(set) var micTrack: LocalAudioTrack?
     private(set) var cameraTrack: LocalVideoTrack?
     private let app = UIApplication.shared
+    private let authManager: AuthManager
     private var cameraSource: CameraSource?
-    private var authManager: AuthManager
 
     init(authManager: AuthManager) {
         self.authManager = authManager

apps/ios/LiveVideo/LiveVideo/Twilio/Stream/StreamConfig.swift

@@ -15,5 +15,15 @@ struct StreamConfig {
 
     let streamName: String
     let userIdentity: String
+    let shouldRecord: Bool?
     var role: Role
+
+    var hasUserDocument: Bool {
+        switch role {
+        case .host:
+            return false
+        case .speaker, .viewer:
+            return true
+        }
+    }
 }

apps/ios/LiveVideo/LiveVideo/Twilio/Stream/StreamManager.swift

@@ -109,33 +109,31 @@ class StreamManager: ObservableObject {
         let request = CreateOrJoinStreamRequest(
             userIdentity: config.userIdentity,
             streamName: config.streamName,
-            role: config.role
+            role: config.role,
+            recordStream: config.shouldRecord
         )
 
         api.request(request) { [weak self] result in
             switch result {
             case let .success(response):
-                let objectNames = SyncManager.ObjectNames(
-                    speakersMap: response.syncObjectNames.speakersMap,
-                    viewersMap: response.syncObjectNames.viewersMap,
-                    raisedHandsMap: response.syncObjectNames.raisedHandsMap,
-                    userDocument: response.syncObjectNames.userDocument
-                )
-
-                self?.connectSync(accessToken: response.token, objectNames: objectNames)
+                self?.connectSync(accessToken: response.token)
             case let .failure(error):
                 self?.handleError(error)
             }
         }
     }
 
-    private func connectSync(accessToken: String, objectNames: SyncManager.ObjectNames) {
+    private func connectSync(accessToken: String) {
         guard !syncManager.isConnected else {
             connectRoomOrPlayer(accessToken: accessToken)
             return
         }
 
-        syncManager.connect(token: accessToken, objectNames: objectNames) { [weak self] error in
+        syncManager.connect(
+            token: accessToken,
+            userIdentity: config.userIdentity,
+            hasUserDocument: config.hasUserDocument
+        ) { [weak self] error in
             if let error = error {
                 self?.handleError(error)
                 return