Mattia Iavarone
f43af464f9
|
7 years ago | |
---|---|---|
camerakit | 7 years ago | |
demo | 8 years ago | |
gradle/wrapper | 8 years ago | |
.gitignore | 8 years ago | |
LICENSE | 8 years ago | |
README.md | 7 years ago | |
build.gradle | 8 years ago | |
gradle.properties | 8 years ago | |
gradlew | 8 years ago | |
gradlew.bat | 8 years ago | |
settings.gradle | 8 years ago |
README.md
A fork of Dylan McIntyre's CameraKit-Android library, originally a fork of Google's CameraView library.
CameraKit
CameraKit is an easy to use utility to work with the Android Camera APIs. Everything at the moment is work in progress, but it works well for pictures at least.
Table of Contents
Features
- Image and video capture seamlessly working with the same preview session. (TODO: remove this, use different sessions)
- System permission handling
- Dynamic sizing behavior
- Create a
CameraView
of any size (not just presets!)... - Or let it adapt to the sensor preview size
- Automatic output cropping to match your
CameraView
bounds
- Create a
- Multiple capture methods
CAPTURE_METHOD_STANDARD
: an image captured normally using the camera APIs.CAPTURE_METHOD_FRAME
: a freeze frame of theCameraView
preview (similar to SnapChat and Instagram) for devices with slower cameras
- Built-in tap to focus
- TODO: Built-in pinch to zoom
Setup
For now, clone the repo and add it to your project. TODO: publish to bintray.
Usage
To use CameraKit, simply add a CameraView
to your layout:
<com.flurgle.camerakit.CameraView
android:id="@+id/camera"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:adjustViewBounds="true" />
Make sure you override onResume
, onPause
and onDestroy
in your activity, and call CameraView.start()
, stop()
and destroy()
.
@Override
protected void onResume() {
super.onResume();
cameraView.start();
}
@Override
protected void onPause() {
super.onPause();
cameraView.stop();
}
@Override
protected void onDestroy() {
super.onDestroy();
cameraView.destroy();
}
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) {
// Create a bitmap or a file...
Bitmap result = BitmapFactory.decodeByteArray(picture, 0, picture.length);
}
});
camera.captureImage();
Capturing Video
TODO: test size and orientation stuff.
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) {
// The File parameter is an MP4 file.
}
});
camera.startRecordingVideo();
camera.postDelayed(new Runnable() {
@Override
public void run() {
camera.stopRecordingVideo();
}
}, 2500);
Other camera events
Make sure you can react to different camera events by setting up a CameraListener
instance.
camera.setCameraListener(new CameraListener() {
@Override
public void onCameraOpened() {}
@Override
public void onCameraClosed() {}
@Override
public void onPictureTaken(byte[] picture) {}
@Override
public void onVideoTaken(File video) {}
});
Extra Attributes
<com.flurgle.camerakit.CameraView xmlns:app="http://schemas.android.com/apk/res-auto"
android:id="@+id/camera"
android:layout_width="match_parent"
android:layout_height="wrap_content"
app:cameraFacing="back"
app:cameraFlash="off"
app:cameraFocus="continuous"
app:cameraCaptureMethod="standard"
app:cameraZoom="pinch"
app:cameraPermissionPolicy="strict"
app:cameraCropOutput="true"
app:cameraJpegQuality="100"
app:cameraVideoQuality="480p"
android:adjustViewBounds="true" />
XML Attribute | Method | Values | Default Value |
---|---|---|---|
cameraFacing |
setFacing() |
back front |
back |
cameraFlash |
setFlash() |
off on auto torch |
off |
cameraFocus |
setFocus() |
off continuous tap tapWithMarker |
continuous |
cameraCaptureMethod |
setCaptureMethod() |
standard frame |
standard |
cameraZoomMode |
setZoom() |
off pinch |
off |
cameraPermissionPolicy |
setPermissionPolicy() |
picture video |
picture |
cameraCropOutput |
setCropOutput() |
true false |
false |
cameraJpegQuality |
setJpegQuality() |
0 <= n <= 100 |
100 |
cameraVideoQuality |
setVideoQuality() |
max480p max720p max1080p max2160p highest lowest |
max480p |
cameraFacing
Which camera to use, either back facing or front facing.
cameraView.setFacing(CameraKit.Constants.FACING_BACK);
cameraView.setFacing(CameraKit.Constants.FACING_FRONT);
cameraFlash
Flash mode, either off, on, auto or torch.
cameraView.setFlash(CameraKit.Constants.FLASH_OFF);
cameraView.setFlash(CameraKit.Constants.FLASH_ON);
cameraView.setFlash(CameraKit.Constants.FLASH_AUTO);
cameraView.setFlash(CameraKit.Constants.FLASH_TORCH);
cameraFocus
Focus behavior. Can be off, continuous (camera continuously tries to adapt its focus), tap (focus is driven by the user tap) and tapWithMarker (a marker is drawn on screen to indicate focusing).
cameraView.setFocus(CameraKit.Constants.FOCUS_OFF);
cameraView.setFocus(CameraKit.Constants.FOCUS_CONTINUOUS);
cameraView.setFocus(CameraKit.Constants.FOCUS_TAP);
cameraView.setFocus(CameraKit.Constants.FOCUS_TAP_WITH_MARKER);
cameraCaptureMethod
How to capture pictures, either standard or frame. The frame option lets you capture and save a preview frame, which can be better with slower camera sensors, though the captured image can be blurry or noisy.
cameraView.setMethod(CameraKit.Constants.CAPTURE_METHOD_STANDARD);
cameraView.setMethod(CameraKit.Constants.CAPTURE_METHOD_FRAME);
cameraZoomMode
TODO: work in progress. Right now 'off' is the onlly option.
cameraView.setZoom(CameraKit.Constants.ZOOM_OFF);
cameraView.setZoom(CameraKit.Constants.ZOOM_PINCH);
cameraPermissionPolicy
Either picture or video. This tells the library which permissions should be asked before starting the camera session. In the case of 'picture', we require the camera permissions. In the case of 'video', the record audio permission is asked as well.
Please note that, if needed, the latter should be added to your manifest file or the app will crash.
cameraView.setPermissions(CameraKit.Constants.PERMISSIONS_PICTURE);
cameraView.setPermissions(CameraKit.Constants.PERMISSIONS_VIDEO);
cameraCropOutput
Wheter the output file should be cropped to fit the aspect ratio of the preview surface. This can guarantee consistency between what the user sees and the final output, if you fixed the camera view dimensions.
cameraJpegQuality
Sets the JPEG quality of pictures.
cameraView.setJpegQuality(100);
cameraView.setJpegQuality(50);
cameraVideoQuality
Sets the desired video quality.
cameraView.setVideoQuality(CameraKit.Constants.VIDEO_QUALITY_480P);
cameraView.setVideoQuality(CameraKit.Constants.VIDEO_QUALITY_720P);
cameraView.setVideoQuality(CameraKit.Constants.VIDEO_QUALITY_1080P);
cameraView.setVideoQuality(CameraKit.Constants.VIDEO_QUALITY_2160P);
cameraView.setVideoQuality(CameraKit.Constants.VIDEO_QUALITY_LOWEST);
cameraView.setVideoQuality(CameraKit.Constants.VIDEO_QUALITY_HIGHEST);
cameraView.setVideoQuality(CameraKit.Constants.VIDEO_QUALITY_QVGA);
Permissions behavior
CameraView
needs two permissions:
android.permission.CAMERA
: requiredandroid.permission.RECORD_AUDIO
: required for capturing videos
You can handle permissions yourself and then call CameraView.start()
once they are acquired. If they are not, CameraView
will request permissions to the user based on the permissionPolicy
that was set. In that case, you can restart the camera if you have a successful response from onRequestPermissionResults()
.
Manifest file
The library manifest file is not strict and only asks for camera permissions. This means that:
- If you wish to record videos, you should also add
android.permission.RECORD_AUDIO
to required permissions
<uses-permission android:name="android.permission.RECORD_AUDIO"/>
- If you want your app to be installed only on devices that have a camera, you should add:
<uses-feature
android:name="android.hardware.camera"
android:required="true"/>
If you don't request this feature, you can use CameraKit.hasCameras()
to detect if current device has cameras, and then start the camera view.
Dynamic Sizing Behavior
Center crop
You can setup the CameraView
dimensions as you wish. Default behavior is that if your dimensions don't match the aspect ratio of the internal preview surface, the surface will be cropped to fill the view, just like android:scaleType="centerCrop"
on an ImageView
.
Center inside
If android:adjustViewBounds
is set to true the library will try to adapt the view dimension to the chosen preview size. How? All dimensions set to wrap_content
are streched out to ensure the view holds the whole preview. If both dimensions are wrap_content
, this is exactly like android:scaleType="centerInside"
on an ImageView
.