fix: Return file paths from recorders instead of URL (#3894)

* fix: return file paths from recorders

* docs: clarify VisionCamera file paths

Author: mrousavy

docs/content/docs/a-photo.mdx

@@ -53,6 +53,8 @@ const photo = ...
 const path = await photo.saveToTemporaryFileAsync()
 ```
 
+Photo file paths are plain filesystem paths, not `file://` URLs. If another library expects a URI, prepend `file://` at the call site.
+
 #### Saving to the Camera Roll
 
 After a [`Photo`](/api/react-native-vision-camera/hybrid-objects/Photo) has been saved to a file, you can save it to the user's Camera Roll using a library like [@react-native-camera-roll/camera-roll](https://github.com/react-native-cameraroll/react-native-cameraroll) or [expo-media-library](https://docs.expo.dev/versions/latest/sdk/media-library/).

docs/content/docs/photo-output.mdx

@@ -100,4 +100,6 @@ const { filePath } = await photoOutput.capturePhotoToFile(
 )
 ```
 
+`filePath` is a plain filesystem path, not a `file://` URL. If another library expects a URI, prepend `file://` at the call site.
+
 See [`CapturePhotoSettings`](/api/react-native-vision-camera/interfaces/CapturePhotoSettings) for a full list of configuration options, and [`CapturePhotoCallbacks`](/api/react-native-vision-camera/interfaces/CapturePhotoCallbacks) for a full list of callbacks for the capture method.

docs/content/docs/recorder.mdx

@@ -57,6 +57,8 @@ const interval = setInterval(() => {
 
 The [`Recorder`](/api/react-native-vision-camera/hybrid-objects/Recorder) also exposes metadata about its state - like [`isRecording`](/api/react-native-vision-camera/hybrid-objects/Recorder#isrecording), [`isPaused`](/api/react-native-vision-camera/hybrid-objects/Recorder#ispaused) and [`filePath`](/api/react-native-vision-camera/hybrid-objects/Recorder#filepath).
 
+`filePath` and the value passed to `onRecordingFinished` are plain filesystem paths instead of `file://` URLs; if another library expects a URI, prepend `file://` at the call site.
+
 ### Pausing/Resuming
 
 To pause/resume Video Recordings, use [`Recorder.pauseRecording()`](/api/react-native-vision-camera/hybrid-objects/Recorder#pauserecording)/[`Recorder.resumeRecording()`](/api/react-native-vision-camera/hybrid-objects/Recorder#resumerecording), which also fires the `onRecordingPaused`/`onRecordingResumed` callbacks previously passed to the [`Recorder.startRecording(...)`](/api/react-native-vision-camera/hybrid-objects/Recorder#startrecording) function:

packages/react-native-vision-camera/android/src/main/java/com/margelo/nitro/camera/hybrids/recording/HybridVideoRecorder.kt

@@ -81,8 +81,7 @@ class HybridVideoRecorder(
                 }
               if (finishReason != null) {
                 // Recording finished successfully - either no error, or file/duration limit reached:
-                val outputUri = event.outputResults.outputUri
-                onRecordingFinished(outputUri.toString(), finishReason)
+                onRecordingFinished(file.absolutePath, finishReason)
               } else {
                 // We have an error, either during capture or even while starting:
                 val error = VideoRecorderError(event.error, event.cause)

packages/react-native-vision-camera/ios/Hybrid Objects/Image Types/HybridPhoto.swift

@@ -111,9 +111,7 @@ final class HybridPhoto: HybridPhotoSpec, NativePhoto {
     guard let data = photo.fileDataRepresentation() else {
       throw RuntimeError.error(withMessage: "Failed to get file data representation of Photo!")
     }
-    guard let url = URL(string: path) else {
-      throw RuntimeError.error(withMessage: "The given path \"\(path)\" is not a valid URL!")
-    }
+    let url = URL(fileURLWithPath: path)
     try data.write(to: url)
   }
 
@@ -128,7 +126,7 @@ final class HybridPhoto: HybridPhotoSpec, NativePhoto {
       // 1. Create temp path
       let fileType = try self.containerFormat.toUTType()
       let file = try URL.createTempURL(fileType: fileType)
-      let path = file.absoluteString
+      let path = file.path
       // 2. Save image
       try self.saveImage(to: path)
       // 3. Return path

packages/react-native-vision-camera/ios/Hybrid Objects/Recording/HybridFrameRecorder.swift

@@ -88,7 +88,7 @@ final class HybridFrameRecorder: HybridRecorderSpec {
   }
 
   var filePath: String {
-    return fileURL.absoluteString
+    return fileURL.path
   }
 
   func initializeVideoTrack(withSettings settings: [String: Any]) throws {

packages/react-native-vision-camera/ios/Hybrid Objects/Recording/HybridVideoRecorder.swift

@@ -53,7 +53,7 @@ final class HybridVideoRecorder: HybridRecorderSpec {
     return Double(videoOutput.recordedFileSize)
   }
   var filePath: String {
-    return fileURL.absoluteString
+    return fileURL.path
   }
 
   func startRecording(
@@ -96,7 +96,7 @@ final class HybridVideoRecorder: HybridRecorderSpec {
             return
           }
           // Recording finished!
-          onRecordingFinished(url.absoluteString, reason)
+          onRecordingFinished(url.path, reason)
         },
         onRecordingError: { error in
           if !isResolved {

packages/react-native-vision-camera/src/specs/instances/Photo.nitro.ts

@@ -154,12 +154,15 @@ export interface Photo
    * Must contain a full path name including filename
    * and extension. All parent directories must exist,
    * but the file itself must not exist.
+   * This must be a filesystem path, not a `file://` URL.
    */
   saveToFileAsync(path: string): Promise<void>
   /**
    * Asynchronously saves this {@linkcode Photo} to
    * a temporary file using this {@linkcode containerFormat},
    * and returns the path it was saved at.
+   *
+   * The returned value is a filesystem path, not a `file://` URL.
    */
   saveToTemporaryFileAsync(): Promise<string>
   /**

packages/react-native-vision-camera/src/specs/outputs/CameraPhotoOutput.nitro.ts

@@ -230,6 +230,7 @@ export interface CapturePhotoSettings {
 export interface PhotoFile {
   /**
    * The path of the file.
+   * This is a filesystem path, not a `file://` URL.
    */
   filePath: string
 }

packages/react-native-vision-camera/src/specs/outputs/CameraVideoOutput.nitro.ts

@@ -147,6 +147,7 @@ export interface RecorderSettings {
    * The absolute path (including file name and extension) where
    * the recording file should be written to, or `undefined` to
    * create a file in the device's temporary directory.
+   * Pass a filesystem path, not a `file://` URL.
    *
    * All parent directories in this {@linkcode filePath} will
    * be automatically created if they do not yet exist.
@@ -232,6 +233,8 @@ export interface CameraVideoOutput extends CameraOutput {
    *
    * The {@linkcode Recorder} will record to the configured
    * file path, or to a temporary file if no path was provided.
+   * The {@linkcode Recorder}'s file paths are filesystem paths,
+   * not `file://` URLs.
    * It can only record once.
    *
    * If you want to create a second recording,