✨ Introduce onXFileCaptured (#87)

Co-authored-by: Alex Li <[email protected]>

Author: ZhuBoao

README-ZH.md

@@ -118,6 +118,7 @@ final AssetEntity? entity = await CameraPicker.pickFromCamera(
 | previewTransformBuilder      | `PreviewTransformBuilder?`  | 对相机预览做变换的构建                                        | null                                   |
 | onEntitySaving               | `EntitySaveCallback?`       | 在查看器中保存图片时的回调                                      | null                                   |
 | onError                      | `CameraErrorHandler?`       | 拍摄照片过程中的自定义错误处理                                    | null                                   |
+| onXFileCaptured              | `XFileCapturedCallback?`    | 拍摄文件生成后的回调                                         | null                                   |
 
 ## 常见问题 💭
 

README.md

@@ -103,6 +103,7 @@ Fields in `CameraPickerConfig`:
 | previewTransformBuilder      | `PreviewTransformBuilder?`  | The widget builder which will transform the camera preview.                                           | null                                   |
 | onEntitySaving               | `EntitySaveCallback?`       | The callback type define for saving entity in the viewer.                                             | null                                   |
 | onError                      | `CameraErrorHandler?`       | The error handler when any error occurred during the picking process.                                 | null                                   |
+| onXFileCaptured              | `XFileCapturedCallback?`    | The callback type definition when the XFile is captured by the camera.                                | null                                   |
 
 ## Frequently asked question 💭
 

lib/src/constants/config.dart

@@ -37,6 +37,7 @@ class CameraPickerConfig {
     this.previewTransformBuilder,
     this.onEntitySaving,
     this.onError,
+    this.onXFileCaptured,
   }) : assert(
           enableRecording == true || onlyEnableRecording != true,
           'Recording mode error.',
@@ -137,4 +138,7 @@ class CameraPickerConfig {
 
   /// {@macro wechat_camera_picker.CameraErrorHandler}
   final CameraErrorHandler? onError;
+
+  /// {@macro wechat_camera_picker.XFileCapturedCallback}
+  final XFileCapturedCallback? onXFileCaptured;
 }

lib/src/constants/type_defs.dart

@@ -5,7 +5,7 @@
 import 'dart:async' show FutureOr;
 import 'dart:io' show File;
 
-import 'package:camera/camera.dart' show CameraController, CameraValue;
+import 'package:camera/camera.dart' show CameraController, CameraValue, XFile;
 import 'package:flutter/widgets.dart' show BuildContext, Widget;
 
 import 'enums.dart';
@@ -58,3 +58,16 @@ typedef PreviewTransformBuilder = Widget? Function(
   CameraController controller,
   Widget child,
 );
+
+/// {@template wechat_camera_picker.XFileCapturedCallback}
+/// The callback type definition when the XFile is captured by the camera.
+/// 拍摄文件生成后的回调
+///
+/// ### Notice about the implementation
+///  * After the callback is implemented, the default viewer page 
+///    will not be pushed anymore.
+///
+/// ### 在实现时需要注意
+///  * 实现该方法后，默认的的预览页面不会再出现。
+/// {@endtemplate}
+typedef XFileCapturedCallback = void Function(XFile, CameraPickerViewType);

lib/src/widgets/camera_picker.dart

@@ -654,6 +654,10 @@ class CameraPickerState extends State<CameraPicker>
           _controller = null;
         });
       });
+      if (config.onXFileCaptured != null) {
+        config.onXFileCaptured!(_file, CameraPickerViewType.image);
+        return;
+      }
       final AssetEntity? entity = await _pushToViewer(
         file: _file,
         viewType: CameraPickerViewType.image,
@@ -741,24 +745,29 @@ class CameraPickerState extends State<CameraPicker>
     }
 
     if (controller.value.isRecordingVideo) {
-      controller.stopVideoRecording().then((XFile file) async {
+      try {
+        final XFile file = await controller.stopVideoRecording();
+        if (config.onXFileCaptured != null) {
+          config.onXFileCaptured!(file, CameraPickerViewType.video);
+          return;
+        }
         final AssetEntity? entity = await _pushToViewer(
           file: file,
           viewType: CameraPickerViewType.video,
         );
         if (entity != null) {
           Navigator.of(context).pop(entity);
         }
-      }).catchError((Object e) {
+      } catch (e) {
         realDebugPrint('Error when stop recording video: $e');
         realDebugPrint('Try to initialize a new CameraController...');
         initCameras();
         _handleError();
         handleErrorWithHandler(e, config.onError);
-      }).whenComplete(() {
+      } finally {
         isShootingButtonAnimate = false;
         safeSetState(() {});
-      });
+      }
       return;
     }
     _handleError();
@@ -1275,7 +1284,9 @@ class CameraPickerState extends State<CameraPicker>
         onScaleUpdate: enablePinchToZoom ? _handleScaleUpdate : null,
         // Enabled cameras switching by default if we have multiple cameras.
         onDoubleTap: cameras.length > 1 ? switchCameras : null,
-        child: CameraPreview(controller),
+        child: _controller != null
+            ? CameraPreview(controller)
+            : const SizedBox.shrink(),
       ),
     );