flutter_wechat_camera_picker
flutter_wechat_camera_picker copied to clipboard
A camera picker (take photos and videos) for Flutter projects based on WeChat's UI. It's a standalone module of wechat_assets_picker yet it can be run separately.
Flutter WeChat Camera Picker
Language: English | 中文简体
A camera picker which is an extension for
wechat_assets_picker.
Based on camera
for camera functions and photo_manager
for asset implementation.
Category 🗂
-
Flutter WeChat Camera Picker
- Category 🗂
- Features ✨
- Screenshots 📸
- Preparing for use 🍭
-
Usage 📖
- Simple usage
- With configurations
-
Frequently asked question 💭
- Why the orientation behavior is strange on iOS?
- Contributors ✨
Features ✨
- [x] 🔐 Non-nullable by default
- [x] 💚 99% similar to WeChat style
- [x] 📷 Picture taking support
- [x] ☀️ Exposure adjust support
- [x] 🔍️ Scale with pinch support
- [x] 🎥 Video recording support
- [x] ⏱ Duration limitation support
- [x] 🔍 Scale when recording support
- [x] 🖾 Foreground custom widget builder support
Screenshots 📸
![]() |
![]() |
---|---|
![]() |
![]() |
Preparing for use 🍭
Version constraints
Flutter SDK: >=2.0.0
.
Setup
Usage 📖
Simple usage
final AssetEntity? entity = await CameraPicker.pickFromCamera(context);
With configurations
Use CameraPickerConfig
for more picking behaviors.
final AssetEntity? entity = await CameraPicker.pickFromCamera(
context,
pickerConfig: const CameraPickerConfig(),
);
Fields in CameraPickerConfig
:
Name | Type | Description | Default Value |
---|---|---|---|
enableRecording | bool |
Whether the picker can record video. | false |
onlyEnableRecording | bool |
Whether the picker can only record video. Only available when enableRecording is true . |
false |
enableTapRecording | bool |
Whether allow the record can start with single tap. Only available when enableRecording is true . |
false |
enableAudio | bool |
Whether Whether the picker should record audio. Only available with recording. | true |
enableSetExposure | bool |
Whether users can set the exposure point by tapping. | true |
enableExposureControlOnPoint | bool |
Whether users can adjust exposure according to the set point. | true |
enablePinchToZoom | bool |
Whether users can zoom the camera by pinch. | true |
enablePullToZoomInRecord | bool |
Whether users can zoom by pulling up when recording video. | true |
shouldDeletePreviewFile | bool |
Whether the preview file will be delete when pop. | false |
shouldAutoPreviewVideo | bool |
Whether the video should be played instantly in the preview. | false |
maximumRecordingDuration | Duration |
The maximum duration of the video recording process. | const Duration(seconds: 15) |
theme | ThemeData? |
Theme data for the picker. | CameraPicker.themeData(wechatThemeColor) |
textDelegate | CameraPickerTextDelegate? |
Text delegate that controls text in widgets. | CameraPickerTextDelegate |
resolutionPreset | ResolutionPreset |
Present resolution for the camera. | ResolutionPreset.max |
cameraQuarterTurns | int |
The number of clockwise quarter turns the camera view should be rotated. | 0 |
imageFormatGroup | ImageFormatGroup |
Describes the output of the raw image format. | ImageFormatGroup.unknown |
preferredLensDirection | CameraLensDirection |
Which lens direction is preferred when first using the camera. | CameraLensDirection.back |
lockCaptureOrientation | DeviceOrientation? |
Whether the camera should be locked to the specific orientation during captures. | null |
foregroundBuilder | ForegroundBuilder? |
The foreground widget builder which will cover the whole camera preview. | null |
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 |
Using custom State
s
All user interface can be customized through custom State
s, including:
-
CameraPickerState
-
CameraPickerViewerState
After override State
s, pass them through the picking method, more specifically:
-
CameraPicker.pickFromCamera(createPickerState: () => CustomCameraPickerState());
-
CameraPickerViewer.pushToViewer(..., createViewerState: () => CustomCameraPickerViewerState());
Frequently asked question 💭
Why the orientation behavior is strange on iOS?
Currently, the preview is not correctly synced on the iOS. You can find more details in this issue: https://github.com/flutter/flutter/issues/89216 . Other than that, please submit issues to describe your question.
Contributors ✨
Thank goes to these wonderful people (emoji key):
Alex Li 💻 🎨 📖 💡 🤔 🚧 💬 👀 |
Caijinglong 💡 🤔 |
Lael 📖 |
mjl0602 💻 🤔 |
AliasWang 💻 🤔 |
leftcoding 🐛 |
Luong The Vinh 💻 |
luomo-pro ️️️️♿️ 🐛 |
LeonardoZhu 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!