repository·main·Indexed 19 days ago
https://github.com/fluttercandies/flutter_wechat_camera_pickerA Flutter camera picker that provides a user interface mimicking WeChat's camera functionality. It supports photo capturing, video recording with duration limits, and exposure adjustments. The package integrates with photo_manager and the camera plugin, returning captured media as AssetEntity objects. It includes support for localization in English, Chinese, and Vietnamese, and allows for deep UI customization via CameraPickerState and CameraPickerViewerState.
The package reads the Locale? from your BuildContext to provide the corresponding language implementation.
Important: Ensure you can access the Locale via BuildContext, otherwise it will default to Chinese.
Built-in languages:
To use a custom or fixed language implementation, pass a CameraPickerTextDelegate to CameraPickerConfig.textDelegate.
The wechat_camera_picker package is built on top of the photo_manager plugin. To use the API effectively, you must understand two core concepts from photo_manager:
AssetEntity): Represents an individual media item (photo, video, or audio).AssetPathEntity): Represents a group of assets, such as an album or a device library.For detailed API information regarding these entities, refer to the photo_manager documentation.
The package automatically attempts to obtain the Locale? from your BuildContext to provide localized text.
Important: Ensure you have a valid Locale in your widget tree. If no valid Locale is found, the package defaults to Chinese (简体中文).
Supported embedded languages:
To use a custom or fixed language, pass a CameraPickerTextDelegate through CameraPickerConfig.textDelegate.
The wechat_camera_picker is strongly coupled with the photo_manager package. Most behaviors and data models are controlled by photo_manager. To use this picker effectively, you should understand the following core concepts from photo_manager:
AssetEntity: Represents a specific media resource (image, video, or audio).AssetPathEntity: Represents a collection of resources (such as an album or a specific media type group).You can implement custom user interfaces by overriding the following states:
CameraPickerStateCameraPickerViewerStateOnce you have implemented your custom state, you can use it when calling the picker or viewer:
CameraPicker.pickFromCamera(createPickerState: () => CustomCameraPickerState());CameraPickerViewer.pushToViewer(..., createViewerState: () => CustomCameraPickerViewerState());For deep UI customization, you can override and provide custom State classes for the picker and the viewer.
Supported states to override:
CameraPickerStateCameraPickerViewerStateTo use them, pass a factory function to the respective picking methods:
// For the camera picker
CameraPicker.pickFromCamera(
context,
createPickerState: () => CustomCameraPickerState(),
);
// For the viewer
CameraPickerViewer.pushToViewer(
context,
createViewerState: () => CustomCameraPickerViewerState(),
);```
// For the camera picker
CameraPicker.pickFromCamera(
context,
createPickerState: () => CustomCameraPickerState(),
);
// For the viewer
CameraPickerViewer.pushToViewer(
context,
createViewerState: () => CustomCameraPickerViewerState(),
);To change the launch screen image for the iOS version of the example app, you can either replace the image files directly in the example/ios/Runner/Assets.xcassets/LaunchImage.imageset/ directory or use Xcode.
To use Xcode:
open ios/Runner.xcworkspace.Runner/Assets.xcassets.open ios/Runner.xcworkspaceBefore using the package, you must complete the setup requirements for its underlying dependencies. Specifically, follow the preparation guides for:
You can install the package using the Flutter CLI or by manually adding it to your pubspec.yaml file.
To install via CLI:
flutter pub add wechat_camera_pickerTo add manually, include it in your dependencies section:
dependencies:
wechat_camera_picker: ^latest_versionIf you are extending CameraPickerState or overriding specific UI methods, you must update their signatures to match the new WeChat v8.3.0 style requirements in version 4.0.0. If you are not customizing these methods, no action is required.
Key changes include:
// Summary of signature changes in 4.0.0:
// 1. Rename
// restartDisplayModeDisplayTimer -> restartExposureModeDisplayTimer
// 2. buildBackButton
// Old: Widget buildBackButton(BuildContext context, BoxConstraints constraints)
// New:
Widget buildBackButton(BuildContext context)
// 3. buildCameraPreview
// Old: Widget buildCameraPreview(BuildContext context, DeviceOrientation orientation, BoxConstraints constraints)
// New:
Widget buildCameraPreview({
required BuildContext context,
required CameraValue cameraValue,
required BoxConstraints constraints,
})
// 4. buildCaptureButton
// Old: Widget buildCaptureButton(BoxConstraints constraints)
// New:
Widget buildCaptureButton(BuildContext context, BoxConstraints constraints)
// 5. buildFocusingPoint
// Old: Widget buildFocusingPoint(CameraValue cameraValue, BoxConstraints constraints)
// New:
Widget buildFocusingPoint({
required CameraValue cameraValue,
required BoxConstraints constraints,
int quarterTurns = 0,
})
// 6. buildForegroundBody
// Old: Widget buildForegroundBody(BuildContext context, BoxConstraints constraints)
// New:
Widget buildForegroundBody(
BuildContext context,
BoxConstraints constraints,
DeviceOrientation? deviceOrientation,
)Before using the picker, you must complete the setup requirements for its underlying dependencies. Specifically, follow the setup guides for:
photo_manager.If you encounter resolve conflict errors during flutter pub get, use dependency_overrides in your pubspec.yaml to resolve them.
To add the package to your Flutter project, run the following command in your terminal:
flutter pub add wechat_camera_pickerAlternatively, you can manually add it to your pubspec.yaml file:
dependencies:
wechat_camera_picker: ^latest_version