You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
CameraView/docs/_posts/2018-12-20-getting-started.md

147 lines
3.9 KiB

---
layout: page
title: "Getting Started"
subtitle: "Simple guide to take your first picture"
category: about
date: 2018-12-20 17:48:58
order: 2
---
To use the CameraView engine, simply add a `CameraView` to your layout:
```xml
<com.otaliastudios.cameraview.CameraView
android:id="@+id/camera"
android:keepScreenOn="true"
android:layout_width="wrap_content"
android:layout_height="wrap_content" />
```
This is the one and only interface to the engine, and is meant to be hosted inside a UI component
like `Fragment` or `Activity`. The camera component is bound to the host lifecycle, so, as soon as possible,
you should register the host:
```java
// For activities
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
CameraView camera = findViewById(R.id.camera);
camera.setLifecycleOwner(this);
}
// For fragments
@Override
public void onViewCreated(View view, Bundle savedInstanceState) {
super.onViewCreated(view, savedInstanceState);
CameraView camera = findViewById(R.id.camera);
camera.setLifecycleOwner(getViewLifecycleOwner());
}
```
Can't resolve the lifecycle owner interface? Read [below](#without-support-libraries).
### Set up a CameraListener
The next thing to do is to add a new `CameraListener` to be notified about camera events.
You can do this on a per-action basis, but it's easier to just add one when the UI is created:
```java
camera.addCameraListener(new CameraListener() {
@Override
public void onPictureTaken(PictureResult result) {
// A Picture was taken!
}
@Override
public void onVideoTaken(VideoResult result) {
// A Video was taken!
}
// And much more
})
```
### Take a picture
We're done. To take a picture upon user input, just call `takePicture()`.
```java
camera.addCameraListener(new CameraListener() {
@Override
public void onPictureTaken(PictureResult result) {
// Picture was taken!
// If planning to save a file, just get the jpeg array.
byte[] jpeg = result.getJpeg();
// If planning to show a Bitmap, we will take care of
// EXIF rotation and background threading for you...
result.asBitmap(maxWidth, maxHeight, callback);
}
});
camera.takePicture();
```
Read the docs about `takePictureSnapshot()` for a super fast, lower quality alternative.
### Take a video
Taking a video is just the same thing, except that you must make sure that camera is in `Mode.VIDEO` mode,
and that you have write permissions to write the file:
```java
camera.addCameraListener(new CameraListener() {
@Override
public void onVideoTaken(VideoResult result) {
// Video was taken!
// Use result.getFile() to access a file holding
// the recorded video.
}
});
// Select output file. Make sure you have write permissions.
camera.setMode(Mode.VIDEO);
camera.takeVideo(file);
// Later... stop recording. This will trigger onVideoTaken().
camera.stopVideo();
```
Read the docs about `takeVideoSnapshot()` for a super fast, lower quality alternative.
### Configuration and more
This was it, but there is a ton of other options available to customize the camera behavior,
to control the sensor, the UI appearance, the quality and size of the output, or to live process
frames. Keep reading the documentation!
For runtime permissions and Manifest setup, please read the [permissions page]().
### Without support libraries
If you are not using support libraries and you can't resolve the LifecycleOwner interface,
make sure you override `onResume`, `onPause` and `onDestroy` in your activity (`onDestroyView`
in your fragment), and call `CameraView.open()`, `close()` and `destroy()`.
```java
@Override
protected void onResume() {
super.onResume();
cameraView.open();
}
@Override
protected void onPause() {
super.onPause();
cameraView.close();
}
@Override
protected void onDestroy() {
super.onDestroy();
cameraView.destroy();
}
```