Update to use new streaming interface methods

Adam Harwood · Adam Harwood · commit ab34ed8c59a2 · 2022-11-03T11:03:11.000+10:00
From PR flutter#6550
diff --git a/packages/camera/camera/pubspec.yaml b/packages/camera/camera/pubspec.yaml
@@ -23,7 +23,7 @@ flutter:
 dependencies:
   camera_android: ^0.10.1
   camera_avfoundation: ^0.10.0
-  camera_platform_interface: ^2.3.0
+  camera_platform_interface: ^2.3.1
   camera_web: ^0.3.1
   flutter:
     sdk: flutter
diff --git a/packages/camera/camera/test/camera_image_stream_test.dart b/packages/camera/camera/test/camera_image_stream_test.dart
@@ -216,18 +216,16 @@ class MockStreamingCameraPlatform extends MockCameraPlatform {
 
   @override
   Future<XFile> startVideoRecording(int cameraId,
-      {Duration? maxVideoDuration,
-      Function(CameraImageData image)? streamCallback,
-      CameraImageStreamOptions? streamOptions}) {
-    if (streamCallback == null) {
-      streamCallLog.add('startVideoRecording without stream');
-    } else {
-      streamCallLog.add('startVideoRecording with stream');
-    }
-    return super.startVideoRecording(cameraId,
-        maxVideoDuration: maxVideoDuration,
-        streamCallback: streamCallback,
-        streamOptions: streamOptions);
+      {Duration? maxVideoDuration}) {
+    streamCallLog.add('startVideoRecording');
+    return super
+        .startVideoRecording(cameraId, maxVideoDuration: maxVideoDuration);
+  }
+
+  @override
+  Future<void> startVideoCapturing(VideoCaptureOptions options) {
+    streamCallLog.add('startVideoCapturing');
+    return super.startVideoCapturing(options);
   }
 
   void _onFrameStreamListen() {
diff --git a/packages/camera/camera/test/camera_test.dart b/packages/camera/camera/test/camera_test.dart
@@ -1433,11 +1433,15 @@ class MockCameraPlatform extends Mock
 
   @override
   Future<XFile> startVideoRecording(int cameraId,
-          {Duration? maxVideoDuration,
-          Function(CameraImageData image)? streamCallback,
-          CameraImageStreamOptions? streamOptions}) =>
+          {Duration? maxVideoDuration}) =>
       Future<XFile>.value(mockVideoRecordingXFile);
 
+  @override
+  Future<void> startVideoCapturing(VideoCaptureOptions options) {
+    return startVideoRecording(options.cameraId,
+        maxVideoDuration: options.maxDuration);
+  }
+
   @override
   Future<void> lockCaptureOrientation(
           int? cameraId, DeviceOrientation? orientation) async =>
diff --git a/packages/camera/camera_android/example/lib/camera_controller.dart b/packages/camera/camera_android/example/lib/camera_controller.dart
@@ -308,8 +308,8 @@ class CameraController extends ValueNotifier<CameraValue> {
   /// Throws a [CameraException] if the capture fails.
   Future<void> startVideoRecording(
       {Function(CameraImageData image)? streamCallback}) async {
-    await CameraPlatform.instance
-        .startVideoRecording(_cameraId, streamCallback: streamCallback);
+    await CameraPlatform.instance.startVideoCapturing(
+        VideoCaptureOptions(_cameraId, streamCallback: streamCallback));
     value = value.copyWith(
         isRecordingVideo: true,
         isRecordingPaused: false,
diff --git a/packages/camera/camera_android/example/pubspec.yaml b/packages/camera/camera_android/example/pubspec.yaml
@@ -14,7 +14,7 @@ dependencies:
     # The example app is bundled with the plugin so we use a path dependency on
     # the parent directory to use the current plugin's version.
     path: ../
-  camera_platform_interface: ^2.2.0
+  camera_platform_interface: ^2.3.1
   flutter:
     sdk: flutter
   path_provider: ^2.0.0
diff --git a/packages/camera/camera_android/lib/src/android_camera.dart b/packages/camera/camera_android/lib/src/android_camera.dart
@@ -247,20 +247,24 @@ class AndroidCamera extends CameraPlatform {
 
   @override
   Future<void> startVideoRecording(int cameraId,
-      {Duration? maxVideoDuration,
-      Function(CameraImageData image)? streamCallback,
-      CameraImageStreamOptions? streamOptions}) async {
+      {Duration? maxVideoDuration}) async {
+    return startVideoCapturing(
+        VideoCaptureOptions(cameraId, maxDuration: maxVideoDuration));
+  }
+
+  @override
+  Future<void> startVideoCapturing(VideoCaptureOptions options) async {
     await _channel.invokeMethod<void>(
       'startVideoRecording',
       <String, dynamic>{
-        'cameraId': cameraId,
-        'maxVideoDuration': maxVideoDuration?.inMilliseconds,
-        'enableStream': streamCallback != null,
+        'cameraId': options.cameraId,
+        'maxVideoDuration': options.maxDuration?.inMilliseconds,
+        'enableStream': options.streamCallback != null,
       },
     );
 
-    if (streamCallback != null) {
-      _installStreamController().stream.listen(streamCallback);
+    if (options.streamCallback != null) {
+      _installStreamController().stream.listen(options.streamCallback);
       _startStreamListener();
     }
   }
diff --git a/packages/camera/camera_android/pubspec.yaml b/packages/camera/camera_android/pubspec.yaml
@@ -18,7 +18,8 @@ flutter:
         dartPluginClass: AndroidCamera
 
 dependencies:
-  camera_platform_interface: ^2.3.0
+  camera_platform_interface:
+    path: ../camera_platform_interface
   flutter:
     sdk: flutter
   flutter_plugin_android_lifecycle: ^2.0.2
diff --git a/packages/camera/camera_avfoundation/lib/src/avfoundation_camera.dart b/packages/camera/camera_avfoundation/lib/src/avfoundation_camera.dart
@@ -250,18 +250,24 @@ class AVFoundationCamera extends CameraPlatform {
       {Duration? maxVideoDuration,
       Function(CameraImageData image)? streamCallback,
       CameraImageStreamOptions? streamOptions}) async {
+    return startVideoCapturing(
+        VideoCaptureOptions(cameraId, maxDuration: maxVideoDuration));
+  }
+
+  @override
+  Future<void> startVideoCapturing(VideoCaptureOptions options) async {
     await _channel.invokeMethod<void>(
       'startVideoRecording',
       <String, dynamic>{
-        'cameraId': cameraId,
-        'maxVideoDuration': maxVideoDuration?.inMilliseconds,
-        'enableStream': streamCallback != null,
+        'cameraId': options.cameraId,
+        'maxVideoDuration': options.maxDuration?.inMilliseconds,
+        'enableStream': options.streamCallback != null,
       },
     );
 
-    if (streamCallback != null) {
+    if (options.streamCallback != null) {
       _frameStreamController = _createStreamController();
-      _frameStreamController!.stream.listen(streamCallback);
+      _frameStreamController!.stream.listen(options.streamCallback);
       _startStreamListener();
     }
   }
diff --git a/packages/camera/camera_avfoundation/pubspec.yaml b/packages/camera/camera_avfoundation/pubspec.yaml
@@ -17,7 +17,7 @@ flutter:
         dartPluginClass: AVFoundationCamera
 
 dependencies:
-  camera_platform_interface: ^2.3.0
+  camera_platform_interface: ^2.3.1
   flutter:
     sdk: flutter
   stream_transform: ^2.0.0
diff --git a/packages/camera/camera_platform_interface/CHANGELOG.md b/packages/camera/camera_platform_interface/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 2.3.1
+
+* Exports VideoCaptureOptions to allow dependencies to implement concurrent stream and record
+
 ## 2.3.0
 
 * Adds new capture method for a camera to allow concurrent streaming and recording.
diff --git a/packages/camera/camera_platform_interface/lib/src/method_channel/method_channel_camera.dart b/packages/camera/camera_platform_interface/lib/src/method_channel/method_channel_camera.dart
@@ -239,20 +239,24 @@ class MethodChannelCamera extends CameraPlatform {
 
   @override
   Future<void> startVideoRecording(int cameraId,
-      {Duration? maxVideoDuration,
-      Function(CameraImageData image)? streamCallback,
-      CameraImageStreamOptions? streamOptions}) async {
+      {Duration? maxVideoDuration}) async {
+    return startVideoCapturing(
+        VideoCaptureOptions(cameraId, maxDuration: maxVideoDuration));
+  }
+
+  @override
+  Future<void> startVideoCapturing(VideoCaptureOptions options) async {
     await _channel.invokeMethod<void>(
       'startVideoRecording',
       <String, dynamic>{
-        'cameraId': cameraId,
-        'maxVideoDuration': maxVideoDuration?.inMilliseconds,
-        'enableStream': streamCallback != null,
+        'cameraId': options.cameraId,
+        'maxVideoDuration': options.maxDuration?.inMilliseconds,
+        'enableStream': options.streamCallback != null,
       },
     );
 
-    if (streamCallback != null) {
-      _installStreamController().stream.listen(streamCallback);
+    if (options.streamCallback != null) {
+      _installStreamController().stream.listen(options.streamCallback);
       _startStreamListener();
     }
   }
diff --git a/packages/camera/camera_platform_interface/lib/src/types/types.dart b/packages/camera/camera_platform_interface/lib/src/types/types.dart
@@ -10,3 +10,4 @@ export 'flash_mode.dart';
 export 'focus_mode.dart';
 export 'image_format_group.dart';
 export 'resolution_preset.dart';
+export 'video_capture_options.dart';
diff --git a/packages/camera/camera_platform_interface/pubspec.yaml b/packages/camera/camera_platform_interface/pubspec.yaml
@@ -4,7 +4,7 @@ repository: https://github.com/flutter/plugins/tree/main/packages/camera/camera_
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+camera%22
 # NOTE: We strongly prefer non-breaking changes, even at the expense of a
 # less-clean API. See https://flutter.dev/go/platform-interface-breaking-changes
-version: 2.3.0
+version: 2.3.1
 
 environment:
   sdk: '>=2.12.0 <3.0.0'
diff --git a/packages/camera/camera_web/lib/src/camera_web.dart b/packages/camera/camera_web/lib/src/camera_web.dart
@@ -450,31 +450,34 @@ class CameraPlugin extends CameraPlatform {
   }
 
   @override
-  Future<void> startVideoRecording(int cameraId,
-      {Duration? maxVideoDuration,
-      Function(CameraImageData image)? streamCallback,
-      CameraImageStreamOptions? streamOptions}) {
-    if (streamCallback != null || streamOptions != null) {
+  Future<void> startVideoRecording(int cameraId, {Duration? maxVideoDuration}) {
+    return startVideoCapturing(
+        VideoCaptureOptions(cameraId, maxDuration: maxVideoDuration));
+  }
+
+  @override
+  Future<void> startVideoCapturing(VideoCaptureOptions options) {
+    if (options.streamCallback != null || options.streamOptions != null) {
       throw UnimplementedError('Streaming is not currently supported on web');
     }
 
     try {
-      final Camera camera = getCamera(cameraId);
+      final Camera camera = getCamera(options.cameraId);
 
       // Add camera's video recording errors to the camera events stream.
       // The error event fires when the video recording is not allowed or an unsupported
       // codec is used.
-      _cameraVideoRecordingErrorSubscriptions[cameraId] =
+      _cameraVideoRecordingErrorSubscriptions[options.cameraId] =
           camera.onVideoRecordingError.listen((html.ErrorEvent errorEvent) {
         cameraEventStreamController.add(
           CameraErrorEvent(
-            cameraId,
+            options.cameraId,
             'Error code: ${errorEvent.type}, error message: ${errorEvent.message}.',
           ),
         );
       });
 
-      return camera.startVideoRecording(maxVideoDuration: maxVideoDuration);
+      return camera.startVideoRecording(maxVideoDuration: options.maxDuration);
     } on html.DomException catch (e) {
       throw PlatformException(code: e.name, message: e.message);
     } on CameraWebException catch (e) {
diff --git a/packages/camera/camera_web/pubspec.yaml b/packages/camera/camera_web/pubspec.yaml
@@ -17,7 +17,7 @@ flutter:
         fileName: camera_web.dart
 
 dependencies:
-  camera_platform_interface: ^2.3.0
+  camera_platform_interface: ^2.3.1
   flutter:
     sdk: flutter
   flutter_web_plugins:
diff --git a/packages/camera/camera_windows/lib/camera_windows.dart b/packages/camera/camera_windows/lib/camera_windows.dart
@@ -215,19 +215,23 @@ class CameraWindows extends CameraPlatform {
 
   @override
   Future<void> startVideoRecording(int cameraId,
-      {Duration? maxVideoDuration,
-      Function(CameraImageData image)? streamCallback,
-      CameraImageStreamOptions? streamOptions}) async {
-    if (streamCallback != null || streamOptions != null) {
+      {Duration? maxVideoDuration}) async {
+    return startVideoCapturing(
+        VideoCaptureOptions(cameraId, maxDuration: maxVideoDuration));
+  }
+
+  @override
+  Future<void> startVideoCapturing(VideoCaptureOptions options) async {
+    if (options.streamCallback != null || options.streamOptions != null) {
       throw UnimplementedError(
           'Streaming is not currently supported on Windows');
     }
 
     await pluginChannel.invokeMethod<void>(
       'startVideoRecording',
       <String, dynamic>{
-        'cameraId': cameraId,
-        'maxVideoDuration': maxVideoDuration?.inMilliseconds,
+        'cameraId': options.cameraId,
+        'maxVideoDuration': options.maxDuration?.inMilliseconds,
       },
     );
   }
diff --git a/packages/camera/camera_windows/pubspec.yaml b/packages/camera/camera_windows/pubspec.yaml
@@ -17,7 +17,7 @@ flutter:
         dartPluginClass: CameraWindows
 
 dependencies:
-  camera_platform_interface: ^2.3.0
+  camera_platform_interface: ^2.3.1
   cross_file: ^0.3.1
   flutter:
     sdk: flutter
