public class

Camera

extends Object
java.lang.Object
   ↳ android.hardware.Camera

Class Overview

The Camera class is used to set image capture settings, start/stop preview, snap pictures, and retrieve frames for encoding for video. This class is a client for the Camera service, which manages the actual camera hardware.

To access the device camera, you must declare the CAMERA permission in your Android Manifest. Also be sure to include the <uses-feature> manifest element to declare camera features used by your application. For example, if you use the camera and auto-focus feature, your Manifest should include the following:

 <uses-permission android:name="android.permission.CAMERA" />
 <uses-feature android:name="android.hardware.camera" />
 <uses-feature android:name="android.hardware.camera.autofocus" />

To take pictures with this class, use the following steps:

  1. Obtain an instance of Camera from open(int).
  2. Get existing (default) settings with getParameters().
  3. If necessary, modify the returned Camera.Parameters object and call setParameters(Camera.Parameters).
  4. If desired, call setDisplayOrientation(int).
  5. Important: Pass a fully initialized SurfaceHolder to setPreviewDisplay(SurfaceHolder). Without a surface, the camera will be unable to start the preview.
  6. Important: Call startPreview() to start updating the preview surface. Preview must be started before you can take a picture.
  7. When you want, call takePicture(Camera.ShutterCallback, Camera.PictureCallback, Camera.PictureCallback, Camera.PictureCallback) to capture a photo. Wait for the callbacks to provide the actual image data.
  8. After taking a picture, preview display will have stopped. To take more photos, call startPreview() again first.
  9. Call stopPreview() to stop updating the preview surface.
  10. Important: Call release() to release the camera for use by other applications. Applications should release the camera immediately in onPause() (and re-open() it in onResume()).

To quickly switch to video recording mode, use these steps:

  1. Obtain and initialize a Camera and start preview as described above.
  2. Call unlock() to allow the media process to access the camera.
  3. Pass the camera to setCamera(Camera). See MediaRecorder information about video recording.
  4. When finished recording, call reconnect() to re-acquire and re-lock the camera.
  5. If desired, restart preview and take more photos or videos.
  6. Call stopPreview() and release() as described above.

This class is not thread-safe, and is meant for use from one event thread. Most long-running operations (preview, focus, photo capture, etc) happen asynchronously and invoke callbacks as necessary. Callbacks will be invoked on the event thread open(int) was called from. This class's methods must never be called from multiple threads at once.

Caution: Different Android-powered devices may have different hardware specifications, such as megapixel ratings and auto-focus capabilities. In order for your application to be compatible with more devices, you should not make assumptions about the device camera specifications.

Summary

Nested Classes
interface Camera.AutoFocusCallback Callback interface used to notify on completion of camera auto focus. 
class Camera.CameraInfo Information about a camera  
interface Camera.ErrorCallback Callback interface for camera error notification. 
interface Camera.OnZoomChangeListener Callback interface for zoom changes during a smooth zoom operation. 
class Camera.Parameters Camera service settings. 
interface Camera.PictureCallback Callback interface used to supply image data from a photo capture. 
interface Camera.PreviewCallback Callback interface used to deliver copies of preview frames as they are displayed. 
interface Camera.ShutterCallback Callback interface used to signal the moment of actual image capture. 
class Camera.Size Image size (width and height dimensions). 
Constants
int CAMERA_ERROR_SERVER_DIED Media server died.
int CAMERA_ERROR_UNKNOWN Unspecified camera error.
Public Methods
final void addCallbackBuffer(byte[] callbackBuffer)
Adds a pre-allocated buffer to the preview callback buffer queue.
final void autoFocus(Camera.AutoFocusCallback cb)
Starts camera auto-focus and registers a callback function to run when the camera is focused.
final void cancelAutoFocus()
Cancels any auto-focus function in progress.
static void getCameraInfo(int cameraId, Camera.CameraInfo cameraInfo)
Returns the information about a particular camera.
static int getNumberOfCameras()
Returns the number of physical cameras available on this device.
Camera.Parameters getParameters()
Returns the current settings for this Camera service.
final void lock()
Re-locks the camera to prevent other processes from accessing it.
static Camera open(int cameraId)
Creates a new Camera object to access a particular hardware camera.
static Camera open()
Creates a new Camera object to access the first back-facing camera on the device.
final void reconnect()
Reconnects to the camera service after another process used it.
final void release()
Disconnects and releases the Camera object resources.
final void setDisplayOrientation(int degrees)
Set the clockwise rotation of preview display in degrees.
final void setErrorCallback(Camera.ErrorCallback cb)
Registers a callback to be invoked when an error occurs.
final void setOneShotPreviewCallback(Camera.PreviewCallback cb)
Installs a callback to be invoked for the next preview frame in addition to displaying it on the screen.
void setParameters(Camera.Parameters params)
Changes the settings for this Camera service.
final void setPreviewCallback(Camera.PreviewCallback cb)
Installs a callback to be invoked for every preview frame in addition to displaying them on the screen.
final void setPreviewCallbackWithBuffer(Camera.PreviewCallback cb)
Installs a callback to be invoked for every preview frame, using buffers supplied with addCallbackBuffer(byte[]), in addition to displaying them on the screen.
final void setPreviewDisplay(SurfaceHolder holder)
Sets the Surface to be used for live preview.
final void setZoomChangeListener(Camera.OnZoomChangeListener listener)
Registers a listener to be notified when the zoom value is updated by the camera driver during smooth zoom.
final void startPreview()
Starts capturing and drawing preview frames to the screen.
final void startSmoothZoom(int value)
Zooms to the requested value smoothly.
final void stopPreview()
Stops capturing and drawing preview frames to the surface, and resets the camera for a future call to startPreview().
final void stopSmoothZoom()
Stops the smooth zoom.
final void takePicture(Camera.ShutterCallback shutter, Camera.PictureCallback raw, Camera.PictureCallback jpeg)
Equivalent to takePicture(shutter, raw, null, jpeg).
final void takePicture(Camera.ShutterCallback shutter, Camera.PictureCallback raw, Camera.PictureCallback postview, Camera.PictureCallback jpeg)
Triggers an asynchronous image capture.
final void unlock()
Unlocks the camera to allow another process to access it.
Protected Methods
void finalize()
Called before the object's memory is reclaimed by the VM.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int CAMERA_ERROR_SERVER_DIED

Since: API Level 1

Media server died. In this case, the application must release the Camera object and instantiate a new one.

Constant Value: 100 (0x00000064)

public static final int CAMERA_ERROR_UNKNOWN

Since: API Level 1

Unspecified camera error.

Constant Value: 1 (0x00000001)

Public Methods

public final void addCallbackBuffer (byte[] callbackBuffer)

Since: API Level 8

Adds a pre-allocated buffer to the preview callback buffer queue. Applications can add one or more buffers to the queue. When a preview frame arrives and there is still at least one available buffer, the buffer will be used and removed from the queue. Then preview callback is invoked with the buffer. If a frame arrives and there is no buffer left, the frame is discarded. Applications should add buffers back when they finish processing the data in them.

The size of the buffer is determined by multiplying the preview image width, height, and bytes per pixel. The width and height can be read from getPreviewSize(). Bytes per pixel can be computed from getBitsPerPixel(int) / 8, using the image format from getPreviewFormat().

This method is only necessary when setPreviewCallbackWithBuffer(PreviewCallback) is used. When setPreviewCallback(PreviewCallback) or setOneShotPreviewCallback(PreviewCallback) are used, buffers are automatically allocated.

Parameters
callbackBuffer the buffer to add to the queue. The size should be width * height * bits_per_pixel / 8.

public final void autoFocus (Camera.AutoFocusCallback cb)

Since: API Level 1

Starts camera auto-focus and registers a callback function to run when the camera is focused. This method is only valid when preview is active (between startPreview() and before stopPreview()).

Callers should check getFocusMode() to determine if this method should be called. If the camera does not support auto-focus, it is a no-op and onAutoFocus(boolean, Camera) callback will be called immediately.

If your application should not be installed on devices without auto-focus, you must declare that your application uses auto-focus with the <uses-feature> manifest element.

If the current flash mode is not FLASH_MODE_OFF, flash may be fired during auto-focus, depending on the driver and camera hardware.

Parameters
cb the callback to run

public final void cancelAutoFocus ()

Since: API Level 5

Cancels any auto-focus function in progress. Whether or not auto-focus is currently in progress, this function will return the focus position to the default. If the camera does not support auto-focus, this is a no-op.

public static void getCameraInfo (int cameraId, Camera.CameraInfo cameraInfo)

Since: API Level 9

Returns the information about a particular camera. If getNumberOfCameras() returns N, the valid id is 0 to N-1.

public static int getNumberOfCameras ()

Since: API Level 9

Returns the number of physical cameras available on this device.

public Camera.Parameters getParameters ()

Since: API Level 1

Returns the current settings for this Camera service. If modifications are made to the returned Parameters, they must be passed to setParameters(Camera.Parameters) to take effect.

public final void lock ()

Since: API Level 5

Re-locks the camera to prevent other processes from accessing it. Camera objects are locked by default unless unlock() is called. Normally reconnect() is used instead.

If you are not recording video, you probably do not need this method.

Throws
RuntimeException if the camera cannot be re-locked (for example, if the camera is still in use by another process).

public static Camera open (int cameraId)

Since: API Level 9

Creates a new Camera object to access a particular hardware camera.

You must call release() when you are done using the camera, otherwise it will remain locked and be unavailable to other applications.

Your application should only have one Camera object active at a time for a particular hardware camera.

Callbacks from other methods are delivered to the event loop of the thread which called open(). If this thread has no event loop, then callbacks are delivered to the main application event loop. If there is no main application event loop, callbacks are not delivered.

Caution: On some devices, this method may take a long time to complete. It is best to call this method from a worker thread (possibly using AsyncTask) to avoid blocking the main application UI thread.

Parameters
cameraId the hardware camera to access, between 0 and getNumberOfCameras()-1.
Returns
  • a new Camera object, connected, locked and ready for use.
Throws
RuntimeException if connection to the camera service fails (for example, if the camera is in use by another process).

public static Camera open ()

Since: API Level 1

Creates a new Camera object to access the first back-facing camera on the device. If the device does not have a back-facing camera, this returns null.

See Also

public final void reconnect ()

Since: API Level 8

Reconnects to the camera service after another process used it. After unlock() is called, another process may use the camera; when the process is done, you must reconnect to the camera, which will re-acquire the lock and allow you to continue using the camera.

This must be done after MediaRecorder is done recording if setCamera(Camera) was used.

If you are not recording video, you probably do not need this method.

Throws
IOException if a connection cannot be re-established (for example, if the camera is still in use by another process).

public final void release ()

Since: API Level 1

Disconnects and releases the Camera object resources.

You must call this as soon as you're done with the Camera object.

public final void setDisplayOrientation (int degrees)

Since: API Level 8

Set the clockwise rotation of preview display in degrees. This affects the preview frames and the picture displayed after snapshot. This method is useful for portrait mode applications. Note that preview display of front-facing cameras is flipped horizontally before the rotation, that is, the image is reflected along the central vertical axis of the camera sensor. So the users can see themselves as looking into a mirror.

This does not affect the order of byte array passed in onPreviewFrame(byte[], Camera), JPEG pictures, or recorded videos. This method is not allowed to be called during preview.

If you want to make the camera image show in the same orientation as the display, you can use the following code.

 public static void setCameraDisplayOrientation(Activity activity,
         int cameraId, android.hardware.Camera camera) {
     android.hardware.Camera.CameraInfo info =
             new android.hardware.Camera.CameraInfo();
     android.hardware.Camera.getCameraInfo(cameraId, info);
     int rotation = activity.getWindowManager().getDefaultDisplay()
             .getRotation();
     int degrees = 0;
     switch (rotation) {
         case Surface.ROTATION_0: degrees = 0; break;
         case Surface.ROTATION_90: degrees = 90; break;
         case Surface.ROTATION_180: degrees = 180; break;
         case Surface.ROTATION_270: degrees = 270; break;
     }

     int result;
     if (info.facing == Camera.CameraInfo.CAMERA_FACING_FRONT) {
         result = (info.orientation + degrees) % 360;
         result = (360 - result) % 360;  // compensate the mirror
     } else {  // back-facing
         result = (info.orientation - degrees + 360) % 360;
     }
     camera.setDisplayOrientation(result);
 }
 

Parameters
degrees the angle that the picture will be rotated clockwise. Valid values are 0, 90, 180, and 270. The starting position is 0 (landscape).

public final void setErrorCallback (Camera.ErrorCallback cb)

Since: API Level 1

Registers a callback to be invoked when an error occurs.

Parameters
cb The callback to run

public final void setOneShotPreviewCallback (Camera.PreviewCallback cb)

Since: API Level 3

Installs a callback to be invoked for the next preview frame in addition to displaying it on the screen. After one invocation, the callback is cleared. This method can be called any time, even when preview is live. Any other preview callbacks are overridden.

Parameters
cb a callback object that receives a copy of the next preview frame, or null to stop receiving callbacks.

public void setParameters (Camera.Parameters params)

Since: API Level 1

Changes the settings for this Camera service.

Parameters
params the Parameters to use for this Camera service
Throws
RuntimeException if any parameter is invalid or not supported.
See Also

public final void setPreviewCallback (Camera.PreviewCallback cb)

Since: API Level 1

Installs a callback to be invoked for every preview frame in addition to displaying them on the screen. The callback will be repeatedly called for as long as preview is active. This method can be called at any time, even while preview is live. Any other preview callbacks are overridden.

Parameters
cb a callback object that receives a copy of each preview frame, or null to stop receiving callbacks.

public final void setPreviewCallbackWithBuffer (Camera.PreviewCallback cb)

Since: API Level 8

Installs a callback to be invoked for every preview frame, using buffers supplied with addCallbackBuffer(byte[]), in addition to displaying them on the screen. The callback will be repeatedly called for as long as preview is active and buffers are available. Any other preview callbacks are overridden.

The purpose of this method is to improve preview efficiency and frame rate by allowing preview frame memory reuse. You must call addCallbackBuffer(byte[]) at some point -- before or after calling this method -- or no callbacks will received. The buffer queue will be cleared if this method is called with a null callback, setPreviewCallback(Camera.PreviewCallback) is called, or setOneShotPreviewCallback(Camera.PreviewCallback) is called.

Parameters
cb a callback object that receives a copy of the preview frame, or null to stop receiving callbacks and clear the buffer queue.

public final void setPreviewDisplay (SurfaceHolder holder)

Since: API Level 1

Sets the Surface to be used for live preview. A surface is necessary for preview, and preview is necessary to take pictures. The same surface can be re-set without harm.

The SurfaceHolder must already contain a surface when this method is called. If you are using SurfaceView, you will need to register a SurfaceHolder.Callback with addCallback(SurfaceHolder.Callback) and wait for surfaceCreated(SurfaceHolder) before calling setPreviewDisplay() or starting preview.

This method must be called before startPreview(). The one exception is that if the preview surface is not set (or set to null) before startPreview() is called, then this method may be called once with a non-null parameter to set the preview surface. (This allows camera setup and surface creation to happen in parallel, saving time.) The preview surface may not otherwise change while preview is running.

Parameters
holder containing the Surface on which to place the preview, or null to remove the preview surface
Throws
IOException if the method fails (for example, if the surface is unavailable or unsuitable).

public final void setZoomChangeListener (Camera.OnZoomChangeListener listener)

Since: API Level 8

Registers a listener to be notified when the zoom value is updated by the camera driver during smooth zoom.

Parameters
listener the listener to notify

public final void startPreview ()

Since: API Level 1

Starts capturing and drawing preview frames to the screen. Preview will not actually start until a surface is supplied with setPreviewDisplay(SurfaceHolder).

If setPreviewCallback(Camera.PreviewCallback), setOneShotPreviewCallback(Camera.PreviewCallback), or setPreviewCallbackWithBuffer(Camera.PreviewCallback) were called, onPreviewFrame(byte[], Camera) will be called when preview data becomes available.

public final void startSmoothZoom (int value)

Since: API Level 8

Zooms to the requested value smoothly. The driver will notify Camera.OnZoomChangeListener of the zoom value and whether zoom is stopped at the time. For example, suppose the current zoom is 0 and startSmoothZoom is called with value 3. The onZoomChange(int, boolean, Camera) method will be called three times with zoom values 1, 2, and 3. Applications can call stopSmoothZoom() to stop the zoom earlier. Applications should not call startSmoothZoom again or change the zoom value before zoom stops. If the supplied zoom value equals to the current zoom value, no zoom callback will be generated. This method is supported if isSmoothZoomSupported() returns true.

Parameters
value zoom value. The valid range is 0 to getMaxZoom().
Throws
IllegalArgumentException if the zoom value is invalid.
RuntimeException if the method fails.

public final void stopPreview ()

Since: API Level 1

Stops capturing and drawing preview frames to the surface, and resets the camera for a future call to startPreview().

public final void stopSmoothZoom ()

Since: API Level 8

Stops the smooth zoom. Applications should wait for the Camera.OnZoomChangeListener to know when the zoom is actually stopped. This method is supported if isSmoothZoomSupported() is true.

Throws
RuntimeException if the method fails.

public final void takePicture (Camera.ShutterCallback shutter, Camera.PictureCallback raw, Camera.PictureCallback jpeg)

Since: API Level 1

Equivalent to takePicture(shutter, raw, null, jpeg).

public final void takePicture (Camera.ShutterCallback shutter, Camera.PictureCallback raw, Camera.PictureCallback postview, Camera.PictureCallback jpeg)

Since: API Level 5

Triggers an asynchronous image capture. The camera service will initiate a series of callbacks to the application as the image capture progresses. The shutter callback occurs after the image is captured. This can be used to trigger a sound to let the user know that image has been captured. The raw callback occurs when the raw image data is available (NOTE: the data may be null if the hardware does not have enough memory to make a copy). The postview callback occurs when a scaled, fully processed postview image is available (NOTE: not all hardware supports this). The jpeg callback occurs when the compressed image is available. If the application does not need a particular callback, a null can be passed instead of a callback method.

This method is only valid when preview is active (after startPreview()). Preview will be stopped after the image is taken; callers must call startPreview() again if they want to re-start preview or take more pictures.

After calling this method, you must not call startPreview() or take another picture until the JPEG callback has returned.

Parameters
shutter the callback for image capture moment, or null
raw the callback for raw (uncompressed) image data, or null
postview callback with postview image data, may be null
jpeg the callback for JPEG image data, or null

public final void unlock ()

Since: API Level 5

Unlocks the camera to allow another process to access it. Normally, the camera is locked to the process with an active Camera object until release() is called. To allow rapid handoff between processes, you can call this method to release the camera temporarily for another process to use; once the other process is done you can call reconnect() to reclaim the camera.

This must be done before calling setCamera(Camera).

If you are not recording video, you probably do not need this method.

Throws
RuntimeException if the camera cannot be unlocked.

Protected Methods

protected void finalize ()

Since: API Level 1

Called before the object's memory is reclaimed by the VM. This can only happen once the garbage collector has detected that the object is no longer reachable by any thread of the running application.

The method can be used to free system resources or perform other cleanup before the object is garbage collected. The default implementation of the method is empty, which is also expected by the VM, but subclasses can override finalize() as required. Uncaught exceptions which are thrown during the execution of this method cause it to terminate immediately but are otherwise ignored.

Note that the VM does guarantee that finalize() is called at most once for any object, but it doesn't guarantee when (if at all) finalize() will be called. For example, object B's finalize() can delay the execution of object A's finalize() method and therefore it can delay the reclamation of A's memory. To be safe, use a ReferenceQueue, because it provides more control over the way the VM deals with references during garbage collection.