Camera.Parameters

Flash will be fired automatically when required. The flash may be fired during preview, auto-focus, or snapshot depending on the driver.

Flash will not be fired.

Flash will always be fired during snapshot. The flash may also be fired during preview or auto-focus depending on the driver.

Flash will be fired in red-eye reduction mode.

Constant emission of light during preview, auto-focus and snapshot. This can also be used for video recording.

The array index of far focus distance for use with getFocusDistances(float[]).

The array index of near focus distance for use with getFocusDistances(float[]).

The array index of optimal focus distance for use with getFocusDistances(float[]).

Auto-focus mode. Applications should call autoFocus(AutoFocusCallback) to start the focus in this mode.

Continuous auto focus mode intended for taking pictures. The camera continuously tries to focus. The speed of focus change is more aggressive than FOCUS_MODE_CONTINUOUS_VIDEO. Auto focus starts when the parameter is set.

Applications can call autoFocus(AutoFocusCallback) in this mode. If the autofocus is in the middle of scanning, the focus callback will return when it completes. If the autofocus is not scanning, the focus callback will immediately return with a boolean that indicates whether the focus is sharp or not. The apps can then decide if they want to take a picture immediately or to change the focus mode to auto, and run a full autofocus cycle. The focus position is locked after autoFocus call. If applications want to resume the continuous focus, cancelAutoFocus must be called. Restarting the preview will not resume the continuous autofocus. To stop continuous focus, applications should change the focus mode to other modes.

Continuous auto focus mode intended for video recording. The camera continuously tries to focus. This is the best choice for video recording because the focus changes smoothly . Applications still can call takePicture(Camera.ShutterCallback, Camera.PictureCallback, Camera.PictureCallback) in this mode but the subject may not be in focus. Auto focus starts when the parameter is set.

Since API level 14, applications can call autoFocus(AutoFocusCallback) in this mode. The focus callback will immediately return with a boolean that indicates whether the focus is sharp or not. The focus position is locked after autoFocus call. If applications want to resume the continuous focus, cancelAutoFocus must be called. Restarting the preview will not resume the continuous autofocus. To stop continuous focus, applications should change the focus mode to other modes.

Extended depth of field (EDOF). Focusing is done digitally and continuously. Applications should not call autoFocus(AutoFocusCallback) in this mode.

Focus is fixed. The camera is always in this mode if the focus is not adjustable. If the camera has auto-focus, this mode can fix the focus, which is usually at hyperfocal distance. Applications should not call autoFocus(AutoFocusCallback) in this mode.

Focus is set at infinity. Applications should not call autoFocus(AutoFocusCallback) in this mode.

Macro (close-up) focus mode. Applications should call autoFocus(AutoFocusCallback) to start the focus in this mode.

The array index of maximum preview fps for use with getPreviewFpsRange(int[]) or getSupportedPreviewFpsRange().

The array index of minimum preview fps for use with getPreviewFpsRange(int[]) or getSupportedPreviewFpsRange().

Take photos of fast moving objects. Same as SCENE_MODE_SPORTS.

Scene mode is off.

Applications are looking for a barcode. Camera driver will be optimized for barcode reading.

Take pictures on the beach.

Capture the naturally warm color of scenes lit by candles.

For shooting firework displays.

Capture a scene using high dynamic range imaging techniques. The camera will return an image that has an extended dynamic range compared to a regular capture. Capturing such an image may take longer than a regular capture.

Take pictures on distant objects.

Take photos at night.

Take people pictures at night.

Take indoor low-light shot.

Take people pictures.

Take pictures on the snow.

Take photos of fast moving objects. Same as SCENE_MODE_ACTION.

Avoid blurry pictures (for example, due to hand shake).

Take sunset photos.

Take photos in a theater. Flash light is off.

Creates a single string with all the parameters set in this Parameters object.

The unflatten(String) method does the reverse.

Returns the value of a String parameter.

Gets the current antibanding setting.

Gets the state of the auto-exposure lock. Applications should check isAutoExposureLockSupported() before using this method. See setAutoExposureLock(boolean) for details about the lock.

Gets the state of the auto-white balance lock. Applications should check isAutoWhiteBalanceLockSupported() before using this method. See setAutoWhiteBalanceLock(boolean) for details about the lock.

Gets the current color effect setting.

Gets the current exposure compensation index.

Gets the exposure compensation step.

Gets the current flash mode setting.

Gets the focal length (in millimeter) of the camera.

Gets the current focus areas. Camera driver uses the areas to decide focus.

Before using this API or setFocusAreas(List), apps should call getMaxNumFocusAreas() to know the maximum number of focus areas first. If the value is 0, focus area is not supported.

Each focus area is a rectangle with specified weight. The direction is relative to the sensor orientation, that is, what the sensor sees. The direction is not affected by the rotation or mirroring of setDisplayOrientation(int). Coordinates of the rectangle range from -1000 to 1000. (-1000, -1000) is the upper left point. (1000, 1000) is the lower right point. The width and height of focus areas cannot be 0 or negative.

The weight must range from 1 to 1000. The weight should be interpreted as a per-pixel weight - all pixels in the area have the specified weight. This means a small area with the same weight as a larger area will have less influence on the focusing than the larger area. Focus areas can partially overlap and the driver will add the weights in the overlap region.

A special case of a null focus area list means the driver is free to select focus targets as it wants. For example, the driver may use more signals to select focus areas and change them dynamically. Apps can set the focus area list to null if they want the driver to completely control focusing.

Focus areas are relative to the current field of view (getZoom()). No matter what the zoom level is, (-1000,-1000) represents the top of the currently visible camera frame. The focus area cannot be set to be outside the current field of view, even when using zoom.

Focus area only has effect if the current focus mode is FOCUS_MODE_AUTO, FOCUS_MODE_MACRO, FOCUS_MODE_CONTINUOUS_VIDEO, or FOCUS_MODE_CONTINUOUS_PICTURE.

Gets the distances from the camera to where an object appears to be in focus. The object is sharpest at the optimal focus distance. The depth of field is the far focus distance minus near focus distance.

Focus distances may change after calling autoFocus(AutoFocusCallback), cancelAutoFocus(), or startPreview(). Applications can call getParameters() and this method anytime to get the latest focus distances. If the focus mode is FOCUS_MODE_CONTINUOUS_VIDEO, focus distances may change from time to time.

This method is intended to estimate the distance between the camera and the subject. After autofocus, the subject distance may be within near and far focus distance. However, the precision depends on the camera hardware, autofocus algorithm, the focus area, and the scene. The error can be large and it should be only used as a reference.

Far focus distance >= optimal focus distance >= near focus distance. If the focus distance is infinity, the value will be Float.POSITIVE_INFINITY.

Gets the current focus mode setting.

Gets the horizontal angle of view in degrees.

Returns the value of an integer parameter.

Returns the quality setting for the JPEG picture.

Returns the quality setting for the EXIF thumbnail in Jpeg picture.

Returns the dimensions for EXIF thumbnail in Jpeg picture.

Gets the maximum exposure compensation index.

Gets the maximum number of detected faces supported. This is the maximum length of the list returned from Camera.FaceDetectionListener. If the return value is 0, face detection of the specified type is not supported.

Gets the maximum number of focus areas supported. This is the maximum length of the list in setFocusAreas(List) and getFocusAreas().

Gets the maximum number of metering areas supported. This is the maximum length of the list in setMeteringAreas(List) and getMeteringAreas().

Gets the maximum zoom value allowed for snapshot. This is the maximum value that applications can set to setZoom(int). Applications should call isZoomSupported() before using this method. This value may change in different preview size. Applications should call this again after setting preview size.

Gets the current metering areas. Camera driver uses these areas to decide exposure.

Before using this API or setMeteringAreas(List), apps should call getMaxNumMeteringAreas() to know the maximum number of metering areas first. If the value is 0, metering area is not supported.

Each metering area is a rectangle with specified weight. The direction is relative to the sensor orientation, that is, what the sensor sees. The direction is not affected by the rotation or mirroring of setDisplayOrientation(int). Coordinates of the rectangle range from -1000 to 1000. (-1000, -1000) is the upper left point. (1000, 1000) is the lower right point. The width and height of metering areas cannot be 0 or negative.

The weight must range from 1 to 1000, and represents a weight for every pixel in the area. This means that a large metering area with the same weight as a smaller area will have more effect in the metering result. Metering areas can partially overlap and the driver will add the weights in the overlap region.

A special case of a null metering area list means the driver is free to meter as it chooses. For example, the driver may use more signals to select metering areas and change them dynamically. Apps can set the metering area list to null if they want the driver to completely control metering.

Metering areas are relative to the current field of view (getZoom()). No matter what the zoom level is, (-1000,-1000) represents the top of the currently visible camera frame. The metering area cannot be set to be outside the current field of view, even when using zoom.

No matter what metering areas are, the final exposure are compensated by setExposureCompensation(int).

Gets the minimum exposure compensation index.

Returns the image format for pictures.

Returns the dimension setting for pictures.

Returns the preferred or recommended preview size (width and height) in pixels for video recording. Camcorder applications should set the preview size to a value that is not larger than the preferred preview size. In other words, the product of the width and height of the preview size should not be larger than that of the preferred preview size. In addition, we recommend to choose a preview size that has the same aspect ratio as the resolution of video to be recorded.

Returns the image format for preview frames got from Camera.PreviewCallback.

Returns the current minimum and maximum preview fps. The values are one of the elements returned by getSupportedPreviewFpsRange().

Returns the setting for the rate at which preview frames are received. This is the target frame rate. The actual frame rate depends on the driver.

Returns the dimensions setting for preview pictures.

Gets the current scene mode setting.

Gets the supported antibanding values.

Gets the supported color effects.

Gets the supported flash modes.

Gets the supported focus modes.

Gets the supported jpeg thumbnail sizes.

Gets the supported picture formats.

Gets the supported picture sizes.

Gets the supported preview formats. NV21 is always supported. YV12 is always supported since API level 12.

Gets the supported preview fps (frame-per-second) ranges. Each range contains a minimum fps and maximum fps. If minimum fps equals to maximum fps, the camera outputs frames in fixed frame rate. If not, the camera outputs frames in auto frame rate. The actual frame rate fluctuates between the minimum and the maximum. The values are multiplied by 1000 and represented in integers. For example, if frame rate is 26.623 frames per second, the value is 26623.

Gets the supported preview frame rates.

Gets the supported preview sizes.

Gets the supported scene modes.

Gets the supported video frame sizes that can be used by MediaRecorder.

If the returned list is not null, the returned list will contain at least one Size and one of the sizes in the returned list must be passed to MediaRecorder.setVideoSize() for camcorder application if camera is used as the video source. In this case, the size of the preview can be different from the resolution of the recorded video during video recording.

Gets the supported white balance.

Gets the vertical angle of view in degrees.

Get the current state of video stabilization. See setVideoStabilization(boolean) for details of video stabilization.

Gets the current white balance setting.

Gets current zoom value. This also works when smooth zoom is in progress. Applications should check isZoomSupported() before using this method.

Gets the zoom ratios of all zoom values. Applications should check isZoomSupported() before using this method.

Returns true if auto-exposure locking is supported. Applications should call this before trying to lock auto-exposure. See setAutoExposureLock(boolean) for details about the lock.

Returns true if auto-white balance locking is supported. Applications should call this before trying to lock auto-white balance. See setAutoWhiteBalanceLock(boolean) for details about the lock.

Returns true if smooth zoom is supported. Applications should call this before using other smooth zoom methods.

Returns true if video snapshot is supported. That is, applications can call takePicture(Camera.ShutterCallback, Camera.PictureCallback, Camera.PictureCallback, Camera.PictureCallback) during recording. Applications do not need to call startPreview() after taking a picture. The preview will be still active. Other than that, taking a picture during recording is identical to taking a picture normally. All settings and methods related to takePicture work identically. Ex: getPictureSize(), getSupportedPictureSizes(), setJpegQuality(int), setRotation(int), and etc. The picture will have an EXIF header. FLASH_MODE_AUTO and FLASH_MODE_ON also still work, but the video will record the flash.

Applications can set shutter callback as null to avoid the shutter sound. It is also recommended to set raw picture and post view callbacks to null to avoid the interrupt of preview display.

Field-of-view of the recorded video may be different from that of the captured pictures. The maximum size of a video snapshot may be smaller than that for regular still captures. If the current picture size is set higher than can be supported by video snapshot, the picture will be captured at the maximum supported size instead.

Returns true if video stabilization is supported. See setVideoStabilization(boolean) for details of video stabilization.

Returns true if zoom is supported. Applications should call this before using other zoom methods.

Removes GPS latitude, longitude, altitude, and timestamp from the parameters.

Sets a String parameter.

Sets an integer parameter.

Sets the antibanding.

Sets the auto-exposure lock state. Applications should check isAutoExposureLockSupported() before using this method.

If set to true, the camera auto-exposure routine will immediately pause until the lock is set to false. Exposure compensation settings changes will still take effect while auto-exposure is locked.

If auto-exposure is already locked, setting this to true again has no effect (the driver will not recalculate exposure values).

Stopping preview with stopPreview(), or triggering still image capture with takePicture(Camera.ShutterCallback, Camera.PictureCallback, Camera.PictureCallback), will not change the lock.

Exposure compensation, auto-exposure lock, and auto-white balance lock can be used to capture an exposure-bracketed burst of images, for example.

Auto-exposure state, including the lock state, will not be maintained after camera release() is called. Locking auto-exposure after open() but before the first call to startPreview() will not allow the auto-exposure routine to run at all, and may result in severely over- or under-exposed images.

Sets the auto-white balance lock state. Applications should check isAutoWhiteBalanceLockSupported() before using this method.

If set to true, the camera auto-white balance routine will immediately pause until the lock is set to false.

If auto-white balance is already locked, setting this to true again has no effect (the driver will not recalculate white balance values).

Stopping preview with stopPreview(), or triggering still image capture with takePicture(Camera.ShutterCallback, Camera.PictureCallback, Camera.PictureCallback), will not change the the lock.

Changing the white balance mode with setWhiteBalance(String) will release the auto-white balance lock if it is set.

Exposure compensation, AE lock, and AWB lock can be used to capture an exposure-bracketed burst of images, for example. Auto-white balance state, including the lock state, will not be maintained after camera release() is called. Locking auto-white balance after open() but before the first call to startPreview() will not allow the auto-white balance routine to run at all, and may result in severely incorrect color in captured images.

Sets the current color effect setting.

Sets the exposure compensation index.

Sets the flash mode.

Sets focus areas. See getFocusAreas() for documentation.

Sets the focus mode.

Sets GPS altitude. This will be stored in JPEG EXIF header.

Sets GPS latitude coordinate. This will be stored in JPEG EXIF header.

Sets GPS longitude coordinate. This will be stored in JPEG EXIF header.

Sets GPS processing method. It will store up to 32 characters in JPEG EXIF header.

Sets GPS timestamp. This will be stored in JPEG EXIF header.

Sets Jpeg quality of captured picture.

Sets the quality of the EXIF thumbnail in Jpeg picture.

Sets the dimensions for EXIF thumbnail in Jpeg picture. If applications set both width and height to 0, EXIF will not contain thumbnail.

Applications need to consider the display orientation. See setPreviewSize(int, int) for reference.

Sets metering areas. See getMeteringAreas() for documentation.

Sets the image format for pictures.

Sets the dimensions for pictures.

Applications need to consider the display orientation. See setPreviewSize(int, int) for reference.

Sets the image format for preview pictures.

If this is never called, the default format will be NV21, which uses the NV21 encoding format.

Use getSupportedPreviewFormats() to get a list of the available preview formats.

It is strongly recommended that either NV21 or YV12 is used, since they are supported by all camera devices.

For YV12, the image buffer that is received is not necessarily tightly packed, as there may be padding at the end of each row of pixel data, as described in YV12. For camera callback data, it can be assumed that the stride of the Y and UV data is the smallest possible that meets the alignment requirements. That is, if the preview size is width x height, then the following equations describe the buffer index for the beginning of row y for the Y plane and row c for the U and V planes:

 yStride   = (int) ceil(width / 16.0) * 16;
 uvStride  = (int) ceil( (yStride / 2) / 16.0) * 16;
 ySize     = yStride * height;
 uvSize    = uvStride * height / 2;
 yRowIndex = yStride * y;
 uRowIndex = ySize + uvSize + uvStride * c;
 vRowIndex = ySize + uvStride * c;
 size      = ySize + uvSize * 2;

Sets the minimum and maximum preview fps. This controls the rate of preview frames received in Camera.PreviewCallback. The minimum and maximum preview fps must be one of the elements from getSupportedPreviewFpsRange().

Sets the rate at which preview frames are received. This is the target frame rate. The actual frame rate depends on the driver.

Sets the dimensions for preview pictures. If the preview has already started, applications should stop the preview first before changing preview size. The sides of width and height are based on camera orientation. That is, the preview size is the size before it is rotated by display orientation. So applications need to consider the display orientation while setting preview size. For example, suppose the camera supports both 480x320 and 320x480 preview sizes. The application wants a 3:2 preview ratio. If the display orientation is set to 0 or 180, preview size should be set to 480x320. If the display orientation is set to 90 or 270, preview size should be set to 320x480. The display orientation should also be considered while setting picture size and thumbnail size.

Sets recording mode hint. This tells the camera that the intent of the application is to record videos start(), not to take still pictures takePicture(Camera.ShutterCallback, Camera.PictureCallback, Camera.PictureCallback, Camera.PictureCallback). Using this hint can allow MediaRecorder.start() to start faster or with fewer glitches on output. This should be called before starting preview for the best result, but can be changed while the preview is active. The default value is false. The app can still call takePicture() when the hint is true or call MediaRecorder.start() when the hint is false. But the performance may be worse.

Sets the clockwise rotation angle in degrees relative to the orientation of the camera. This affects the pictures returned from JPEG Camera.PictureCallback. The camera driver may set orientation in the EXIF header without rotating the picture. Or the driver may rotate the picture and the EXIF thumbnail. If the Jpeg picture is rotated, the orientation in the EXIF header will be missing or 1 (row #0 is top and column #0 is left side).

If applications want to rotate the picture to match the orientation of what users see, apps should use OrientationEventListener and Camera.CameraInfo. The value from OrientationEventListener is relative to the natural orientation of the device. CameraInfo.orientation is the angle between camera orientation and natural device orientation. The sum of the two is the rotation angle for back-facing camera. The difference of the two is the rotation angle for front-facing camera. Note that the JPEG pictures of front-facing cameras are not mirrored as in preview display.

For example, suppose the natural orientation of the device is portrait. The device is rotated 270 degrees clockwise, so the device orientation is 270. Suppose a back-facing camera sensor is mounted in landscape and the top side of the camera sensor is aligned with the right edge of the display in natural orientation. So the camera orientation is 90. The rotation should be set to 0 (270 + 90).

The reference code is as follows.

 public void onOrientationChanged(int orientation) {
     if (orientation == ORIENTATION_UNKNOWN) return;
     android.hardware.Camera.CameraInfo info =
            new android.hardware.Camera.CameraInfo();
     android.hardware.Camera.getCameraInfo(cameraId, info);
     orientation = (orientation + 45) / 90 * 90;
     int rotation = 0;
     if (info.facing == CameraInfo.CAMERA_FACING_FRONT) {
         rotation = (info.orientation - orientation + 360) % 360;
     } else {  // back-facing camera
         rotation = (info.orientation + orientation) % 360;
     }
     mParameters.setRotation(rotation);
 }
 

Sets the scene mode. Changing scene mode may override other parameters (such as flash mode, focus mode, white balance). For example, suppose originally flash mode is on and supported flash modes are on/off. In night scene mode, both flash mode and supported flash mode may be changed to off. After setting scene mode, applications should call getParameters to know if some parameters are changed.

Enables and disables video stabilization. Use isVideoStabilizationSupported() to determine if calling this method is valid.

Video stabilization reduces the shaking due to the motion of the camera in both the preview stream and in recorded videos, including data received from the preview callback. It does not reduce motion blur in images captured with takePicture.

Video stabilization can be enabled and disabled while preview or recording is active, but toggling it may cause a jump in the video stream that may be undesirable in a recorded video.

Sets the white balance. Changing the setting will release the auto-white balance lock. It is recommended not to change white balance and AWB lock at the same time.

Sets current zoom value. If the camera is zoomed (value > 0), the actual picture size may be smaller than picture size setting. Applications can check the actual picture size after picture is returned from Camera.PictureCallback. The preview size remains the same in zoom. Applications should check isZoomSupported() before using this method.

Takes a flattened string of parameters and adds each one to this Parameters object.

The flatten() method does the reverse.