Merge pull request #1813 from HaishinKit/feature/recording-sample

Add recording feature for iOS Example.

Author: shogo4405

Examples/Examples.xcodeproj/project.pbxproj

@@ -870,8 +870,9 @@
 				GCC_C_LANGUAGE_STANDARD = gnu17;
 				GENERATE_INFOPLIST_FILE = YES;
 				INFOPLIST_KEY_CFBundleDisplayName = HaishinKit;
-				INFOPLIST_KEY_NSCameraUsageDescription = "";
-				INFOPLIST_KEY_NSMicrophoneUsageDescription = "";
+				INFOPLIST_KEY_NSCameraUsageDescription = "Camera access is requested for live streaming.";
+				INFOPLIST_KEY_NSMicrophoneUsageDescription = "Microphone access is requested for live streaming.";
+				INFOPLIST_KEY_NSPhotoLibraryUsageDescription = "Save the captured video and audio content.";
 				"INFOPLIST_KEY_UIApplicationSceneManifest_Generation[sdk=iphoneos*]" = YES;
 				"INFOPLIST_KEY_UIApplicationSceneManifest_Generation[sdk=iphonesimulator*]" = YES;
 				"INFOPLIST_KEY_UIApplicationSupportsIndirectInputEvents[sdk=iphoneos*]" = YES;
@@ -925,8 +926,9 @@
 				GCC_C_LANGUAGE_STANDARD = gnu17;
 				GENERATE_INFOPLIST_FILE = YES;
 				INFOPLIST_KEY_CFBundleDisplayName = HaishinKit;
-				INFOPLIST_KEY_NSCameraUsageDescription = "";
-				INFOPLIST_KEY_NSMicrophoneUsageDescription = "";
+				INFOPLIST_KEY_NSCameraUsageDescription = "Camera access is requested for live streaming.";
+				INFOPLIST_KEY_NSMicrophoneUsageDescription = "Microphone access is requested for live streaming.";
+				INFOPLIST_KEY_NSPhotoLibraryUsageDescription = "Save the captured video and audio content.";
 				"INFOPLIST_KEY_UIApplicationSceneManifest_Generation[sdk=iphoneos*]" = YES;
 				"INFOPLIST_KEY_UIApplicationSceneManifest_Generation[sdk=iphonesimulator*]" = YES;
 				"INFOPLIST_KEY_UIApplicationSupportsIndirectInputEvents[sdk=iphoneos*]" = YES;

Examples/iOS/PublishView.swift

@@ -59,24 +59,36 @@ struct PublishView: View {
                                 Text(source.description).tag(source)
                             }
                         }
+                        .frame(width: 200)
                         .background(Color.black.opacity(0.2))
                         .cornerRadius(16)
                         .padding(16)
                     }
                     Spacer()
-                    Button(action: { Task {
+                    Button(action: {
+                        model.toggleRecording()
+                    }, label: {
+                        Image(systemName: model.isRecording ?
+                                "recordingtape.circle.fill" :
+                                "recordingtape.circle")
+                            .resizable()
+                            .scaledToFit()
+                            .foregroundColor(.white)
+                            .frame(width: 30, height: 30)
+                    })
+                    Button(action: {
                         model.flipCamera()
-                    }}, label: {
+                    }, label: {
                         Image(systemName:
                                 "arrow.trianglehead.2.clockwise.rotate.90.camera")
                             .resizable()
                             .scaledToFit()
                             .foregroundColor(.white)
                             .frame(width: 30, height: 30)
                     })
-                    Button(action: { Task {
+                    Button(action: {
                         model.toggleTorch()
-                    }}, label: {
+                    }, label: {
                         Image(systemName: model.isTorchEnabled ?
                                 "flashlight.on.circle.fill" :
                                 "flashlight.off.circle.fill")

Examples/iOS/PublishViewModel.swift

@@ -1,5 +1,6 @@
 import AVFoundation
 import HaishinKit
+import Photos
 import RTCHaishinKit
 import SwiftUI
 
@@ -20,11 +21,13 @@ final class PublishViewModel: ObservableObject {
         }
     }
     @Published private(set) var audioSources: [AudioSource] = []
+    @Published private(set) var isRecording = false
     // If you want to use the multi-camera feature, please make create a MediaMixer with a capture mode.
     // let mixer = MediaMixer(captureSesionMode: .multi)
     private(set) var mixer = MediaMixer(captureSessionMode: .multi)
     private var tasks: [Task<Void, Swift.Error>] = []
     private var session: (any Session)?
+    private var recorder: StreamRecorder?
     private var currentPosition: AVCaptureDevice.Position = .back
     private var audioSourceService = AudioSourceService()
     @ScreenActor private var videoScreenObject: VideoTrackScreenObject?
@@ -65,6 +68,60 @@ final class PublishViewModel: ObservableObject {
         }
     }
 
+    func toggleRecording() {
+        if isRecording {
+            Task {
+                do {
+                    // To use this in a product, you need to consider recovery procedures in case moving to the Photo Library fails.
+                    if let videoFile = try await recorder?.stopRecording() {
+                        Task.detached {
+                            try await PHPhotoLibrary.shared().performChanges {
+                                let creationRequest = PHAssetCreationRequest.forAsset()
+                                creationRequest.addResource(with: .video, fileURL: videoFile, options: nil)
+                            }
+                        }
+                    }
+                } catch let error as StreamRecorder.Error {
+                    switch error {
+                    case .failedToFinishWriting(let error):
+                        self.error = error
+                        if let error {
+                            logger.warn(error)
+                        }
+                    default:
+                        self.error = error
+                        logger.warn(error)
+                    }
+                }
+                recorder = nil
+                isRecording = false
+            }
+        } else {
+            Task {
+                let recorder = StreamRecorder()
+                await mixer.addOutput(recorder)
+                do {
+                    // When starting a recording while connected to Xcode, it freezes for about 30 seconds. iOS26 + Xcode26.
+                    try await recorder.startRecording()
+                    isRecording = true
+                    self.recorder = recorder
+                } catch {
+                    self.error = error
+                    logger.warn(error)
+                }
+                for await error in await recorder.error {
+                    switch error {
+                    case .failedToAppend(let error):
+                        self.error = error
+                    default:
+                        self.error = error
+                    }
+                    break
+                }
+            }
+        }
+    }
+
     func makeSession(_ preference: PreferenceViewModel) async {
         // Make session.
         do {

HaishinKit/Sources/Stream/StreamRecorder.swift

@@ -85,6 +85,12 @@ public actor StreamRecorder {
     public var outputURL: URL? {
         return writer?.outputURL
     }
+    /// The current error.
+    public var error: AsyncStream<StreamRecorder.Error> {
+        AsyncStream { continuation in
+            self.continuation = continuation
+        }
+    }
     /// The recording or not.
     public private(set) var isRecording = false
     /// The the movie fragment interval in sec.
@@ -111,7 +117,11 @@ public actor StreamRecorder {
         return settings.count == writer.inputs.count
     }
     private var writer: AVAssetWriter?
-    private var continuation: AsyncStream<Error>.Continuation?
+    private var continuation: AsyncStream<Error>.Continuation? {
+        didSet {
+            oldValue?.finish()
+        }
+    }
     private var writerInputs: [AVMediaType: AVAssetWriterInput] = [:]
     private var audioPresentationTime: CMTime = .zero
     private var videoPresentationTime: CMTime = .zero
@@ -206,6 +216,7 @@ public actor StreamRecorder {
         }
         defer {
             isRecording = false
+            continuation = nil
             self.writer = nil
             self.writerInputs.removeAll()
         }