v0.13.2
v1.0.0-beta3.11v1.0.0-beta3.10v1.0.0-beta3.9v0.13.4v0.13.2

CameraKit Documentation - v0.13.2

  1. Setup
  2. Usage
  3. Capturing Images
  4. CameraView Attributes
  5. Permissions
  6. Sizing
  7. Events

Setup

Add CameraKit to the dependencies block in your app level build.gradle:

compile 'com.wonderkiln:camerakit:0.13.2'

Usage

To use CameraKit, simply add a CameraView to your layout:

<com.wonderkiln.camerakit.CameraView
    android:id="@+id/camera"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:adjustViewBounds="true" />

Make sure you override onResume and onPause in your activity, and make calls respectively to CameraView.start() and CameraView.stop().

@Override
protected void onResume() {
    super.onResume();
    cameraView.start();
}

@Override
protected void onPause() {
    cameraView.stop();
    super.onPause();
}

Capturing Images

To capture an image just call CameraView.captureImage(). Make sure you setup a CameraListener to handle the image callback.

camera.setCameraListener(new CameraListener() {
    @Override
    public void onPictureTaken(byte[] picture) {
        super.onPictureTaken(picture);

        // Create a bitmap    
        Bitmap result = BitmapFactory.decodeByteArray(picture, 0, picture.length);
    }
 });

camera.captureImage();

Capturing Video

To capture video just call CameraView.startRecordingVideo() to start, and CameraView.stopRecordingVideo() to finish. Make sure you setup a CameraListener to handle the video callback.

camera.setCameraListener(new CameraListener() {
    @Override
    public void onVideoTaken(File video) {
        super.onVideoTaken(video);
        // The File parameter is an MP4 file.
    }
});

camera.startRecordingVideo();
camera.postDelayed(new Runnable() {
    @Override
    public void run() {
        camera.stopRecordingVideo();
    }
}, 2500);

Other Methods

cameraView.stopVideo();
Size cameraView.getPreviewSize();
Size cameraView.getCaptureSize();

CameraView Attributes

<com.flurgle.camerakit.CameraView xmlns:camerakit="http://schemas.android.com/apk/res-auto"
    android:id="@+id/camera"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    camerakit:ckFacing="back"
    camerakit:ckFlash="off"
    camerakit:ckFocus="continuous"
    camerakit:ckMethod="standard"
    camerakit:ckZoom="pinch"
    camerakit:ckPermissions="strict"
    camerakit:ckCropOutput="true"  
    camerakit:ckJpegQuality="100"
    camerakit:ckVideoQuality="480p"
    android:adjustViewBounds="true" />
Attribute Values Default Value
ckFacing back front back
ckFlash off on auto off
ckFocus off continuous tap continuous
ckMethod standard still speed standard
ckZoom off pinch off
ckPermissions strict lazy picture strict`
ckCropOutput true false false
ckJpegQuality 0 <= n <= 100 100
ckVideoQuality max480p max720p max1080p max2160p highest lowest max480p

ckFacing

back front

back

cameraView.setFacing(CameraKit.Constants.FACING_BACK);

front

cameraView.setFacing(CameraKit.Constants.FACING_FRONT);

Other Methods

int cameraView.getFacing()
boolean cameraView.isFacingFront()
boolean cameraView.isFacingBack()

ckFlash

off on auto torch

off

cameraView.setFlash(CameraKit.Constants.FLASH_OFF);

on

cameraView.setFlash(CameraKit.Constants.FLASH_ON);

auto

cameraView.setFlash(CameraKit.Constants.FLASH_AUTO);

torch

cameraView.setFlash(CameraKit.Constants.FLASH_TORCH);

Other Methods

int getFlash()

ckFocus

off continuous tap

off

cameraView.setFocus(CameraKit.Constants.FOCUS_OFF);

continuous

cameraView.setFocus(CameraKit.Constants.FOCUS_CONTINUOUS);

tap

cameraView.setFocus(CameraKit.Constants.FOCUS_TAP);

ckMethod

standard still speed

standard

cameraView.setMethod(CameraKit.Constants.METHOD_STANDARD);

When you use METHOD_STANDARD (camerakit:ckMethod="standard"), images will be captured using the normal camera API capture method using the shutter.

still

cameraView.setMethod(CameraKit.Constants.METHOD_STILL);

When you use METHOD_STILL (camerakit:ckMethod="still"), images will be captured by grabbing a single frame from the preview. This behavior is the same as SnapChat and Instagram. This method has a higher rate of motion blur but can be a better experience for users with slower cameras.

speed


ckZoom

off pinch

off

cameraView.setZoom(CameraKit.Constants.ZOOM_OFF);

pinch

cameraView.setZoom(CameraKit.Constants.ZOOM_PINCH);

ckPermissions

strict lazy picture

strict

cameraView.setPermissions(CameraKit.Constants.PERMISSIONS_STRICT);

lazy

cameraView.setPermissions(CameraKit.Constants.PERMISSIONS_LAZY);

picture

cameraView.setPermissions(CameraKit.Constants.PERMISSIONS_PICTURE);

ckCropOutput

true false

true

cameraView.setCropOutput(true);

false

cameraView.setCropOutput(false);

ckJpegQuality

cameraView.setJpegQuality(100);

ckVideoQuality

max480p max720p max1080p max2160p lowest highest qvga

max480p

cameraView.setVideoQuality(CameraKit.Constants.VIDEO_QUALITY_480P);

max720p

cameraView.setVideoQuality(CameraKit.Constants.VIDEO_QUALITY_720P);

max1080p

cameraView.setVideoQuality(CameraKit.Constants.VIDEO_QUALITY_1080P);

max2160p

cameraView.setVideoQuality(CameraKit.Constants.VIDEO_QUALITY_2160P);

lowest

cameraView.setVideoQuality(CameraKit.Constants.VIDEO_QUALITY_LOWEST);

highest

cameraView.setVideoQuality(CameraKit.Constants.VIDEO_QUALITY_HIGHEST);

qvga

cameraView.setVideoQuality(CameraKit.Constants.VIDEO_QUALITY_QVGA);

ckVideoBitRate

int bitRate

bitRate

cameraView.setVideoBitrate(CameraKit.Constants.VIDEO_QUALITY_480P);

Automatic Permissions Behavior

You can handle permissions yourself in whatever way you want, but if you make a call to CameraView.start() without the android.permission.CAMERA permission, an exception would normally be thrown and your app would crash.

With CameraKit, we will automatically prompt for the android.permission.CAMERA permission if it's not available. If you want to handle it yourself, just make sure you don't call CameraView.start() until you acquire the permissions.

Dynamic Sizing Behavior

You can setup the CameraView dimensions however you want. When your dimensions don't match the aspect ratio of the internal preview surface, the surface will be cropped minimally to fill the view. The behavior is the same as the android:scaleType="centerCrop" on an ImageView.

adjustViewBounds

You can use a mix of a fixed dimension (a set value or match_parent) as well as wrap_content. When you do this make sure you set android:adjustViewBounds="true" on the CameraView.

When you do this the dimension set to wrap_content will automatically align with the true aspect ratio of the preview surface. In this case the whole preview will be visible with no cropping.

Events

Make sure you can react to different camera events by setting up a CameraListener instance.

camera.setCameraListener(new CameraListener() {

    @Override
    public void onCameraOpened() {
        super.onCameraOpened();
    }

    @Override
    public void onCameraClosed() {
        super.onCameraClosed();
    }

    @Override
    public void onPictureTaken(byte[] picture) {
        super.onPictureTaken(picture);
    }

    @Override
    public void onVideoTaken(File video) {
        super.onVideoTaken(video);
    }

});