camera_awesome

Flutter plugin to add Camera support inside your project.

CamerAwesome include a lot of useful features like:

  • ? Live camera flip ( switch between rear & front camera without rebuild ).
  • ⚡️ No init needed, just add CameraAwesome widget !
  • ⌛️ Instant focus.
  • ? Device flash support.
  • ? Zoom.
  • ? Fullscreen or SizedBox preview support.
  • ? Complete example.
  • ? Taking a picture ( of course ? ).
  • ? Video recording (iOS only for now).

?  Live example

Taking photo ? & record video ? Resolution changing ?
camerawesome_example1
camerawesome_example2

?  Installation and usage

Set permissions

  • iOS add these on ios/Runner/Info.plist file
<key>NSCameraUsageDescription</key>
<string>Your own description</string>

<key>NSMicrophoneUsageDescription</key>
<string>To enable microphone access when recording video</string>
XML

  • Android

    • Set permissions before <application>

    <uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
    XML
    • Change the minimum SDK version to 21 (or higher) in android/app/build.gradle

    minSdkVersion 21

Import the package

import 'package:camerawesome/camerawesome_plugin.dart';
Dart

Define notifiers (if needed) & controller

ValueNotifier is a useful change notifier from Flutter framework. It fires an event on all listener when value changes.
Take a look here for ValueNotifier doc

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> with TickerProviderStateMixin {
  // [...]
  // Notifiers
  ValueNotifier<CameraFlashes> _switchFlash = ValueNotifier(CameraFlashes.NONE);
  ValueNotifier<Sensors> _sensor = ValueNotifier(Sensors.BACK);
  ValueNotifier<CaptureModes> _captureMode = ValueNotifier(CaptureModes.PHOTO);
  ValueNotifier<Size> _photoSize = ValueNotifier(null);

  // Controllers
  PictureController _pictureController = new PictureController();
  VideoController _videoController = new VideoController();
  // [...]
}
Dart

If you want to change a config, all you need is setting the value. CameraAwesome will handle the rest.

Examples:

_switchFlash.value = CameraFlashes.AUTO;
_captureMode.value = CaptureModes.VIDEO;
Dart

Create your camera

// [...]
@override
  Widget build(BuildContext context) {
    return CameraAwesome(
      testMode: false,
      onPermissionsResult: (bool result) { },
      selectDefaultSize: (List<Size> availableSizes) => Size(1920, 1080),
      onCameraStarted: () { },
      onOrientationChanged: (CameraOrientations newOrientation) { },
      zoom: 0.64,
      sensor: _sensor,
      photoSize: _photoSize,
      switchFlashMode: _switchFlash,
      captureMode: _captureMode,
      fitted: true,
    );
  };
// [...]
Dart
Reveal parameters list

Param Type Description Required
testMode boolean true to wrap texture
onPermissionsResult OnPermissionsResult implement this to have a callback after CameraAwesome asked for permissions
selectDefaultSize OnAvailableSizes implement this to select a default size from device available size list ✅
onCameraStarted OnCameraStarted notify client that camera started
onOrientationChanged OnOrientationChanged notify client that orientation changed
switchFlashMode **ValueNotifier**<CameraFlashes> change flash mode
zoom ValueNotifier<double> Zoom from native side. Must be between 0 and 1
sensor ValueNotifier<Sensors> sensor to initiate BACK or FRONT ✅
photoSize ValueNotifier<Size> choose your photo size from the [selectDefaultSize] method
captureMode ValueNotifier<CaptureModes> choose capture mode between PHOTO or VIDEO
fitted bool whether camera preview must be as big as it needs or cropped to fill with. false by default
imagesStreamBuilder Function returns an imageStream when camera has started preview

Photo ?

Take a photo ?

await _pictureController.takePicture('THE_IMAGE_PATH/myimage.jpg');
Dart

Video ?

Record a video ?

await _videoController.recordVideo('THE_IMAGE_PATH/myvideo.mp4');
Dart

Stop recording video ?

await _videoController.stopRecordingVideo();
Dart

?  Live image stream

The property imagesStreamBuilder allows you to get an imageStream once the camera is ready.
Don't try to show all these images on Flutter UI as you won't have time to refresh UI fast enough.
(there is too much images/sec).

CameraAwesome(
    ...
    imagesStreamBuilder: (imageStream) {
        /// listen for images preview stream
        /// you can use it to process AI recognition or anything else...
        print('-- init CamerAwesome images stream');
    },
)
Dart

?  Tested devices

CamerAwesome was developed to support most devices on the market but some feature can't be fully functional. You can check if your device support all feature by clicking bellow.

Feel free to contribute to improve this compatibility list.

Reveal grid

Devices Flash Focus Zoom Flip
iPhone 5s ✅ ✅ ✅ ✅
iPhone X ✅ ✅ ✅ ✅
iPhone 7 ✅ ✅ ✅ ✅
iPhone 12 Pro ✅ ✅ ✅ ✅
iPhone SE (2nd gen) ✅ ✅ ✅ ✅
One Plus 6T ✅ ✅ ✅ ✅
Xiaomi redmi ✅ ✅ ✅ ✅
Honor 7 ✅ ✅ ✅ ✅
Sony Xperia XZ F8331 ✅ ✅ ✅ ✅
Pixel 4 ✅ ✅ ✅ ✅
Galaxy S7 ✅ ✅ ✅ ✅
LG k50s ✅ ✅ ✅ ✅

?  Our goals

Feel free to help by submitting PR !

  • [ ] ? Record video (partially, iOS only)
  • [ ] ? Focus on specific point
  • [x] ? Broadcast live image stream
  • [x] ? Exposure level
  • [x] ✅ Add e2e tests
  • [x] ? Fullscreen/SizedBox support
  • [x] ? Complete example
  • [x] ? Take a picture
  • [x] ? Zoom level
  • [x] ? Live switching camera
  • [x] ? Device flash support
  • [x] ⌛️ Auto focus

GitHub

https://github.com/Apparence-io/camera_awesome